dash::CSRPattern< 1, Arrangement, IndexType > Class Template Reference

Irregular Pattern for Compressed Sparse Row Storage. More...

#include <CSRPattern.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 >	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
template<typename ... Args>
	CSRPattern (SizeType arg, Args &&... args)
	Constructor, initializes a pattern from an argument list consisting of the pattern size (extent, number of elements) followed by an optional distribution type. More...
	CSRPattern (const SizeSpec_t &sizespec, const DistributionSpec_t &distspec, const TeamSpec_t &teamspec, Team &team=dash::Team::All())
	Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec, TeamSpec and Team. More...
	CSRPattern (const SizeSpec_t &sizespec, const DistributionSpec_t &distspec, Team &team=dash::Team::All())
	Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec and Team. More...
template<typename ... Args>
	CSRPattern (const std::vector< size_type > &local_sizes, SizeType arg, Args &&... args)
	Constructor, initializes a pattern from an argument list consisting of the pattern size (extent, number of elements) followed by an optional distribution type. More...
	CSRPattern (const std::vector< size_type > &local_sizes, 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...
	CSRPattern (const std::vector< size_type > &local_sizes, Team &team=dash::Team::All())
	Constructor, initializes a pattern from explicit instances of SizeSpec, DistributionSpec, TeamSpec and a Team. More...
	CSRPattern (const self_t &other)=default
	Copy constructor. More...
	CSRPattern (self_t &&other)=default
	Move constructor. More...
	CSRPattern (self_t &other)
	Copy constructor using non-const lvalue reference parameter. More...
self_t &	operator= (const self_t &other)=default
	Assignment operator. More...
self_t &	operator= (self_t &&other)=default
	Move-assignment operator. More...
constexpr bool	operator== (const self_t &other) const noexcept
	Equality comparison operator. More...
constexpr bool	operator!= (const self_t &other) const noexcept
	Inquality comparison operator. More...
constexpr IndexType	lbegin () const noexcept
	Resolves the global index of the first local element in the pattern. More...
constexpr IndexType	lend () const noexcept
	Resolves the global index past the last local element in the pattern. More...
constexpr team_unit_t	unit_at (const std::array< IndexType, NumDimensions > &coords, const ViewSpec_t &viewspec) const
	unit_at More...
constexpr team_unit_t	unit_at (const std::array< IndexType, NumDimensions > &g_coords) const
	Convert given coordinate in pattern to its assigned unit id. More...
constexpr 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...
constexpr std::array< SizeType, NumDimensions >	local_extents () const noexcept
	The actual number of elements in this pattern that are local to the calling 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...
constexpr IndexType	local_at (const std::array< IndexType, NumDimensions > &local_coords, const ViewSpec_t &viewspec) const noexcept
	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 > &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...
constexpr 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...
constexpr 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...
constexpr std::array< IndexType, NumDimensions >	global (const std::array< IndexType, NumDimensions > &l_coords) const
	Converts local coordinates of active unit to global coordinates. More...
constexpr 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...
constexpr IndexType	global (IndexType l_index) const
	Resolve an element's linear global index from the calling unit's local index of that element. More...
constexpr 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...
constexpr 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>
constexpr IndexType	at (IndexType value, Values ... values) const
	Global coordinates to local index. More...
constexpr bool	is_local (IndexType index, team_unit_t unit) const noexcept
	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...
constexpr const BlockSpec_t &	blockspec () const noexcept
	block More...
constexpr 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...
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 () const noexcept
	The actual number of elements in this pattern that are local to the calling unit in total. More...
constexpr SizeType	local_size (team_unit_t unit) const noexcept
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...
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...

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 = "CSRPattern1D"

Detailed Description

template<MemArrange Arrangement, typename IndexType>
class dash::CSRPattern< 1, Arrangement, IndexType >

Irregular Pattern for Compressed Sparse Row Storage.

Specialization for 1-dimensional data.

Implemented concept:

Pattern Concept

Definition at line 52 of file CSRPattern.h.

Member Typedef Documentation

layout_properties

template<MemArrange Arrangement, typename IndexType >

typedef pattern_layout_properties< pattern_layout_tag::blocked, pattern_layout_tag::linear > dash::CSRPattern< 1, Arrangement, IndexType >::layout_properties

Satisfiable properties in pattern property category Layout:

Definition at line 85 of file CSRPattern.h.

mapping_properties

template<MemArrange Arrangement, typename IndexType >

typedef pattern_mapping_properties< pattern_mapping_tag::unbalanced > dash::CSRPattern< 1, Arrangement, IndexType >::mapping_properties

Satisfiable properties in pattern property category Mapping:

Definition at line 77 of file CSRPattern.h.

partitioning_properties

template<MemArrange Arrangement, typename IndexType >

typedef pattern_partitioning_properties< pattern_partitioning_tag::minimal, pattern_partitioning_tag::rectangular, pattern_partitioning_tag::balanced, pattern_partitioning_tag::unbalanced > dash::CSRPattern< 1, Arrangement, IndexType >::partitioning_properties

Satisfiable properties in pattern property category Partitioning:

Definition at line 72 of file CSRPattern.h.

Constructor & Destructor Documentation

CSRPattern() [1/9]

template<MemArrange Arrangement, typename IndexType >

template<typename ... Args>

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( SizeType  arg, Args &&...  args  )

inline

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

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 163 of file CSRPattern.h.

  : CSRPattern(PatternArguments_t(arg, args...))
  {
    DASH_LOG_TRACE("CSRPattern()", "Constructor with argument list");
    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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [2/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const SizeSpec_t &  sizespec, const DistributionSpec_t &  distspec, const TeamSpec_t &  teamspec, Team &  team = dash::Team::All()  )

inline

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

Parameters

sizespec	Size spec of the pattern.
distspec	Distribution spec.
teamspec	Cartesian arrangement of units within the team
team	Team containing units to which this pattern maps its elements.

Definition at line 188 of file CSRPattern.h.

References dash::Team::size().

  : _size(sizespec.size()),
    _local_sizes(initialize_local_sizes(
        _size,
        distspec,
        team)),
    _block_offsets(initialize_block_offsets(
        _local_sizes)),
    _memory_layout(std::array<SizeType, 1> {{ _size }}),
    _blockspec(initialize_blockspec(
        _local_sizes)),
    _distspec(DistributionSpec_t()),
    _team(&team),
    _teamspec(
      teamspec,
      _distspec,
      *_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("CSRPattern()", "(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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [3/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const SizeSpec_t &  sizespec, const DistributionSpec_t &  distspec, Team &  team = dash::Team::All()  )

inline

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

Parameters

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

Definition at line 235 of file CSRPattern.h.

References dash::Team::size().

  : _size(sizespec.size()),
    _local_sizes(initialize_local_sizes(
        _size,
        distspec,
        team)),
    _block_offsets(initialize_block_offsets(
        _local_sizes)),
    _memory_layout(std::array<SizeType, 1> {{ _size }}),
    _blockspec(initialize_blockspec(
        _local_sizes)),
    _distspec(DistributionSpec_t()),
    _team(&team),
    _teamspec(_distspec, *_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("CSRPattern()", "(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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [4/9]

template<MemArrange Arrangement, typename IndexType >

template<typename ... Args>

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const std::vector< size_type > &  local_sizes, SizeType  arg, Args &&...  args  )

inline

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

Parameters

local_sizes	Number of local elements for every unit in the active team.
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 279 of file CSRPattern.h.

  : CSRPattern(local_sizes, PatternArguments_t(arg, args...))
  {
    DASH_LOG_TRACE("CSRPattern()", "Constructor with argument list");
    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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [5/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const std::vector< size_type > &  local_sizes, 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.

Parameters

local_sizes	Number of local elements for every unit in the active team.
teamspec	Cartesian arrangement of units within the team
team	Team containing units to which this pattern maps its elements

Definition at line 306 of file CSRPattern.h.

References dash::Team::size().

  : _size(initialize_size(
        local_sizes)),
    _local_sizes(local_sizes),
    _block_offsets(initialize_block_offsets(
        _local_sizes)),
    _memory_layout(std::array<SizeType, 1> {{ _size }}),
    _blockspec(initialize_blockspec(
        _local_sizes)),
    _distspec(DistributionSpec_t()),
    _team(&team),
    _teamspec(
        teamspec,
        _distspec,
        *_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("CSRPattern()", "(sizespec, dist, teamspec, 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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [6/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const std::vector< size_type > &  local_sizes, Team &  team = dash::Team::All()  )

inline

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

Parameters

local_sizes	Number of local elements for every unit in the active team.
team	Team containing units to which this pattern maps its elements

Definition at line 349 of file CSRPattern.h.

References dash::Team::size().

  : _size(
      initialize_size(
        local_sizes)),
    _local_sizes(local_sizes),
    _block_offsets(
      initialize_block_offsets(
        _local_sizes)),
    _memory_layout(std::array<SizeType, 1> {{ _size }}),
    _blockspec(
      initialize_blockspec(
        _local_sizes)),
    _distspec(DistributionSpec_t()),
    _team(&team),
    _teamspec(_distspec, *_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("CSRPattern()", "(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("CSRPattern()", "CSRPattern initialized");
  }

CSRPattern() [7/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( const self_t &  other )

default

Copy constructor.

CSRPattern() [8/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( self_t &&  other )

default

Move constructor.

CSRPattern() [9/9]

template<MemArrange Arrangement, typename IndexType >

dash::CSRPattern< 1, Arrangement, IndexType >::CSRPattern ( 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 403 of file CSRPattern.h.

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

Member Function Documentation

at() [1/3]

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 802 of file CSRPattern.h.

  {
    return local_coords(g_coords)[0];
  }

at() [2/3]

template<MemArrange Arrangement, typename IndexType >

IndexType dash::CSRPattern< 1, 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 815 of file CSRPattern.h.

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

at() [3/3]

template<MemArrange Arrangement, typename IndexType >

template<typename ... Values>

constexpr IndexType dash::CSRPattern< 1, 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 832 of file CSRPattern.h.

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

block()

template<MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::CSRPattern< 1, 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 905 of file CSRPattern.h.

  {
    DASH_LOG_DEBUG_VAR("CSRPattern<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("CSRPattern<1>.block >", block_vs);
    return block_vs;
  }

block_at()

template<MemArrange Arrangement, typename IndexType >

constexpr index_type dash::CSRPattern< 1, 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 894 of file CSRPattern.h.

  {
    return static_cast<index_type>(unit_at(g_coords[0]));
  }

blocksize()

template<MemArrange Arrangement, typename IndexType >

constexpr SizeType dash::CSRPattern< 1, 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 961 of file CSRPattern.h.

  {
    return _local_capacity;
  }

blockspec()

template<MemArrange Arrangement, typename IndexType >

constexpr const BlockSpec_t& dash::CSRPattern< 1, Arrangement, IndexType >::blockspec ( ) const

inlinenoexcept

block

Cartesian arrangement of pattern blocks.

Definition at line 884 of file CSRPattern.h.

  {
    return _blockspec;
  }

capacity()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, Arrangement, IndexType >::capacity ( ) const

inlinenoexcept

The maximum number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 1028 of file CSRPattern.h.

  {
    return _size;
  }

coords() [1/2]

template<MemArrange Arrangement, typename IndexType >

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

inlinenoexcept

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

See also

Pattern Concept

Definition at line 1098 of file CSRPattern.h.

References dash::index().

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

coords() [2/2]

template<MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::CSRPattern< 1, 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 1110 of file CSRPattern.h.

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

distspec()

template<MemArrange Arrangement, typename IndexType >

constexpr const DistributionSpec_t& dash::CSRPattern< 1, Arrangement, IndexType >::distspec ( ) const

inlinenoexcept

Distribution specification of this pattern.

Definition at line 1055 of file CSRPattern.h.

  {
    return _distspec;
  }

extent()

template<MemArrange Arrangement, typename IndexType >

IndexType dash::CSRPattern< 1, 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 545 of file CSRPattern.h.

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

extents()

template<MemArrange Arrangement, typename IndexType >

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

inlinenoexcept

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1076 of file CSRPattern.h.

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

global() [1/4]

template<MemArrange Arrangement, typename IndexType >

std::array<IndexType, NumDimensions> dash::CSRPattern< 1, 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 719 of file CSRPattern.h.

  {
    DASH_LOG_DEBUG_VAR("CSRPattern.global()", unit);
    DASH_LOG_DEBUG_VAR("CSRPattern.global()", local_coords);
    DASH_LOG_TRACE_VAR("CSRPattern.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("CSRPattern.global >", glob_index);
    return std::array<IndexType, 1> {{ glob_index }};
  }

global() [2/4]

template<MemArrange Arrangement, typename IndexType >

constexpr std::array<IndexType, NumDimensions> dash::CSRPattern< 1, 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 740 of file CSRPattern.h.

References dash::global().

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

global() [3/4]

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 754 of file CSRPattern.h.

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

global() [4/4]

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 769 of file CSRPattern.h.

References dash::global().

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

global_index()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 783 of file CSRPattern.h.

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

is_local() [1/2]

template<MemArrange Arrangement, typename IndexType >

constexpr bool dash::CSRPattern< 1, Arrangement, IndexType >::is_local ( IndexType  index, team_unit_t  unit  ) const

inlinenoexcept

is_local

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

See also

Pattern Concept

Definition at line 851 of file CSRPattern.h.

  {
    return (index >= _block_offsets[unit])
           && ( unit == _nunits-1
                || index <  _block_offsets[unit+1]
              );
  }

is_local() [2/2]

template<MemArrange Arrangement, typename IndexType >

bool dash::CSRPattern< 1, 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 867 of file CSRPattern.h.

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

lbegin()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, Arrangement, IndexType >::lbegin ( ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 450 of file CSRPattern.h.

  {
    return _lbegin;
  }

lend()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, Arrangement, IndexType >::lend ( ) const

inlinenoexcept

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

See also

Pattern Concept

Definition at line 460 of file CSRPattern.h.

  {
    return _lend;
  }

local() [1/2]

template<MemArrange Arrangement, typename IndexType >

local_coords_t dash::CSRPattern< 1, 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 646 of file CSRPattern.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<MemArrange Arrangement, typename IndexType >

local_index_t dash::CSRPattern< 1, 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 663 of file CSRPattern.h.

  {
    DASH_LOG_TRACE_VAR("CSRPattern.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("CSRPattern.local >",
                       "unit:",  l_index.unit,
                       "index:", l_index.index);
        return l_index;
      }
      g_index -= _local_sizes[unit_idx];
    }
    DASH_THROW(
      dash::exception::InvalidArgument,
      "CSRPattern.local: " <<
      "global index " << g_index << " is out of bounds");
  }

local_at() [1/2]

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, Arrangement, IndexType >::local_at ( const std::array< IndexType, NumDimensions > &  local_coords, const ViewSpec_t &  viewspec  ) const

inlinenoexcept

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 617 of file CSRPattern.h.

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

local_at() [2/2]

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 631 of file CSRPattern.h.

  {
    return local_coords[0];
  }

local_block()

template<MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::CSRPattern< 1, 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 922 of file CSRPattern.h.

  {
    DASH_LOG_DEBUG_VAR("CSRPattern<1>.local_block()", l_block_index);
    DASH_ASSERT_EQ(
      0, l_block_index,
      "CSRPattern 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("CSRPattern<1>.local_block >", block_vs);
    return block_vs;
  }

local_block_local()

template<MemArrange Arrangement, typename IndexType >

ViewSpec_t dash::CSRPattern< 1, 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 942 of file CSRPattern.h.

  {
    DASH_LOG_DEBUG_VAR("CSRPattern<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("CSRPattern<1>.local_block_local >", block_vs);
    return block_vs;
  }

local_capacity()

template<MemArrange Arrangement, typename IndexType >

constexpr SizeType dash::CSRPattern< 1, 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 987 of file CSRPattern.h.

  {
    return _local_capacity;
  }

local_coords()

template<MemArrange Arrangement, typename IndexType >

constexpr std::array<IndexType, NumDimensions> dash::CSRPattern< 1, 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 692 of file CSRPattern.h.

References dash::local().

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

local_extent()

template<MemArrange Arrangement, typename IndexType >

IndexType dash::CSRPattern< 1, 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 565 of file CSRPattern.h.

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

local_extents() [1/2]

template<MemArrange Arrangement, typename IndexType >

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

inlinenoexcept

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

See also

local_extent()

blocksize()

local_size()

extent()

Pattern Concept

Definition at line 586 of file CSRPattern.h.

  {
    return std::array<SizeType, 1> {{ _local_sizes[_team->myid()] }};
  }

local_extents() [2/2]

template<MemArrange Arrangement, typename IndexType >

constexpr std::array<SizeType, NumDimensions> dash::CSRPattern< 1, 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 601 of file CSRPattern.h.

  {
    return std::array<SizeType, 1> {{ _local_sizes[unit] }};
  }

local_index()

template<MemArrange Arrangement, typename IndexType >

constexpr local_index_t dash::CSRPattern< 1, 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 704 of file CSRPattern.h.

References dash::local().

  {
    return local(g_coords[0]);
  }

local_size()

template<MemArrange Arrangement, typename IndexType >

constexpr SizeType dash::CSRPattern< 1, Arrangement, IndexType >::local_size ( ) 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 1003 of file CSRPattern.h.

  {
    return _local_size;
  }

max_blocksize()

template<MemArrange Arrangement, typename IndexType >

constexpr SizeType dash::CSRPattern< 1, 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 976 of file CSRPattern.h.

  {
    return _local_capacity;
  }

memory_order()

template<MemArrange Arrangement, typename IndexType >

static constexpr MemArrange dash::CSRPattern< 1, Arrangement, IndexType >::memory_order ( )

inlinestatic

Memory order followed by the pattern.

Definition at line 1120 of file CSRPattern.h.

  {
    return Arrangement;
  }

ndim()

template<MemArrange Arrangement, typename IndexType >

static constexpr dim_t dash::CSRPattern< 1, Arrangement, IndexType >::ndim ( )

inlinestatic

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

Definition at line 1129 of file CSRPattern.h.

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

  {
    return 1;
  }

num_units()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, 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 1018 of file CSRPattern.h.

  {
    return _nunits;
  }

operator!=()

template<MemArrange Arrangement, typename IndexType >

constexpr bool dash::CSRPattern< 1, Arrangement, IndexType >::operator!= ( const self_t &  other ) const

inlinenoexcept

Inquality comparison operator.

Parameters

other

Pattern instance to compare for inequality

Definition at line 438 of file CSRPattern.h.

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

operator=() [1/2]

template<MemArrange Arrangement, typename IndexType >

self_t& dash::CSRPattern< 1, Arrangement, IndexType >::operator= ( const self_t &  other )

default

Assignment operator.

operator=() [2/2]

template<MemArrange Arrangement, typename IndexType >

self_t& dash::CSRPattern< 1, Arrangement, IndexType >::operator= ( self_t &&  other )

default

Move-assignment operator.

operator==()

template<MemArrange Arrangement, typename IndexType >

constexpr bool dash::CSRPattern< 1, Arrangement, IndexType >::operator== ( const self_t &  other ) const

inlinenoexcept

Equality comparison operator.

Parameters

other

Pattern instance to compare for equality

Definition at line 420 of file CSRPattern.h.

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

size()

template<MemArrange Arrangement, typename IndexType >

constexpr IndexType dash::CSRPattern< 1, Arrangement, IndexType >::size ( ) const

inlinenoexcept

The number of elements arranged in this pattern.

See also

Pattern Concept

Definition at line 1038 of file CSRPattern.h.

  {
    return _size;
  }

sizespec()

template<MemArrange Arrangement, typename IndexType >

constexpr SizeSpec_t dash::CSRPattern< 1, Arrangement, IndexType >::sizespec ( ) const

inlinenoexcept

Size specification of the index space mapped by this pattern.

See also

Pattern Concept

Definition at line 1065 of file CSRPattern.h.

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

team()

template<MemArrange Arrangement, typename IndexType >

constexpr dash::Team& dash::CSRPattern< 1, Arrangement, IndexType >::team ( ) const

inlinenoexcept

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

Definition at line 1047 of file CSRPattern.h.

  {
    return *_team;
  }

teamspec()

template<MemArrange Arrangement, typename IndexType >

constexpr const TeamSpec_t& dash::CSRPattern< 1, 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 1087 of file CSRPattern.h.

  {
    return _teamspec;
  }

unit_at() [1/4]

template<MemArrange Arrangement, typename IndexType >

constexpr team_unit_t dash::CSRPattern< 1, 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 474 of file CSRPattern.h.

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

unit_at() [2/4]

template<MemArrange Arrangement, typename IndexType >

constexpr team_unit_t dash::CSRPattern< 1, 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 488 of file CSRPattern.h.

  {
    return unit_at(g_coords[0]);
  }

unit_at() [3/4]

template<MemArrange Arrangement, typename IndexType >

constexpr team_unit_t dash::CSRPattern< 1, 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 499 of file CSRPattern.h.

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

unit_at() [4/4]

template<MemArrange Arrangement, typename IndexType >

team_unit_t dash::CSRPattern< 1, 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 513 of file CSRPattern.h.

  {
    DASH_LOG_TRACE_VAR("CSRPattern.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("CSRPattern.unit_at >", unit_idx);
        return unit_idx;
      }
      g_index -= _local_sizes[unit_idx];
    }
    DASH_THROW(
      dash::exception::InvalidArgument,
      "CSRPattern.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/CSRPattern.h