dash::BlockPattern< NumDimensions, Arrangement, IndexType > Class Template Reference

Defines how a list of global indices is mapped to single units within a Team. More...

#include <BlockPattern.h>

Classes
struct	local_coords_t
struct	local_index_t

Public Types
typedef pattern_partitioning_properties< pattern_partitioning_tag::rectangular, pattern_partitioning_tag::balanced, pattern_partitioning_tag::unbalanced >	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::canonical, 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
template<typename ... Args>
	BlockPattern (SizeType arg, Args &&... args)
	Constructor, initializes a pattern from an argument list consisting of the pattern size (extent, number of elements) in every dimension followed by optional distribution types. More...
	BlockPattern (const SizeSpec_t &sizespec, DistributionSpec_t dist, const TeamSpec_t &teamspec, dash::Team &team=dash::Team::All())
	Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec, TeamSpec and a Team. More...
	BlockPattern (const SizeSpec_t &sizespec, DistributionSpec_t dist=DistributionSpec_t(), Team &team=dash::Team::All())
	Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec and a Team. More...
	BlockPattern (const self_t &other)
	Copy constructor. More...
	BlockPattern (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...
BlockPattern &	operator= (const BlockPattern &other)
	Assignment 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 > &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 global_pos) 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...
constexpr std::array< SizeType, NumDimensions >	local_extents () const noexcept
	The actual number of elements in this pattern that are local to the active unit, by dimension. More...
constexpr std::array< SizeType, NumDimensions >	local_extents (team_unit_t unit) const noexcept
	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...
constexpr 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 > &global_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 > &global_coords) const
	Converts global coordinates to their associated unit's respective local coordinates. More...
local_index_t	local_index (const std::array< IndexType, NumDimensions > &global_coords) const
	Resolves the unit and the local index from global coordinates. 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 > &local_coords) const
	Converts local coordinates of active unit to global coordinates. More...
IndexType	global (IndexType local_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 > &local_coords) const
	Resolve an element's linear global index from a given unit's local coordinates of that element. More...
IndexType	global_at (const std::array< IndexType, NumDimensions > &view_coords, const ViewSpec_t &viewspec) const
	Global coordinates and viewspec to global position in the pattern's iteration order. More...
IndexType	global_at (const std::array< IndexType, NumDimensions > &global_coords) const
	Global coordinates to global position in the pattern's iteration order. More...
IndexType	at (const std::array< IndexType, NumDimensions > &global_coords) const
	at More...
IndexType	at (const std::array< IndexType, NumDimensions > &global_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	has_local_elements (dim_t dim, IndexType dim_offset, team_unit_t unit, const ViewSpec_t &viewspec) const
	is_local More...
bool	is_local (IndexType index, team_unit_t unit) const
	Whether the given global index is local to the specified unit. More...
constexpr bool	is_local (IndexType index) const noexcept
	Whether the given global index is local to the unit that created this pattern instance. More...
constexpr const BlockSpec_t &	blockspec () const noexcept
	block More...
constexpr const BlockSpec_t &	local_blockspec () const noexcept
	Cartesian arrangement of local pattern blocks. More...
index_type	block_at (const std::array< index_type, NumDimensions > &g_coords) const
	Index of block at given global coordinates. More...
local_index_t	local_block_at (const std::array< index_type, NumDimensions > &g_coords) const
	Unit and local block index at given global coordinates. More...
ViewSpec_t	block (index_type global_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 local_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 local_block_index) const
	View spec (offset and extents) of block at local linear block index in local cartesian element space. More...
constexpr SizeType	blocksize (dim_t dimension) const noexcept
	Maximum number of elements in a single block in the given dimension. More...
constexpr SizeType	max_blocksize () const noexcept
	Maximum number of elements in a single block in all dimensions. More...
constexpr SizeType	local_capacity () const noexcept
	Maximum number of elements assigned to a single unit in total, equivalent to the local capacity of every unit in this pattern. More...
constexpr SizeType	local_size (team_unit_t unit=UNDEFINED_TEAM_UNIT_ID) const noexcept
	The actual number of elements in this pattern that are local to the calling unit in total. More...
constexpr IndexType	num_units () const noexcept
	The number of units to which this pattern's elements are mapped. More...
constexpr IndexType	capacity () const noexcept
	The maximum number of elements arranged in this pattern. More...
constexpr IndexType	size () const noexcept
	The number of elements arranged in this pattern. More...
constexpr dash::Team &	team () const noexcept
	The Team containing the units to which this pattern's elements are mapped. More...
constexpr const DistributionSpec_t &	distspec () const noexcept
	Distribution specification of this pattern. More...
constexpr SizeSpec_t	sizespec () const noexcept
	Size specification of the index space mapped by this pattern. More...
constexpr const std::array< SizeType, NumDimensions > &	extents () const noexcept
	Size specification of the index space mapped by this pattern. More...
constexpr const TeamSpec_t &	teamspec () const noexcept
	Cartesian arrangement of the Team containing the units to which this pattern's elements are mapped. More...
constexpr std::array< IndexType, NumDimensions >	coords (IndexType index) const noexcept
	Convert given global linear offset (index) to global cartesian coordinates. More...
constexpr std::array< IndexType, NumDimensions >	coords (IndexType index, const ViewSpec_t &viewspec) const noexcept
	Convert given global linear offset (index) and viewspec to global cartesian coordinates. More...
SizeType	underfilled_blocksize (dim_t dimension) const
	Number of elements missing in the overflow block of given dimension compared to the regular blocksize (. More...

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

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

Detailed Description

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>
class dash::BlockPattern< NumDimensions, Arrangement, IndexType >

Defines how a list of global indices is mapped to single units within a Team.

Template Parameters

NumDimensions	The number of dimensions of the pattern
Arrangement	The memory order of the pattern (ROW_MAJOR or COL_MAJOR), defaults to ROW_MAJOR. Memory order defines how elements in the pattern will be iterated predominantly

See also

MemArrange

Implemented concept:

Pattern Concept

Examples:

ex.06.pattern-block-visualizer/main.cpp, ex.08.io-hdf5/main.cpp, ex.10.radixsort/main.cpp, ex.11.halo-stencil/main.cpp, and ex.11.simple-stencil/main.cpp.

Definition at line 42 of file BlockPattern.h.

Member Typedef Documentation

layout_properties

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

typedef pattern_layout_properties< pattern_layout_tag::canonical, pattern_layout_tag::linear > dash::BlockPattern< NumDimensions, Arrangement, IndexType >::layout_properties

Satisfiable properties in pattern property category Layout:

Definition at line 69 of file BlockPattern.h.

mapping_properties

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

typedef pattern_mapping_properties< pattern_mapping_tag::unbalanced > dash::BlockPattern< NumDimensions, Arrangement, IndexType >::mapping_properties

Satisfiable properties in pattern property category Mapping:

Definition at line 61 of file BlockPattern.h.

partitioning_properties

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

typedef pattern_partitioning_properties< pattern_partitioning_tag::rectangular, pattern_partitioning_tag::balanced, pattern_partitioning_tag::unbalanced > dash::BlockPattern< NumDimensions, Arrangement, IndexType >::partitioning_properties

Satisfiable properties in pattern property category Partitioning:

Definition at line 56 of file BlockPattern.h.

Constructor & Destructor Documentation

BlockPattern() [1/5]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

template<typename ... Args>

dash::BlockPattern< NumDimensions, Arrangement, IndexType >::BlockPattern ( SizeType  arg, Args &&...  args  )

inline

Constructor, initializes a pattern from an argument list consisting of the pattern size (extent, number of elements) in every dimension followed by optional distribution types.

Examples:

// A 5x3 rectangle with blocked distribution in the first dimension
Pattern p1(5,3, BLOCKED);
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE));
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           TeamSpec<2>(dash::Team::All(), 1));
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           // How teams are arranged in all dimensions, default is
           // an extent of all units in first, and 1 in all higher
           // dimensions:
           TeamSpec<2>(dash::Team::All(), 1),
           // The team containing the units to which the pattern
           // maps the global indices. Defaults to all all units:
           dash::Team::All());
// A cube with sidelength 3 with blockwise distribution in the first
// dimension
Pattern p2(3,3,3, BLOCKED);
// Same as p2
Pattern p3(3,3,3);
// A cube with sidelength 3 with blockwise distribution in the third
// dimension
Pattern p4(3,3,3, NONE, NONE, BLOCKED);

Parameters

arg	Argument list consisting of the pattern size (extent, number of elements) in every dimension followed by optional distribution types.
args	Argument list consisting of the pattern size (extent, number of elements) in every dimension followed by optional distribution types.

Definition at line 180 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::BlockPattern(), dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::underfilled_blocksize().

  : BlockPattern(PatternArguments_t(arg, args...))
  {
    DASH_LOG_TRACE("BlockPattern()", "Constructor with argument list");
    initialize_local_range();
    DASH_LOG_TRACE("BlockPattern()", "BlockPattern initialized");
  }

BlockPattern() [2/5]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

dash::BlockPattern< NumDimensions, Arrangement, IndexType >::BlockPattern ( const SizeSpec_t &  sizespec, DistributionSpec_t  dist, const TeamSpec_t &  teamspec, dash::Team &  team = dash::Team::All()  )

inline

Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec, TeamSpec and a Team.

Examples:

// A 5x3 rectangle with blocked distribution in the first dimension
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           // How teams are arranged in all dimensions, default is
           // an extent of all units in first, and 1 in all higher
           // dimensions:
           TeamSpec<2>(dash::Team::All(), 1),
           // The team containing the units to which the pattern
           // maps the global indices. Defaults to all all units:
           dash::Team::All());
// Same as
Pattern p1(5,3, BLOCKED);
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE));
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           TeamSpec<2>(dash::Team::All(), 1));

Parameters

sizespec	Pattern size (extent, number of elements) in every dimension
dist	Distribution type (BLOCKED, CYCLIC, BLOCKCYCLIC, TILE or NONE) of all dimensions.
teamspec	Cartesian arrangement of units within the team
team	Team containing units to which this pattern maps its elements

Definition at line 224 of file BlockPattern.h.

    : _distspec(std::move(dist))
    , _team(&team)
    , _teamspec(teamspec, _distspec, *_team)
    , _nunits(_teamspec.size())
    , _memory_layout(sizespec.extents())
    , _blocksize_spec(
          initialize_blocksizespec(sizespec, _distspec, _teamspec))
    , _blockspec(initialize_blockspec(sizespec, _distspec, _blocksize_spec))
    , _local_memory_layout(initialize_local_extents(_team->myid()))
    , _local_blockspec(
          initialize_local_blockspec(_blocksize_spec, _local_memory_layout))
    , _local_capacity(initialize_local_capacity())
  {
    DASH_LOG_TRACE("BlockPattern()", "(sizespec, dist, teamspec, team)");
    initialize_local_range();
    DASH_LOG_TRACE("BlockPattern()", "BlockPattern initialized");
  }

BlockPattern() [3/5]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

dash::BlockPattern< NumDimensions, Arrangement, IndexType >::BlockPattern ( const SizeSpec_t &  sizespec, DistributionSpec_t  dist = DistributionSpec_t(), Team &  team = dash::Team::All()  )

inline

Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec and a Team.

Examples:

// A 5x3 rectangle with blocked distribution in the first dimension
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           // The team containing the units to which the pattern
           // maps the global indices. Defaults to all all units:
           dash::Team::All());
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           // How teams are arranged in all dimensions, default is
           // an extent of all units in first, and 1 in all higher
           // dimensions:
           TeamSpec<2>(dash::Team::All(), 1),
           // The team containing the units to which the pattern
           // maps the global indices. Defaults to all all units:
           dash::Team::All());
// Same as
Pattern p1(5,3, BLOCKED);
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE));
// Same as
Pattern p1(SizeSpec<2>(5,3),
           DistributionSpec<2>(BLOCKED, NONE),
           TeamSpec<2>(dash::Team::All(), 1));

Parameters

sizespec	Pattern size (extent, number of elements) in every dimension
dist	Distribution type (BLOCKED, CYCLIC, BLOCKCYCLIC, TILE or NONE) of all dimensions. Defaults to BLOCKED in first, and NONE in higher dimensions
team	Team containing units to which this pattern maps its elements

Definition at line 286 of file BlockPattern.h.

    : _distspec(std::move(dist))
    , _team(&team)
    , _teamspec(_distspec, *_team)
    , _nunits(_teamspec.size())
    , _memory_layout(sizespec.extents())
    , _blocksize_spec(
          initialize_blocksizespec(sizespec, _distspec, _teamspec))
    , _blockspec(initialize_blockspec(sizespec, _distspec, _blocksize_spec))
    , _local_memory_layout(initialize_local_extents(_team->myid()))
    , _local_blockspec(
          initialize_local_blockspec(_blocksize_spec, _local_memory_layout))
    , _local_capacity(initialize_local_capacity())
  {
    DASH_LOG_TRACE("BlockPattern()", "(sizespec, dist, team)");
    initialize_local_range();
    DASH_LOG_TRACE("BlockPattern()", "BlockPattern initialized");
  }

BlockPattern() [4/5]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

dash::BlockPattern< NumDimensions, Arrangement, IndexType >::BlockPattern ( const self_t &  other )

inline

Copy constructor.

Definition at line 316 of file BlockPattern.h.

  : _distspec(other._distspec),
    _team(other._team),
    _teamspec(other._teamspec),
    _nunits(other._nunits),
    _memory_layout(other._memory_layout),
    _blocksize_spec(other._blocksize_spec),
    _blockspec(other._blockspec),
    _local_memory_layout(other._local_memory_layout),
    _local_blockspec(other._local_blockspec),
    _local_capacity(other._local_capacity),
    _lbegin(other._lbegin),
    _lend(other._lend)
  {
    // No need to copy _arguments as it is just used to
    // initialize other members.
    DASH_LOG_TRACE("BlockPattern(other)", "BlockPattern copied");
  }

BlockPattern() [5/5]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

dash::BlockPattern< NumDimensions, Arrangement, IndexType >::BlockPattern ( 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 341 of file BlockPattern.h.

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

Member Function Documentation

at() [1/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::at ( const std::array< IndexType, NumDimensions > &  global_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 855 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::at(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::at(), and dash::BlockPattern< 1, Arrangement, IndexType >::local_index().

  {
    auto unit = unit_at(global_coords);
    // Global coords to local coords:
    std::array<IndexType, NumDimensions> l_coords =
      local_coords(global_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.at", l_coords);
    if (unit == _team->myid()) {
      // Coords are local to this unit, use pre-generated local memory
      // layout
      return _local_memory_layout.at(l_coords);
    } else {
      // Cannot use _local_memory_layout as it is only defined for the
      // active unit but does not specify local memory of other units.
      // Generate local memory layout for unit assigned to coords:
      auto l_mem_layout =
        LocalMemoryLayout_t(initialize_local_extents(unit));
      return l_mem_layout.at(l_coords);
    }
  }

at() [2/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::at ( const std::array< IndexType, NumDimensions > &  global_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 884 of file BlockPattern.h.

  {
    auto coords = global_coords;
    for (auto d = 0; d < NumDimensions; ++d) {
      coords[d] += viewspec.offset(d);
    }
    DASH_LOG_TRACE_VAR("BlockPattern.at()", coords);
    DASH_LOG_TRACE_VAR("BlockPattern.at()", viewspec);
    return at(coords);
  }

at() [3/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

template<typename ... Values>

IndexType dash::BlockPattern< NumDimensions, 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 905 of file BlockPattern.h.

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

block()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

ViewSpec_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::block ( index_type  global_block_index ) const

inline

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

Definition at line 1058 of file BlockPattern.h.

  {
    // block index -> block coords -> offset
    auto block_coords = _blockspec.coords(global_block_index);
    std::array<index_type, NumDimensions> offsets{};
    std::array<size_type, NumDimensions>  extents{};

    for (auto d = 0; d < NumDimensions; ++d) {
      auto num_blocks_d = _blockspec.extent(d);
      extents[d]        = _blocksize_spec.extent(d);
      if(block_coords[d] == (num_blocks_d - 1)){
        extents[d] -= underfilled_blocksize(d);
      }
      offsets[d] = block_coords[d] * _blocksize_spec.extent(d);
    }
    return ViewSpec_t(offsets, extents);
  }

block_at()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

index_type dash::BlockPattern< NumDimensions, 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 1007 of file BlockPattern.h.

  {
    std::array<index_type, NumDimensions> block_coords{};
    // Coord to block coord to unit coord:
    for (auto d = 0; d < NumDimensions; ++d) {
      block_coords[d] = g_coords[d] / _blocksize_spec.extent(d);
    }
    // Block coord to block index:
    auto block_idx = _blockspec.at(block_coords);
    DASH_LOG_TRACE("BlockPattern.block_at",
                   "coords", g_coords,
                   "> block index", block_idx);
    return block_idx;
  }

blocksize()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr SizeType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::blocksize ( dim_t  dimension ) const

inlinenoexcept

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 1163 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::underfilled_blocksize().

  {
    return _blocksize_spec.extent(dimension);
  }

blockspec()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr const BlockSpec_t& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::blockspec ( ) const

inlinenoexcept

block

Cartesian arrangement of pattern blocks.

Definition at line 989 of file BlockPattern.h.

  {
    return _blockspec;
  }

capacity()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::capacity ( ) const

inlinenoexcept

The maximum number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 1227 of file BlockPattern.h.

  {
    return _memory_layout.size();
  }

coords() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr std::array<IndexType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::coords ( IndexType  index ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 1297 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::at(), dash::BlockPattern< 1, Arrangement, IndexType >::local(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_at().

  {
    return _memory_layout.coords(index);
  }

coords() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr std::array<IndexType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::coords ( IndexType  index, const ViewSpec_t &  viewspec  ) const

inlinenoexcept

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

See also

Pattern Concept

Parameters

index	Global index (offset) to convert
viewspec	View specification (offsets) to apply on coords

Definition at line 1309 of file BlockPattern.h.

  {
    return _memory_layout.coords(index, viewspec);
  }

distspec()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr const DistributionSpec_t& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::distspec ( ) const

inlinenoexcept

Distribution specification of this pattern.

Definition at line 1254 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::underfilled_blocksize().

  {
    return _distspec;
  }

extent()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, 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 511 of file BlockPattern.h.

  {
    if (dim >= NumDimensions || dim < 0) {
      DASH_THROW(
        dash::exception::OutOfRange,
        "Wrong dimension for Pattern::local_extent. "
        << "Expected dimension between 0 and " << NumDimensions-1 << ", "
        << "got " << dim);
    }
    return _memory_layout.extent(dim);
  }

extents()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr const std::array<SizeType, NumDimensions>& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::extents ( ) const

inlinenoexcept

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1275 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::block(), dash::BlockPattern< 1, Arrangement, IndexType >::local_block_local(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_block_local().

  {
    return _memory_layout.extents();
  }

global() [1/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

std::array<IndexType, NumDimensions> dash::BlockPattern< NumDimensions, 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 710 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::global(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::global(), dash::BlockPattern< 1, Arrangement, IndexType >::local_block(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_block(), dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::underfilled_blocksize().

  {
    DASH_LOG_DEBUG_VAR("BlockPattern.global()", local_coords);
    if (_teamspec.size() < 2) {
      return local_coords;
    }
    // Coordinates of the unit within the team spec:
    std::array<IndexType, NumDimensions> unit_ts_coord =
      _teamspec.coords(unit);
    // Index of the element:
    std::array<IndexType, NumDimensions> glob_index{};
    for (auto d = 0; d < NumDimensions; ++d) {
      const Distribution & dist = _distspec[d];
      auto num_units_d          = _teamspec.extent(d);
      auto blocksize_d          = _blocksize_spec.extent(d);
      auto local_index_d        = local_coords[d];
      // TOOD: Use % (blocksize_d - underfill_d)
      auto elem_block_offset_d  = local_index_d % blocksize_d;
      // Global coords of the element's block within all blocks:
      auto block_index_d        = dist.local_index_to_block_coord(
                                    unit_ts_coord[d], // unit ts offset in d
                                    local_index_d,
                                    num_units_d
                                  );
      glob_index[d]  = (block_index_d * blocksize_d) + elem_block_offset_d;
    }
    DASH_LOG_DEBUG_VAR("BlockPattern.global >", glob_index);
    return glob_index;
  }

global() [2/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

std::array<IndexType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::global ( const std::array< IndexType, NumDimensions > &  local_coords ) const

inline

Converts local coordinates of active unit to global coordinates.

See also

Pattern Concept

Definition at line 747 of file BlockPattern.h.

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

global() [3/3]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::global ( IndexType  local_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 global()

Pattern Concept

Definition at line 761 of file BlockPattern.h.

  {
    std::array<IndexType, NumDimensions> local_coords =
      _local_memory_layout.coords(local_index);
    DASH_LOG_TRACE_VAR("BlockPattern.local_to_global_idx()", local_coords);
    std::array<IndexType, NumDimensions> global_coords =
      global(_team->myid(), local_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.local_to_global_idx >", global_coords);
    return _memory_layout.at(global_coords);
  }

global_at() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::global_at ( const std::array< IndexType, NumDimensions > &  view_coords, const ViewSpec_t &  viewspec  ) const

inline

Global coordinates and viewspec to global position in the pattern's iteration order.

See also

at

local_at

Pattern Concept

Definition at line 800 of file BlockPattern.h.

  {
    DASH_LOG_TRACE("BlockPattern.global_at()",
                   "view coords:",view_coords,
                   "view:",       viewspec);
    // Global coordinates of the element referenced in the view:
    std::array<IndexType, NumDimensions> global_coords{};
    for (auto d = 0; d < NumDimensions; ++d) {
      global_coords[d] = view_coords[d] + viewspec.offset(d);
    }
    DASH_LOG_TRACE("BlockPattern.global_at",
                   "global coords:", global_coords);
    // Offset in iteration order is identical to offset in canonical order:
    auto offset = _memory_layout.at(global_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.global_at >", offset);
    return offset;
  }

global_at() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::global_at ( const std::array< IndexType, NumDimensions > &  global_coords ) const

inline

Global coordinates to global position in the pattern's iteration order.

NOTE: Expects extent[d] to be a multiple of blocksize[d] * nunits[d] to ensure the balanced property.

See also

at

local_at

Pattern Concept

Definition at line 832 of file BlockPattern.h.

  {
    DASH_LOG_TRACE("BlockPattern.global_at()",
                   "gcoords:",  global_coords);
    // Offset in iteration order is identical to offset in canonical order:
    auto offset = _memory_layout.at(global_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.global_at >", offset);
    return offset;
  }

global_index()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::global_index ( team_unit_t  unit, const std::array< IndexType, NumDimensions > &  local_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 781 of file BlockPattern.h.

  {
    std::array<IndexType, NumDimensions> global_coords =
      global(unit, local_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.local_to_global_idx", global_coords);
    return _memory_layout.at(global_coords);
  }

has_local_elements()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

bool dash::BlockPattern< NumDimensions, Arrangement, IndexType >::has_local_elements ( dim_t  dim, IndexType  dim_offset, team_unit_t  unit, const ViewSpec_t &  viewspec  ) const

inline

is_local

Whether there are local elements in a dimension at a given offset, e.g. in a specific row or column.

See also

Pattern Concept

Parameters

dim	Dimension to check
dim_offset	Offset in dimension
unit	local id of the unit
viewspec	Viewspec to apply

Definition at line 926 of file BlockPattern.h.

  {
    DASH_LOG_TRACE_VAR("BlockPattern.has_local_elements()", dim);
    DASH_LOG_TRACE_VAR("BlockPattern.has_local_elements()", dim_offset);
    DASH_LOG_TRACE_VAR("BlockPattern.has_local_elements()", unit);
    // Apply viewspec offset in dimension to given position
    dim_offset += viewspec.offset(dim);
    // Offset to block offset
    IndexType block_coord_d    = dim_offset / _blocksize_spec.extent(dim);
    DASH_LOG_TRACE_VAR("BlockPattern.has_local_elements", block_coord_d);
    // Coordinate of unit in team spec in given dimension
    IndexType teamspec_coord_d = block_coord_d % _teamspec.extent(dim);
    DASH_LOG_TRACE_VAR("BlockPattern.has_local_elements()",
                       teamspec_coord_d);
    // Check if unit id lies in cartesian sub-space of team spec
    return _teamspec.includes_index(
              teamspec_coord_d,
              dim,
              dim_offset);
  }

is_local() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

bool dash::BlockPattern< NumDimensions, Arrangement, IndexType >::is_local ( IndexType  index, team_unit_t  unit  ) const

inline

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

See also

Pattern Concept

Definition at line 960 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::is_local(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::is_local().

  {
    auto glob_coords = coords(index);
    auto coords_unit = unit_at(glob_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.is_local >", (coords_unit == unit));
    return coords_unit == unit;
  }

is_local() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr bool dash::BlockPattern< NumDimensions, Arrangement, IndexType >::is_local ( IndexType  index ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 976 of file BlockPattern.h.

  {
    return is_local(index, team().myid());
  }

lbegin()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::lbegin ( ) const

inline

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

See also

Pattern Concept

Definition at line 406 of file BlockPattern.h.

  {
    return _lbegin;
  }

lend()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::lend ( ) const

inline

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

See also

Pattern Concept

Definition at line 416 of file BlockPattern.h.

  {
    return _lend;
  }

local() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

local_coords_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local ( const std::array< IndexType, NumDimensions > &  global_coords ) const

inline

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

TODO: Unoptimized

See also

Pattern Concept

Definition at line 625 of file BlockPattern.h.

  {
    local_coords_t l_coords;
    l_coords.coords = local_coords(global_coords);
    l_coords.unit   = unit_at(global_coords);
    return l_coords;
  }

local() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

local_index_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local ( IndexType  g_index ) const

inline

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

TODO: Unoptimized

See also

Pattern Concept

Definition at line 641 of file BlockPattern.h.

  {
    DASH_LOG_TRACE_VAR("BlockPattern.local()", g_index);
    // TODO: Implement dedicated method for this, conversion to/from
    //       global coordinates is expensive.
    auto l_coords = coords(g_index);
    return local_index(l_coords);
  }

local_at() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, 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 592 of file BlockPattern.h.

  {
    auto coords = local_coords;
    for (auto d = 0; d < NumDimensions; ++d) {
      coords[d] += viewspec.offset(d);
    }
    return _local_memory_layout.at(coords);
  }

local_at() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr IndexType dash::BlockPattern< NumDimensions, 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 610 of file BlockPattern.h.

  {
    return _local_memory_layout.at(local_coords);
  }

local_block()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

ViewSpec_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_block ( index_type  local_block_index ) const

inline

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

Definition at line 1081 of file BlockPattern.h.

  {
    // Initialize viewspec result with block extents:
    std::array<SizeType, NumDimensions>  block_vs_extents =
      _blocksize_spec.extents();
    std::array<IndexType, NumDimensions> block_vs_offsets {{ }};
    // Local block index to local block coords:
    auto l_block_coords = _local_blockspec.coords(local_block_index);
    auto l_elem_coords  = l_block_coords;
    // TODO: This is convenient but less efficient:
    // Translate local coordinates of first element in local block to global
    // coordinates:
    for (auto d = 0; d < NumDimensions; ++d) {
      auto num_blocks_d =_local_blockspec.extent(d);
      if(l_block_coords[d] == (num_blocks_d - 1)){
          size_type remaining = local_extent(d) % block_vs_extents[d];
          block_vs_extents[d] = (remaining == 0)
                                ? block_vs_extents[d]
                                : remaining;
        // to calculate offset, extent of fully filled blocks are needed
        l_elem_coords[d] *= _blocksize_spec.extent(d);
      } else {
        l_elem_coords[d] *= block_vs_extents[d];
      }
    }
    // Global coordinates of first element in block:
    auto g_elem_coords = global(l_elem_coords);
    for (auto d = 0; d < NumDimensions; ++d) {
      block_vs_offsets[d] = g_elem_coords[d];
    }
#ifdef __TODO__
    // Coordinates of the unit within the team spec:
    std::array<IndexType, NumDimensions> unit_ts_coord =
      _teamspec.coords(unit);
    for (auto d = 0; d < NumDimensions; ++d) {
      const Distribution & dist = _distspec[d];
      auto blocksize_d          = block_vs_extents[d];
      auto num_units_d          = _teamspec.extent(d);
      auto num_blocks_d         = _blockspec.extent(d);
      // Local to global block coords:
      auto g_block_coord_d      = (l_block_coords[d] + _myid) *
                                  _teamspec.extent(d);
      block_vs_offsets[d]       = g_block_coord_d * blocksize_d;
    }
#endif
    ViewSpec_t block_vs(block_vs_offsets, block_vs_extents);
    return block_vs;
  }

local_block_at()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

local_index_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_block_at ( const std::array< index_type, NumDimensions > &  g_coords ) const

inline

Unit and local block index at given global coordinates.

See also

Pattern Concept

Parameters

g_coords

Global coordinates of element

Definition at line 1029 of file BlockPattern.h.

  {
    local_index_t l_pos;

    std::array<IndexType, NumDimensions> l_block_coords{};
    std::array<IndexType, NumDimensions> unit_ts_coords{};
    for (dim_t d = 0; d < NumDimensions; ++d) {
      auto nunits_d      = _teamspec.extent(d);
      auto blocksize_d   = _blocksize_spec.extent(d);
      auto block_coord_d = g_coords[d] / blocksize_d;
      l_block_coords[d]  = block_coord_d / nunits_d;
      unit_ts_coords[d]  = block_coord_d % nunits_d;
    }
    l_pos.unit  = _teamspec.at(unit_ts_coords);
    l_pos.index = _local_blockspec.at(l_block_coords);

    DASH_LOG_TRACE("BlockPattern.local_block_at >",
                   "coords",             g_coords,
                   "unit:",              l_pos.unit,
                   "local block index:", l_pos.index);
    return l_pos;
  }

local_block_local()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

ViewSpec_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_block_local ( index_type  local_block_index ) const

inline

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

Definition at line 1135 of file BlockPattern.h.

  {
    // Local block index to local block coords:
    auto l_block_coords = _local_blockspec.coords(local_block_index);
    std::array<index_type, NumDimensions> offsets;
    std::array<size_type, NumDimensions>  extents = _blocksize_spec.extents();
    // last block in at least one dimension
    for(dim_t d=0; d<NumDimensions; ++d){
      if(l_block_coords[d] == (_local_blockspec.extent(d)-1)){
          size_type remaining = local_extent(d) % extents[d];
          extents[d] = (remaining == 0) ? extents[d] : remaining;
          // to calculate offset, extent of fully filled blocks are needed
          offsets[d] = l_block_coords[d] * _blocksize_spec.extent(d);
      } else {
        offsets[d] = l_block_coords[d] * extents[d];
      }
    }
    return ViewSpec_t(offsets, extents);
  }

local_blockspec()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr const BlockSpec_t& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_blockspec ( ) const

inlinenoexcept

Cartesian arrangement of local pattern blocks.

Definition at line 997 of file BlockPattern.h.

  {
    return _local_blockspec;
  }

local_capacity()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr SizeType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_capacity ( ) const

inlinenoexcept

Maximum number of elements assigned to a single unit in total, equivalent to the local capacity of every unit in this pattern.

See also

Pattern Concept

Definition at line 1189 of file BlockPattern.h.

  {
    return _local_capacity;
  }

local_coords()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

std::array<IndexType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_coords ( const std::array< IndexType, NumDimensions > &  global_coords ) const

inline

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

See also

Pattern Concept

Definition at line 657 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::at(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::global(), dash::BlockPattern< 1, Arrangement, IndexType >::local(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_at(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_coords().

  {
    std::array<IndexType, NumDimensions> local_coords{};
    for (auto d = 0; d < NumDimensions; ++d) {
      auto block_size_d     = _blocksize_spec.extent(d);
      auto b_offset_d       = global_coords[d] % block_size_d;
      auto g_block_offset_d = global_coords[d] / block_size_d;
      auto l_block_offset_d = g_block_offset_d / _teamspec.extent(d);
      local_coords[d]       = b_offset_d +
                              (l_block_offset_d * block_size_d);
    }
    return local_coords;
  }

local_extent()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

IndexType dash::BlockPattern< NumDimensions, 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 534 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_block(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local_block_local().

  {
    if (dim >= NumDimensions || dim < 0) {
      DASH_THROW(
        dash::exception::OutOfRange,
        "Wrong dimension for Pattern::local_extent. "
        << "Expected dimension between 0 and " << NumDimensions-1 << ", "
        << "got " << dim);
    }
    return _local_memory_layout.extent(dim);
  }

local_extents() [1/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr std::array<SizeType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_extents ( ) const

inlinenoexcept

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

See also

local_extent()

blocksize()

local_size()

extent()

Pattern Concept

Definition at line 557 of file BlockPattern.h.

  {
    return _local_memory_layout.extents();
  }

local_extents() [2/2]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr std::array<SizeType, NumDimensions> dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_extents ( team_unit_t  unit ) const

inlinenoexcept

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 573 of file BlockPattern.h.

  {
    return ( unit == _team->myid()
             ? _local_memory_layout.extents()
             : initialize_local_extents(unit)
           );
  }

local_index()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

local_index_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_index ( const std::array< IndexType, NumDimensions > &  global_coords ) const

inline

Resolves the unit and the local index from global coordinates.

See also

Pattern Concept

Definition at line 677 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::local(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local().

  {
    DASH_LOG_TRACE_VAR("BlockPattern.local_index()", global_coords);
    auto unit = unit_at(global_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.local_index", unit);
    // Global coords to local coords:
    std::array<IndexType, NumDimensions> l_coords =
      local_coords(global_coords);
    DASH_LOG_TRACE_VAR("BlockPattern.local_index", l_coords);
    if (unit == _team->myid()) {
      // Coords are local to this unit, use pre-generated local memory
      // layout
      return local_index_t { unit, _local_memory_layout.at(l_coords) };
    } else {
      // Cannot use _local_memory_layout as it is only defined for the
      // active unit but does not specify local memory of other units.
      // Generate local memory layout for unit assigned to coords:
      auto l_mem_layout =
        LocalMemoryLayout_t(initialize_local_extents(unit));
      return local_index_t { unit, l_mem_layout.at(l_coords) };
    }
  }

local_size()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr SizeType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::local_size ( team_unit_t  unit = UNDEFINED_TEAM_UNIT_ID ) const

inlinenoexcept

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 1204 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize().

  {
    return (unit == UNDEFINED_TEAM_UNIT_ID)
           ? _local_memory_layout.size()
           : initialize_local_extents(unit).size();
  }

max_blocksize()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr SizeType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::max_blocksize ( ) const

inlinenoexcept

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 1178 of file BlockPattern.h.

  {
    return _blocksize_spec.size();
  }

memory_order()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

static constexpr MemArrange dash::BlockPattern< NumDimensions, Arrangement, IndexType >::memory_order ( )

inlinestaticnoexcept

Memory order followed by the pattern.

Definition at line 1321 of file BlockPattern.h.

Referenced by dash::halo::StencilOperatorBoundary< Self_t >::update().

  {
    return Arrangement;
  }

ndim()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

static constexpr dim_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::ndim ( )

inlinestaticnoexcept

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

Definition at line 1329 of file BlockPattern.h.

Referenced by dash::halo::StencilOperatorBoundary< Self_t >::update().

  {
    return NumDimensions;
  }

num_units()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::num_units ( ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 1217 of file BlockPattern.h.

  {
    return _nunits;
  }

operator!=()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

bool dash::BlockPattern< NumDimensions, Arrangement, IndexType >::operator!= ( const self_t &  other ) const

inline

Inquality comparison operator.

Parameters

other

Pattern instance to compare for inequality

Definition at line 370 of file BlockPattern.h.

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

operator=()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

BlockPattern& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::operator= ( const BlockPattern< NumDimensions, Arrangement, IndexType > &  other )

inline

Assignment operator.

Definition at line 380 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::BlockPattern().

  {
    DASH_LOG_TRACE("BlockPattern.=(other)");
    if (this != &other) {
      _distspec            = other._distspec;
      _team                = other._team;
      _teamspec            = other._teamspec;
      _memory_layout       = other._memory_layout;
      _local_memory_layout = other._local_memory_layout;
      _blocksize_spec      = other._blocksize_spec;
      _blockspec           = other._blockspec;
      _local_blockspec     = other._local_blockspec;
      _local_capacity      = other._local_capacity;
      _nunits              = other._nunits;
      _lbegin              = other._lbegin;
      _lend                = other._lend;
      DASH_LOG_TRACE("BlockPattern.=(other)", "BlockPattern assigned");
    }
    return *this;
  }

operator==()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

bool dash::BlockPattern< NumDimensions, Arrangement, IndexType >::operator== ( const self_t &  other ) const

inline

Equality comparison operator.

Parameters

other

Pattern instance to compare for equality

Definition at line 348 of file BlockPattern.h.

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

size()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr IndexType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::size ( ) const

inlinenoexcept

The number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 1237 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::underfilled_blocksize().

  {
    return _memory_layout.size();
  }

sizespec()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr SizeSpec_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::sizespec ( ) const

inlinenoexcept

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1264 of file BlockPattern.h.

  {
    return SizeSpec_t(_memory_layout.extents());
  }

team()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr dash::Team& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::team ( ) const

inlinenoexcept

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

Definition at line 1246 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::BlockPattern(), dash::BlockPattern< 1, Arrangement, IndexType >::is_local(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::is_local().

  {
    return *_team;
  }

teamspec()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

constexpr const TeamSpec_t& dash::BlockPattern< NumDimensions, Arrangement, IndexType >::teamspec ( ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 1286 of file BlockPattern.h.

  {
    return _teamspec;
  }

underfilled_blocksize()

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

SizeType dash::BlockPattern< NumDimensions, Arrangement, IndexType >::underfilled_blocksize ( dim_t  dimension ) const

inline

Number of elements missing in the overflow block of given dimension compared to the regular blocksize (.

See also

blocksize(d)), with 0 <= underfilled_blocksize(d) < blocksize(d).

Definition at line 1339 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::block(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::block().

  {
    // Underflow blocksize = regular blocksize - overflow blocksize:
    auto ovf_blocksize = _memory_layout.extent(dimension) %
                         blocksize(dimension);
    if (ovf_blocksize == 0) {
      return 0;
    } else {
      auto reg_blocksize = blocksize(dimension);
      return reg_blocksize - ovf_blocksize;
    }
  }

unit_at() [1/4]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

team_unit_t dash::BlockPattern< NumDimensions, 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 430 of file BlockPattern.h.

Referenced by dash::BlockPattern< 1, Arrangement, IndexType >::local(), dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::local(), dash::BlockPattern< 1, Arrangement, IndexType >::local_index(), and dash::BlockPattern< 1, ROW_MAJOR, dash::default_index_t >::unit_at().

  {
    // Apply viewspec offsets to coordinates:
    std::array<IndexType, NumDimensions> vs_coords;
    for (auto d = 0; d < NumDimensions; ++d) {
      vs_coords[d] = coords[d] + viewspec.offset(0);
    }
    return unit_at(vs_coords);
  }

unit_at() [2/4]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

team_unit_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::unit_at ( const std::array< IndexType, NumDimensions > &  coords ) const

inline

Convert given coordinate in pattern to its assigned unit id.

See also

Pattern Concept

Definition at line 449 of file BlockPattern.h.

  {
    std::array<IndexType, NumDimensions> unit_coords{};
    // Coord to block coord to unit coord:
    for (auto d = 0; d < NumDimensions; ++d) {
      unit_coords[d] = (coords[d] / _blocksize_spec.extent(d))
                         % _teamspec.extent(d);
    }
    // Unit coord to unit id:
    team_unit_t unit_id(_teamspec.at(unit_coords));
    DASH_LOG_TRACE("BlockPattern.unit_at",
                   "coords", coords,
                   "> unit id", unit_id);
    return unit_id;
  }

unit_at() [3/4]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

team_unit_t dash::BlockPattern< NumDimensions, 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 471 of file BlockPattern.h.

  {
    auto global_coords = _memory_layout.coords(global_pos);
    return unit_at(global_coords, viewspec);
  }

unit_at() [4/4]

template<dim_t NumDimensions, MemArrange Arrangement = ROW_MAJOR, typename IndexType = dash::default_index_t>

team_unit_t dash::BlockPattern< NumDimensions, Arrangement, IndexType >::unit_at ( IndexType  global_pos ) const

inline

Convert given global linear index to its assigned unit id.

See also

blocksize()

blockspec()

blocksizespec()

Pattern Concept

Parameters

global_pos

Global linear element offset

Definition at line 490 of file BlockPattern.h.

  {
    auto global_coords = _memory_layout.coords(global_pos);
    return unit_at(global_coords);
  }

---

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

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