dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType > Class Template Reference

Irregular dynamic pattern. More...

#include <LoadBalancePattern.h>

Classes
struct	local_coords_t
struct	local_index_t

Public Types
typedef pattern_partitioning_properties< pattern_partitioning_tag::minimal, pattern_partitioning_tag::rectangular, pattern_partitioning_tag::balanced, pattern_partitioning_tag::unbalanced, pattern_partitioning_tag::dynamic >	partitioning_properties
	Satisfiable properties in pattern property category Partitioning: More...
typedef pattern_mapping_properties< pattern_mapping_tag::unbalanced >	mapping_properties
	Satisfiable properties in pattern property category Mapping: More...
typedef pattern_layout_properties< pattern_layout_tag::blocked, pattern_layout_tag::linear >	layout_properties
	Satisfiable properties in pattern property category Layout: More...
typedef IndexType	index_type
typedef SizeType	size_type
typedef ViewSpec_t	viewspec_type

Public Member Functions
	LoadBalancePattern (const SizeSpec_t &sizespec, TeamLocality_t &team_loc)
	Constructor. More...
	LoadBalancePattern (const SizeSpec_t &sizespec, dash::Team &team=dash::Team::All())
	Constructor. More...
	LoadBalancePattern (const self_t &other)=default
	LoadBalancePattern (self_t &&other)=default
self_t &	operator= (const self_t &other)=default
self_t &	operator= (self_t &&other)=default
	LoadBalancePattern (self_t &other)
	Copy constructor using non-const lvalue reference parameter. More...
bool	operator== (const self_t &other) const
	Equality comparison operator. More...
bool	operator!= (const self_t &other) const
	Inquality comparison operator. More...
IndexType	lbegin () const
	Resolves the global index of the first local element in the pattern. More...
IndexType	lend () const
	Resolves the global index past the last local element in the pattern. More...
team_unit_t	unit_at (const std::array< IndexType, NumDimensions > &coords, const ViewSpec_t &viewspec) const
	unit_at More...
team_unit_t	unit_at (const std::array< IndexType, NumDimensions > &g_coords) const
	Convert given coordinate in pattern to its assigned unit id. More...
team_unit_t	unit_at (IndexType global_pos, const ViewSpec_t &viewspec) const
	Convert given global linear index to its assigned unit id. More...
team_unit_t	unit_at (IndexType g_index) const
	Convert given global linear index to its assigned unit id. More...
IndexType	extent (dim_t dim) const
	extent More...
IndexType	local_extent (dim_t dim) const
	The actual number of elements in this pattern that are local to the calling unit in the given dimension. More...
std::array< SizeType, NumDimensions >	local_extents (team_unit_t unit) const
	The actual number of elements in this pattern that are local to the given unit, by dimension. More...
IndexType	local_at (const std::array< IndexType, NumDimensions > &local_coords, const ViewSpec_t &viewspec) const
	local More...
IndexType	local_at (const std::array< IndexType, NumDimensions > &local_coords) const
	Convert given local coordinates to linear local offset (index). More...
local_coords_t	local (const std::array< IndexType, NumDimensions > &g_coords) const
	Converts global coordinates to their associated unit and its respective local coordinates. More...
local_index_t	local (IndexType g_index) const
	Converts global index to its associated unit and respective local index. More...
std::array< IndexType, NumDimensions >	local_coords (const std::array< IndexType, NumDimensions > &g_coords) const
	Converts global coordinates to their associated unit's respective local coordinates. More...
local_index_t	local_index (const std::array< IndexType, NumDimensions > &g_coords) const
	Converts global coordinates to their associated unit and their respective local index. More...
std::array< IndexType, NumDimensions >	global (team_unit_t unit, const std::array< IndexType, NumDimensions > &local_coords) const
	global More...
std::array< IndexType, NumDimensions >	global (const std::array< IndexType, NumDimensions > &l_coords) const
	Converts local coordinates of active unit to global coordinates. More...
IndexType	global (team_unit_t unit, IndexType l_index) const
	Resolve an element's linear global index from the given unit's local index of that element. More...
IndexType	global (IndexType l_index) const
	Resolve an element's linear global index from the calling unit's local index of that element. More...
IndexType	global_index (team_unit_t unit, const std::array< IndexType, NumDimensions > &l_coords) const
	Resolve an element's linear global index from a given unit's local coordinates of that element. More...
IndexType	at (const std::array< IndexType, NumDimensions > &g_coords) const
	at More...
IndexType	at (const std::array< IndexType, NumDimensions > &g_coords, const ViewSpec_t &viewspec) const
	Global coordinates and viewspec to local index. More...
template<typename ... Values>
IndexType	at (IndexType value, Values ... values) const
	Global coordinates to local index. More...
bool	is_local (IndexType index, team_unit_t unit) const
	is_local More...
bool	is_local (IndexType index) const
	Whether the given global index is local to the unit that created this pattern instance. More...
const BlockSpec_t &	blockspec () const
	block More...
index_type	block_at (const std::array< index_type, NumDimensions > &g_coords) const
	Index of block at given global coordinates. More...
ViewSpec_t	block (index_type g_block_index) const
	View spec (offset and extents) of block at global linear block index in cartesian element space. More...
ViewSpec_t	local_block (index_type l_block_index) const
	View spec (offset and extents) of block at local linear block index in global cartesian element space. More...
ViewSpec_t	local_block_local (index_type l_block_index) const
	View spec (offset and extents) of block at local linear block index in local cartesian element space. More...
SizeType	blocksize (dim_t dimension) const
	Maximum number of elements in a single block in the given dimension. More...
SizeType	max_blocksize () const
	Maximum number of elements in a single block in all dimensions. More...
SizeType	local_capacity () const
	Maximum number of elements assigned to a single unit. More...
SizeType	local_size (team_unit_t unit=UNDEFINED_TEAM_UNIT_ID) const
	The actual number of elements in this pattern that are local to the calling unit in total. More...
IndexType	num_units () const
	The number of units to which this pattern's elements are mapped. More...
IndexType	capacity () const
	The maximum number of elements arranged in this pattern. More...
IndexType	size () const
	The number of elements arranged in this pattern. More...
dash::Team &	team () const
	The Team containing the units to which this pattern's elements are mapped. More...
const DistributionSpec_t &	distspec () const
	Distribution specification of this pattern. More...
SizeSpec_t	sizespec () const
	Size specification of the index space mapped by this pattern. More...
const std::array< SizeType, NumDimensions > &	extents () const
	Size specification of the index space mapped by this pattern. More...
const TeamSpec_t &	teamspec () const
	Cartesian arrangement of the Team containing the units to which this pattern's elements are mapped. More...
std::array< IndexType, NumDimensions >	coords (IndexType index) const
	Convert given global linear offset (index) to global cartesian coordinates. More...
std::array< IndexType, NumDimensions >	coords (IndexType index, const ViewSpec_t &viewspec) const
	Convert given global linear offset (index) to global cartesian coordinates using viewspec. More...
const std::vector< double > &	unit_cpu_weights () const
const std::vector< double > &	unit_membw_weights () const
const std::vector< double > &	unit_load_weights () const

Static Public Member Functions
static constexpr MemArrange	memory_order ()
	Memory order followed by the pattern. More...
static constexpr dim_t	ndim ()
	Number of dimensions of the cartesian space partitioned by the pattern. More...

Static Public Attributes
static constexpr char const *	PatternName = "LoadBalancePattern1D"

Detailed Description

template<typename CompBasedMeasure, typename MemBasedMeasure, MemArrange Arrangement, typename IndexType>
class dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >

Irregular dynamic pattern.

Specialization for 1-dimensional data.

Todo:

Should subclass or delegate to dash::CSRPattern as implementation is identical apart from comptation of _local_sizes.

Todo:

Performance measures used for load balance weights (CPU capacity, memory bandwidth, ...) should be policies, template parameters implementing well-defined concepts, so this class does not have to be re-implemented for every load-balance scheme. Using CompBasedMeasure, MemBasedMeasure for now.

Implemented concept:

Pattern Concept

Definition at line 203 of file LoadBalancePattern.h.

Member Typedef Documentation

layout_properties

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

typedef pattern_layout_properties< pattern_layout_tag::blocked, pattern_layout_tag::linear > dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::layout_properties

Satisfiable properties in pattern property category Layout:

Definition at line 241 of file LoadBalancePattern.h.

mapping_properties

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

typedef pattern_mapping_properties< pattern_mapping_tag::unbalanced > dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::mapping_properties

Satisfiable properties in pattern property category Mapping:

Definition at line 233 of file LoadBalancePattern.h.

partitioning_properties

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

typedef pattern_partitioning_properties< pattern_partitioning_tag::minimal, pattern_partitioning_tag::rectangular, pattern_partitioning_tag::balanced, pattern_partitioning_tag::unbalanced, pattern_partitioning_tag::dynamic > dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::partitioning_properties

Satisfiable properties in pattern property category Partitioning:

Definition at line 228 of file LoadBalancePattern.h.

Constructor & Destructor Documentation

LoadBalancePattern() [1/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::LoadBalancePattern ( const SizeSpec_t &  sizespec, TeamLocality_t &  team_loc  )

inline

Constructor.

Parameters

sizespec	Size spec of the pattern.
team_loc	Locality hierarchy of the team.

Definition at line 293 of file LoadBalancePattern.h.

  : _size(sizespec.size()),
    _unit_cpu_weights(
       CompBasedMeasure::unit_weights(team_loc)),
    _unit_membw_weights(
       MemBasedMeasure::unit_weights(team_loc)),
    _unit_load_weights(
       initialize_load_weights(
         _unit_cpu_weights,
         _unit_membw_weights)),
    _local_sizes(
      initialize_local_sizes(
        sizespec.size(),
        team_loc)),
    _block_offsets(
      initialize_block_offsets(
        _local_sizes)),
    _memory_layout(
      std::array<SizeType, 1> {{ _size }}),
    _blockspec(
      initialize_blockspec(
        _local_sizes)),
    _distspec(dash::BLOCKED),
    _team(&team_loc.team()),
    _myid(_team->myid()),
    _teamspec(*_team),
    _nunits(_team->size()),
    _local_size(
      initialize_local_extent(
        _team->myid(),
        _local_sizes)),
    _local_memory_layout(
      std::array<SizeType, 1> {{ _local_size }}),
    _local_capacity(
      initialize_local_capacity(
        _local_sizes))
  {
    DASH_LOG_TRACE("LoadBalancePattern()", "(sizespec, dist, team)");
    DASH_ASSERT_EQ(
      _local_sizes.size(), _nunits,
      "Number of given local sizes "   << _local_sizes.size() << " " <<
      "does not match number of units" << _nunits);
    initialize_local_range();
    DASH_LOG_TRACE("LoadBalancePattern()", "LoadBalancePattern initialized");
  }

LoadBalancePattern() [2/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::LoadBalancePattern ( const SizeSpec_t &  sizespec, dash::Team &  team = dash::Team::All()  )

inline

Constructor.

Parameters

sizespec	Size spec of the pattern.
team	Team containing units to which this pattern maps its elements.

Definition at line 346 of file LoadBalancePattern.h.

  : LoadBalancePattern(sizespec, TeamLocality_t(team))
  { }

LoadBalancePattern() [3/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::LoadBalancePattern ( self_t &  other )

inline

Copy constructor using non-const lvalue reference parameter.

Introduced so variadic constructor is not a better match for copy-construction.

Definition at line 366 of file LoadBalancePattern.h.

  : LoadBalancePattern(static_cast<const self_t &>(other))
  { }

Member Function Documentation

at() [1/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::at ( const std::array< IndexType, NumDimensions > &  g_coords ) const

inline

at

Global coordinates to local index.

Convert given global coordinates in pattern to their respective linear local index.

See also

Pattern Concept

Definition at line 745 of file LoadBalancePattern.h.

  {
    return local_coords(g_coords)[0];
  }

at() [2/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::at ( const std::array< IndexType, NumDimensions > &  g_coords, const ViewSpec_t &  viewspec  ) const

inline

Global coordinates and viewspec to local index.

Convert given global coordinate in pattern to its linear local index.

See also

Pattern Concept

Definition at line 758 of file LoadBalancePattern.h.

  {
    auto vs_coords = g_coords;
    vs_coords[0] += viewspec.offset(0);
    return local_coords(vs_coords)[0];
  }

at() [3/3]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

template<typename ... Values>

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::at ( IndexType  value, Values ...  values  ) const

inline

Global coordinates to local index.

Convert given coordinate in pattern to its linear local index.

See also

Pattern Concept

Definition at line 775 of file LoadBalancePattern.h.

  {
    static_assert(
      sizeof...(values) == NumDimensions-1,
      "Wrong parameter number");
    std::array<IndexType, NumDimensions> inputindex = {
      value, (IndexType)values...
    };
    return at(inputindex);
  }

block()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::block ( index_type  g_block_index ) const

inline

View spec (offset and extents) of block at global linear block index in cartesian element space.

Definition at line 860 of file LoadBalancePattern.h.

  {
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.block >", g_block_index);
    index_type offset = _block_offsets[g_block_index];
    auto block_size   = _local_sizes[g_block_index];
    std::array<index_type, NumDimensions> offsets = {{ offset }};
    std::array<size_type, NumDimensions>  extents = {{ block_size }};
    ViewSpec_t block_vs(offsets, extents);
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.block >", block_vs);
    return block_vs;
  }

block_at()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

index_type dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::block_at ( const std::array< index_type, NumDimensions > &  g_coords ) const

inline

Index of block at given global coordinates.

See also

Pattern Concept

Parameters

g_coords

Global coordinates of element

Definition at line 844 of file LoadBalancePattern.h.

  {
    DASH_LOG_TRACE_VAR("LoadBalancePattern.block_at()", g_coords);

    auto block_idx = static_cast<index_type>(unit_at(g_coords[0]));

    DASH_LOG_TRACE_VAR("LoadBalancePattern.block_at >", block_idx);
    return block_idx;
  }

blocksize()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

SizeType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::blocksize ( dim_t  dimension ) const

inline

Maximum number of elements in a single block in the given dimension.

Returns

The blocksize in the given dimension

See also

Pattern Concept

Parameters

dimension

The dimension in the pattern

Definition at line 917 of file LoadBalancePattern.h.

  {
    return _local_capacity;
  }

blockspec()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

const BlockSpec_t& dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::blockspec ( ) const

inline

block

Cartesian arrangement of pattern blocks.

Definition at line 834 of file LoadBalancePattern.h.

  {
    return _blockspec;
  }

capacity()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::capacity ( ) const

inline

The maximum number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 981 of file LoadBalancePattern.h.

  {
    return _size;
  }

coords() [1/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::coords ( IndexType  index ) const

inline

Convert given global linear offset (index) to global cartesian coordinates.

See also

Pattern Concept

Definition at line 1050 of file LoadBalancePattern.h.

  {
    return std::array<IndexType, 1> {{ index }};
  }

coords() [2/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::coords ( IndexType  index, const ViewSpec_t &  viewspec  ) const

inline

Convert given global linear offset (index) to global cartesian coordinates using viewspec.

See also

Pattern Concept

Definition at line 1062 of file LoadBalancePattern.h.

  {
    return std::array<IndexType, 1> {{ index + viewspec.offset(0) }};
  }

distspec()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

const DistributionSpec_t& dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::distspec ( ) const

inline

Distribution specification of this pattern.

Definition at line 1008 of file LoadBalancePattern.h.

  {
    return _distspec;
  }

extent()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::extent ( dim_t  dim ) const

inline

extent

The number of elements in this pattern in the given dimension.

See also

blocksize()

local_size()

local_extent()

Pattern Concept

Definition at line 499 of file LoadBalancePattern.h.

  {
    DASH_ASSERT_EQ(
      0, dim,
      "Wrong dimension for Pattern::local_extent. " <<
      "Expected dimension = 0, got " << dim);
    return _size;
  }

extents()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

const std::array<SizeType, NumDimensions>& dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::extents ( ) const

inline

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1028 of file LoadBalancePattern.h.

  {
    return std::array<SizeType, 1> {{ _size }};
  }

global() [1/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::global ( team_unit_t  unit, const std::array< IndexType, NumDimensions > &  local_coords  ) const

inline

global

Converts local coordinates of a given unit to global coordinates.

See also

Pattern Concept

Definition at line 661 of file LoadBalancePattern.h.

  {
    DASH_LOG_DEBUG_VAR("LoadBalancePattern.global()", unit);
    DASH_LOG_DEBUG_VAR("LoadBalancePattern.global()", local_coords);
    DASH_LOG_TRACE_VAR("LoadBalancePattern.global", _nunits);
    if (_nunits < 2) {
      return local_coords;
    }
    // Initialize global index with element phase (= local coords):
    index_type glob_index = _block_offsets[unit] + local_coords[0];
    DASH_LOG_TRACE_VAR("LoadBalancePattern.global >", glob_index);
    return std::array<IndexType, 1> {{ glob_index }};
  }

global() [2/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::global ( const std::array< IndexType, NumDimensions > &  l_coords ) const

inline

Converts local coordinates of active unit to global coordinates.

See also

Pattern Concept

Definition at line 682 of file LoadBalancePattern.h.

References dash::global().

  {
    return global(_team->myid(), l_coords);
  }

global() [3/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::global ( team_unit_t  unit, IndexType  l_index  ) const

inline

Resolve an element's linear global index from the given unit's local index of that element.

See also

at Inverse of local()

Pattern Concept

Definition at line 696 of file LoadBalancePattern.h.

  {
    return global(unit, std::array<IndexType, 1> {{ l_index }})[0];
  }

global() [4/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::global ( IndexType  l_index ) const

inline

Resolve an element's linear global index from the calling unit's local index of that element.

See also

at Inverse of local()

Pattern Concept

Definition at line 711 of file LoadBalancePattern.h.

References dash::global().

  {
    return global(_team->myid(), std::array<IndexType, 1> {{ l_index }})[0];
  }

global_index()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::global_index ( team_unit_t  unit, const std::array< IndexType, NumDimensions > &  l_coords  ) const

inline

Resolve an element's linear global index from a given unit's local coordinates of that element.

See also

at

Pattern Concept

Definition at line 725 of file LoadBalancePattern.h.

  {
    auto g_index = global(unit, l_coords[0]);
    return g_index;
  }

is_local() [1/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

bool dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::is_local ( IndexType  index, team_unit_t  unit  ) const

inline

is_local

Whether the given global index is local to the specified unit.

See also

Pattern Concept

Definition at line 795 of file LoadBalancePattern.h.

  {
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local()", index);
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local()", unit);
    bool is_loc = index >= _block_offsets[unit] &&
                  (unit == _nunits-1 ||
                   index <  _block_offsets[unit+1]);
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local >", is_loc);
    return is_loc;
  }

is_local() [2/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

bool dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::is_local ( IndexType  index ) const

inline

Whether the given global index is local to the unit that created this pattern instance.

See also

Pattern Concept

Definition at line 814 of file LoadBalancePattern.h.

  {
    auto unit = team().myid();
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local()", index);
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local", unit);
    bool is_loc = index >= _block_offsets[unit] &&
                  (unit == _nunits-1 ||
                   index <  _block_offsets[unit+1]);
    DASH_LOG_TRACE_VAR("LoadBalancePattern.is_local >", is_loc);
    return is_loc;
  }

lbegin()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::lbegin ( ) const

inline

Resolves the global index of the first local element in the pattern.

See also

Pattern Concept

Definition at line 404 of file LoadBalancePattern.h.

  {
    return _lbegin;
  }

lend()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::lend ( ) const

inline

Resolves the global index past the last local element in the pattern.

See also

Pattern Concept

Definition at line 414 of file LoadBalancePattern.h.

  {
    return _lend;
  }

local() [1/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

local_coords_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local ( const std::array< IndexType, NumDimensions > &  g_coords ) const

inline

Converts global coordinates to their associated unit and its respective local coordinates.

NOTE: Same as local_index.

See also

Pattern Concept

Definition at line 587 of file LoadBalancePattern.h.

References dash::local().

  {
    local_index_t  l_index =  local(g_coords[0]);
    local_coords_t l_coords;
    l_coords.unit      = l_index.unit;
    l_coords.coords[0] = l_index.index;
    return l_coords;
  }

local() [2/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

local_index_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local ( IndexType  g_index ) const

inline

Converts global index to its associated unit and respective local index.

NOTE: Same as local_index.

See also

Pattern Concept

Definition at line 604 of file LoadBalancePattern.h.

  {
    DASH_LOG_TRACE_VAR("LoadBalancePattern.local()", g_index);
    local_index_t l_index;

    for (team_unit_t unit_idx{0}; unit_idx < _nunits; ++unit_idx) {
      if (g_index < _local_sizes[unit_idx]) {
        l_index.unit  = unit_idx;
        l_index.index = g_index;
        DASH_LOG_TRACE("LoadBalancePattern.local >",
                       "unit:",  l_index.unit,
                       "index:", l_index.index);
        return l_index;
      }
      g_index -= _local_sizes[unit_idx];
    }
    DASH_THROW(
      dash::exception::InvalidArgument,
      "LoadBalancePattern.local: " <<
      "global index " << g_index << " is out of bounds");
  }

local_at() [1/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_at ( const std::array< IndexType, NumDimensions > &  local_coords, const ViewSpec_t &  viewspec  ) const

inline

local

Convert given local coordinates and viewspec to linear local offset (index).

See also

Pattern Concept

Parameters

local_coords	Point in local memory
viewspec	View specification (offsets) to apply on coords

Definition at line 558 of file LoadBalancePattern.h.

  {
    return local_coords[0] + viewspec.offset(0);
  }

local_at() [2/2]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_at ( const std::array< IndexType, NumDimensions > &  local_coords ) const

inline

Convert given local coordinates to linear local offset (index).

See also

Pattern Concept

Parameters

local_coords

Point in local memory

Definition at line 572 of file LoadBalancePattern.h.

  {
    return local_coords[0];
  }

local_block()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_block ( index_type  l_block_index ) const

inline

View spec (offset and extents) of block at local linear block index in global cartesian element space.

Definition at line 877 of file LoadBalancePattern.h.

  {
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.local_block()", l_block_index);
    DASH_ASSERT_EQ(
      0, l_block_index,
      "LoadBalancePattern always assigns exactly 1 block to a single unit");
    index_type block_offset = _block_offsets[_team->myid()];
    size_type  block_size   = _local_sizes[_team->myid()];
    std::array<index_type, NumDimensions> offsets = {{ block_offset }};
    std::array<size_type, NumDimensions>  extents = {{ block_size }};
    ViewSpec_t block_vs(offsets, extents);
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.local_block >", block_vs);
    return block_vs;
  }

local_block_local()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_block_local ( index_type  l_block_index ) const

inline

View spec (offset and extents) of block at local linear block index in local cartesian element space.

Definition at line 897 of file LoadBalancePattern.h.

  {
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.local_block_local >",
                       l_block_index);
    size_type block_size = _local_sizes[_team->myid()];
    std::array<index_type, NumDimensions> offsets = {{ 0 }};
    std::array<size_type, NumDimensions>  extents = {{ block_size }};
    ViewSpec_t block_vs(offsets, extents);
    DASH_LOG_DEBUG_VAR("LoadBalancePattern<1>.local_block_local >", block_vs);
    return block_vs;
  }

local_capacity()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

SizeType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_capacity ( ) const

inline

Maximum number of elements assigned to a single unit.

See also

Pattern Concept

Definition at line 942 of file LoadBalancePattern.h.

  {
    return _local_capacity;
  }

local_coords()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_coords ( const std::array< IndexType, NumDimensions > &  g_coords ) const

inline

Converts global coordinates to their associated unit's respective local coordinates.

See also

Pattern Concept

Definition at line 633 of file LoadBalancePattern.h.

References dash::local().

  {
    local_index_t l_index = local(g_coords[0]);
    return std::array<IndexType, 1> {{ l_index.index }};
  }

local_extent()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_extent ( dim_t  dim ) const

inline

The actual number of elements in this pattern that are local to the calling unit in the given dimension.

See also

local_extents()

blocksize()

local_size()

extent()

Pattern Concept

Definition at line 519 of file LoadBalancePattern.h.

  {
    DASH_ASSERT_EQ(
      0, dim,
      "Wrong dimension for Pattern::local_extent. " <<
      "Expected dimension = 0, got " << dim);
    return _local_size;
  }

local_extents()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

std::array<SizeType, NumDimensions> dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_extents ( team_unit_t  unit ) const

inline

The actual number of elements in this pattern that are local to the given unit, by dimension.

See also

local_extent()

blocksize()

local_size()

extent()

Pattern Concept

Definition at line 539 of file LoadBalancePattern.h.

  {
    DASH_LOG_DEBUG_VAR("LoadBalancePattern.local_extents()", unit);
    DASH_LOG_DEBUG_VAR("LoadBalancePattern.local_extents >",
                       _local_sizes[unit]);
    return std::array<SizeType, 1> {{ _local_sizes[unit] }};
  }

local_index()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

local_index_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_index ( const std::array< IndexType, NumDimensions > &  g_coords ) const

inline

Converts global coordinates to their associated unit and their respective local index.

See also

Pattern Concept

Definition at line 646 of file LoadBalancePattern.h.

References dash::local().

  {
    return local(g_coords[0]);
  }

local_size()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

SizeType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::local_size ( team_unit_t  unit = UNDEFINED_TEAM_UNIT_ID ) const

inline

The actual number of elements in this pattern that are local to the calling unit in total.

See also

blocksize()

local_extent()

local_capacity()

Pattern Concept

Definition at line 957 of file LoadBalancePattern.h.

  {
    if (unit == UNDEFINED_TEAM_UNIT_ID) {
      unit = _myid;
    }
    return _local_sizes[unit];
  }

max_blocksize()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

SizeType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::max_blocksize ( ) const

inline

Maximum number of elements in a single block in all dimensions.

Returns

The maximum number of elements in a single block assigned to a unit.

See also

Pattern Concept

Definition at line 932 of file LoadBalancePattern.h.

  {
    return _local_capacity;
  }

memory_order()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

static constexpr MemArrange dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::memory_order ( )

inlinestatic

Memory order followed by the pattern.

Definition at line 1072 of file LoadBalancePattern.h.

  {
    return Arrangement;
  }

ndim()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

static constexpr dim_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::ndim ( )

inlinestatic

Number of dimensions of the cartesian space partitioned by the pattern.

Definition at line 1080 of file LoadBalancePattern.h.

References dash::global(), dash::max_element(), dash::Team::size(), and dash::transform().

  {
    return 1;
  }

num_units()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::num_units ( ) const

inline

The number of units to which this pattern's elements are mapped.

See also

Pattern Concept

Definition at line 971 of file LoadBalancePattern.h.

  {
    return _nunits;
  }

operator!=()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

bool dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::operator!= ( const self_t &  other ) const

inline

Inquality comparison operator.

Parameters

other

Pattern instance to compare for inequality

Definition at line 392 of file LoadBalancePattern.h.

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

operator==()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

bool dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::operator== ( const self_t &  other ) const

inline

Equality comparison operator.

Parameters

other

Pattern instance to compare for equality

Definition at line 373 of file LoadBalancePattern.h.

  {
    if (this == &other) {
      return true;
    }
    // no need to compare all members as most are derived from
    // constructor arguments.
    return(
      _size        == other._size &&
      _local_sizes == other._local_sizes &&
      _teamspec    == other._teamspec
    );
  }

size()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

IndexType dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::size ( ) const

inline

The number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 991 of file LoadBalancePattern.h.

  {
    return _size;
  }

sizespec()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

SizeSpec_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::sizespec ( ) const

inline

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1018 of file LoadBalancePattern.h.

  {
    return SizeSpec_t(std::array<SizeType, 1> {{ _size }});
  }

team()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

dash::Team& dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::team ( ) const

inline

The Team containing the units to which this pattern's elements are mapped.

Definition at line 1000 of file LoadBalancePattern.h.

  {
    return *_team;
  }

teamspec()

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

const TeamSpec_t& dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::teamspec ( ) const

inline

Cartesian arrangement of the Team containing the units to which this pattern's elements are mapped.

See also

Pattern Concept

Definition at line 1039 of file LoadBalancePattern.h.

  {
    return _teamspec;
  }

unit_at() [1/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

team_unit_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::unit_at ( const std::array< IndexType, NumDimensions > &  coords, const ViewSpec_t &  viewspec  ) const

inline

unit_at

Convert given point in pattern to its assigned unit id.

See also

Pattern Concept

Parameters

coords	Absolute coordinates of the point
viewspec	View specification (offsets) to apply on coords

Definition at line 428 of file LoadBalancePattern.h.

  {
    return unit_at(coords[0] + viewspec.offset(0));
  }

unit_at() [2/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

team_unit_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::unit_at ( const std::array< IndexType, NumDimensions > &  g_coords ) const

inline

Convert given coordinate in pattern to its assigned unit id.

See also

Pattern Concept

Definition at line 442 of file LoadBalancePattern.h.

  {
    return unit_at(g_coords[0]);
  }

unit_at() [3/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

team_unit_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::unit_at ( IndexType  global_pos, const ViewSpec_t &  viewspec  ) const

inline

Convert given global linear index to its assigned unit id.

See also

Pattern Concept

Parameters

global_pos	Global linear element offset
viewspec	View to apply global position

Definition at line 453 of file LoadBalancePattern.h.

  {
    return unit_at(global_pos + viewspec.offset(0));
  }

unit_at() [4/4]

template<typename CompBasedMeasure , typename MemBasedMeasure , MemArrange Arrangement, typename IndexType >

team_unit_t dash::LoadBalancePattern< 1, CompBasedMeasure, MemBasedMeasure, Arrangement, IndexType >::unit_at ( IndexType  g_index ) const

inline

Convert given global linear index to its assigned unit id.

See also

Pattern Concept

Parameters

g_index

Global linear element offset

Definition at line 467 of file LoadBalancePattern.h.

  {
    DASH_LOG_TRACE_VAR("LoadBalancePattern.unit_at()", g_index);

    for (team_unit_t unit_idx{0}; unit_idx < _nunits; ++unit_idx) {
      if (g_index < _local_sizes[unit_idx]) {
        DASH_LOG_TRACE_VAR("LoadBalancePattern.unit_at >", unit_idx);
        return unit_idx;
      }
      g_index -= _local_sizes[unit_idx];
    }
    DASH_THROW(
      dash::exception::InvalidArgument,
      "LoadBalancePattern.unit_at: " <<
      "global index " << g_index << " is out of bounds");
  }

---

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

• /tmp/tmporruphar/dash/include/dash/pattern/LoadBalancePattern.h