STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::cycle_map< GID, Index, ContainerGID, CID > Struct Template Reference

Computes a cyclic mapping of ids to partitions. More...

Public Member Functions

 cycle_map (Index num_blocks)
 
Index operator() (GID id) const
 
void update (std::vector< std::tuple< std::pair< GID, GID >, CID, location_type >> const &updates, size_t level)
 Method required of all mapping functions. The method is called by the update_distribution method of containers. More...
 

Public Types

typedef GID gid_type
 Type of the id being mapped into partitions. Required by Core.
 
typedef Index index_type
 Type of the partition id. Required by Core.
 

Detailed Description

template<typename GID, typename Index = GID, typename ContainerGID = GID, typename CID = unsigned long int>
struct stapl::cycle_map< GID, Index, ContainerGID, CID >

Computes a cyclic mapping of ids to partitions.

The struct is used to implement view-based specifications of block-cyclic distributions. The implementation assumes the GID % Index operation is defined.

Member Function Documentation

◆ update()

template<typename GID , typename Index = GID, typename ContainerGID = GID, typename CID = unsigned long int>
void stapl::cycle_map< GID, Index, ContainerGID, CID >::update ( std::vector< std::tuple< std::pair< GID, GID >, CID, location_type >> const &  updates,
size_t  level 
)

Method required of all mapping functions. The method is called by the update_distribution method of containers.

Warning
Currently mapping functions used in view-based specifications other than arbitrary do not support updates.

The documentation for this struct was generated from the following file: