Specifies how a Pattern distributes elements to units in a specific dimension. More...

#include <Distribution.h>

Public Member Functions
	Distribution ()=default
	Constructor, initializes Distribution with distribution type NONE. More...

	Distribution (dash::internal::DistributionType distType, int blockSize)
	Constructor, initializes Distribution with a distribution type and a block size. More...

	Distribution (const self_t &other)=default

self_t &	operator= (const self_t &other)=default

template<typename IndexType , typename SizeType >
IndexType	local_index_to_block_coord (IndexType unit_teamspec_coord, IndexType local_index, SizeType num_units_in_dim) const
	Resolve the block coordinate for a given local index in the distribution's dimension. More...

template<typename IndexType , typename SizeType >
IndexType	max_blocksize_in_range (IndexType range, SizeType num_units) const
	The maximum size of a single block within an extent for a given total number of units. More...

bool	operator== (const Distribution &other) const
	Equality comparison operator. More...

bool	operator!= (const Distribution &other) const
	Inequality comparison operator. More...

Public Attributes
dash::internal::DistributionType	type {dash::internal::DIST_NONE}

dash::default_size_t	blocksz {0}

Friends
std::ostream &	operator<< (std::ostream &os, const self_t &distribution)

Related Functions
(Note that these are not member functions.)
const Distribution	BLOCKED
	Distribution specifying that elements in a Pattern's dimension shall be distributed to units in even-sized blocks. More...

const Distribution	CYCLIC
	Distribution specifying that elements in a Pattern's dimension shall be distributed by cycling among units. More...

const Distribution	NONE
	Distribution specifying that elements in a Pattern's dimension shall not be distributed. More...

Distribution	TILE (int blockSize)
	Distribution specifying that elements in a Pattern's dimension shall be distributed to units in a tiled blocks of the given size. More...

Distribution	BLOCKCYCLIC (int blockSize)
	Distribution specifying that elements in a Pattern's dimension shall be distributed to units in blocks of the given size. More...

Detailed Description

Specifies how a Pattern distributes elements to units in a specific dimension.

Predefined configurations are

dash::BLOCKED
dash::BLOCKCYCLIC
dash::CYCLIC
dash::TILE
dash::NONE

See also: Pattern

Definition at line 24 of file Distribution.h.

Constructor & Destructor Documentation

◆ Distribution() [1/2]

dash::Distribution::Distribution ( )

default

Constructor, initializes Distribution with distribution type NONE.

Referenced by Distribution().

◆ Distribution() [2/2]

dash::Distribution::Distribution	(	dash::internal::DistributionType	distType,
		int	blockSize
	)

inline

Constructor, initializes Distribution with a distribution type and a block size.

Definition at line 47 of file Distribution.h.

References Distribution().

   : type(distType),
     blocksz(blockSize) {
   }

Member Function Documentation

◆ local_index_to_block_coord()

template<typename IndexType , typename SizeType >

IndexType dash::Distribution::local_index_to_block_coord	(	IndexType	unit_teamspec_coord,
		IndexType	local_index,
		SizeType	num_units_in_dim
	)		const

inline

Resolve the block coordinate for a given local index in the distribution's dimension.

Definition at line 63 of file Distribution.h.

                                      {
     // NOTE: blocksize should be this->blocksz
     SizeType local_block_offset = 0;
     switch (type) {
       case dash::internal::DIST_NONE:
         // There is only one block in this dimension, so
         // block coordinate is 0:
         return 0;
       case dash::internal::DIST_BLOCKED:
         // Same as blockcyclic, but local block offset is
         // always 0:
         return unit_teamspec_coord;
       case dash::internal::DIST_TILE:
         // Same as blockcyclic
       case dash::internal::DIST_BLOCKCYCLIC:
         // Number of blocks local to the unit that are
         // in front of the given local index:
         local_block_offset = local_index / blocksz;
         // Number of blocks of any unit that are in front
         // of the given local index. Unit's coordinate in team
         // spec is equivalent to the number of units in front of
         // the unit.
         return (local_block_offset * num_units_in_dim) +
                   unit_teamspec_coord;
       case dash::internal::DIST_CYCLIC:
         // Like blockcyclic, but with blocksize 1:
         DASH_LOG_TRACE("Distribution.local_index_to_block_coord",
                        "unit_teamspec_coord", unit_teamspec_coord,
                        "local_index", local_index,
                        "num_units_in_dim", num_units_in_dim);
         return unit_teamspec_coord + local_index * num_units_in_dim;
       default:
         DASH_THROW(
           dash::exception::InvalidArgument,
           "Distribution type undefined in " <<
           "local_index_to_block_coord");
     }
   }

◆ max_blocksize_in_range()

template<typename IndexType , typename SizeType >

IndexType dash::Distribution::max_blocksize_in_range	(	IndexType	range,
		SizeType	num_units
	)		const

inline

The maximum size of a single block within an extent for a given total number of units.

Parameters

range	Number of elements to distribute
num_units	Number of units to which elements are distributed

Definition at line 114 of file Distribution.h.

Referenced by dash::ShiftTilePattern< NumDimensions, Arrangement, IndexType >::ndim(), dash::SeqTilePattern< NumDimensions, Arrangement, IndexType >::ndim(), dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::underfilled_blocksize(), and dash::TilePattern< NumDimensions, Arrangement, IndexType >::underfilled_blocksize().

   {
     DASH_LOG_TRACE("Distribution.max_blocksize_in_range()",
                    "range:", range, "nunits:", num_units);
     switch (type) {
       case dash::internal::DIST_NONE:
         return range;
       case dash::internal::DIST_BLOCKED:
         return num_units == 0 ? 0 : dash::math::div_ceil(range, num_units);
       case dash::internal::DIST_CYCLIC:
         return 1;
       case dash::internal::DIST_BLOCKCYCLIC:
       case dash::internal::DIST_TILE:
         DASH_LOG_TRACE("Distribution.max_blocksize_in_range",
                        "TILE", "blocksz:", blocksz);
         // Shrink block size in dimension if it exceeds the number
         // of elements in dimension:
         return std::min<SizeType>(range, blocksz);
       default:
         DASH_THROW(
           dash::exception::InvalidArgument,
           "Distribution type undefined in max_blocksize_in_range");
     }
   }

◆ operator!=()

bool dash::Distribution::operator!= ( const Distribution & other ) const

inline

Inequality comparison operator.

Definition at line 153 of file Distribution.h.

                                                     {
     return !(*this == other);
   }

◆ operator==()

bool dash::Distribution::operator== ( const Distribution & other ) const

inline

Equality comparison operator.

Definition at line 146 of file Distribution.h.

                                                     {
     return (this->type == other.type &&
             this->blocksz == other.blocksz);
   }

Friends And Related Function Documentation

◆ BLOCKCYCLIC()

Distribution BLOCKCYCLIC ( int blockSize )

◆ BLOCKED

const Distribution BLOCKED

Definition at line 165 of file Distribution.h.

◆ CYCLIC

const Distribution CYCLIC

Semantically equivalent to BLOCKCYCLIC(1) but with slight performance improvement.

Definition at line 174 of file Distribution.h.

◆ NONE

const Distribution NONE

Definition at line 181 of file Distribution.h.

◆ TILE()

Distribution TILE ( int blockSize )

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

/tmp/tmporruphar/dash/include/dash/Distribution.h

Public Member Functions

Public Attributes

Friends

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Distribution() [1/2]

◆ Distribution() [2/2]

Member Function Documentation

◆ local_index_to_block_coord()

◆ max_blocksize_in_range()

◆ operator!=()

◆ operator==()

Friends And Related Function Documentation

◆ BLOCKCYCLIC()

◆ BLOCKED

◆ CYCLIC

◆ NONE

◆ TILE()