dash::ViewSpec< NumDimensions, IndexType > Class Template Reference

Specifies view parameters for implementing submat, rows and cols. More...

#include <Dimensional.h>

Public Types
typedef ViewRegion< NumDimensions, IndexType >	region_type
typedef ViewRange< IndexType >	range_type
using	index_type = IndexType
using	size_type = SizeType

Public Member Functions
	ViewSpec ()
	Default constructor, initialize with extent and offset 0 in all dimensions. More...
	ViewSpec (const std::array< SizeType, NumDimensions > &extents)
	Constructor, initialize with given extents and offset 0 in all dimensions. More...
	ViewSpec (const std::array< IndexType, NumDimensions > &offsets, const std::array< SizeType, NumDimensions > &extents)
	Constructor, initialize with given extents and offsets. More...
constexpr	ViewSpec (const self_t &other)=default
	Copy constructor. More...
constexpr	ViewSpec (self_t &&other)=default
	Move constructor. 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
	Equality comparison operator. More...
constexpr bool	operator!= (const self_t &other) const
	Equality comparison operator. More...
template<typename ... Args>
void	resize (SizeType arg, Args... args)
	Change the view specification's extent in every dimension. More...
void	resize (const std::array< ViewPair_t, NumDimensions > &view)
	Change the view specification's extent and offset in every dimension. More...
template<typename SizeType_ >
void	resize (const std::array< SizeType_, NumDimensions > &extents)
	Change the view specification's extent in every dimension. More...
void	resize_dim (dim_t dimension, IndexType offset, SizeType extent)
	Change the view specification's extent and offset in the given dimension. More...
ViewSpec< NumDimensions-1, IndexType >	slice (dim_t dimension)
	Slice the view in the specified dimension at the given offset. More...
void	set_rank (dim_t dimensions)
	Set rank of the view spec to a dimensionality between 1 and NumDimensions. More...
constexpr SizeType	size () const
constexpr SizeType	size (dim_t dimension) const
constexpr const std::array< SizeType, NumDimensions > &	extents () const
constexpr SizeType	extent (dim_t dim) const
constexpr const std::array< IndexType, NumDimensions > &	offsets () const
constexpr range_type	range (dim_t dim) const
constexpr IndexType	offset (dim_t dim) const
region_type	region () const

Static Public Member Functions
static constexpr auto	ndim ()

Friends
template<dim_t NDim_, typename IndexType_ >
std::ostream &	operator<< (std::ostream &os, const ViewSpec< NDim_, IndexType_ > &viewspec)

Detailed Description

template<dim_t NumDimensions, typename IndexType = dash::default_index_t>
class dash::ViewSpec< NumDimensions, IndexType >

Specifies view parameters for implementing submat, rows and cols.

(DashCartesianSpaceConcept)

Definition at line 430 of file Dimensional.h.

Constructor & Destructor Documentation

ViewSpec() [1/5]

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

dash::ViewSpec< NumDimensions, IndexType >::ViewSpec ( )

inline

Default constructor, initialize with extent and offset 0 in all dimensions.

Definition at line 464 of file Dimensional.h.

  : _size(0),
    _rank(NumDimensions)
  {
    for (dim_t i = 0; i < NumDimensions; i++) {
      _extents[i] = 0;
      _offsets[i] = 0;
    }
  }

ViewSpec() [2/5]

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

dash::ViewSpec< NumDimensions, IndexType >::ViewSpec ( const std::array< SizeType, NumDimensions > &  extents )

inline

Constructor, initialize with given extents and offset 0 in all dimensions.

Definition at line 478 of file Dimensional.h.

  : _size(1),
    _rank(NumDimensions),
    _extents(extents)
  {
    for (auto i = 0; i < NumDimensions; ++i) {
      _offsets[i] = 0;
      _size      *= _extents[i];
    }
  }

ViewSpec() [3/5]

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

dash::ViewSpec< NumDimensions, IndexType >::ViewSpec ( const std::array< IndexType, NumDimensions > &  offsets, const std::array< SizeType, NumDimensions > &  extents  )

inline

Constructor, initialize with given extents and offsets.

Definition at line 493 of file Dimensional.h.

  : _size(1),
    _rank(NumDimensions),
    _extents(extents),
    _offsets(offsets)
  {
    for (auto i = 0; i < NumDimensions; ++i) {
      _size *= _extents[i];
    }
  }

ViewSpec() [4/5]

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

constexpr dash::ViewSpec< NumDimensions, IndexType >::ViewSpec ( const self_t &  other )

default

Copy constructor.

ViewSpec() [5/5]

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

constexpr dash::ViewSpec< NumDimensions, IndexType >::ViewSpec ( self_t &&  other )

default

Move constructor.

Member Function Documentation

operator!=()

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

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

inline

Equality comparison operator.

Definition at line 541 of file Dimensional.h.

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

operator=() [1/2]

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

self_t& dash::ViewSpec< NumDimensions, IndexType >::operator= ( const self_t &  other )

default

Assignment operator.

operator=() [2/2]

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

self_t& dash::ViewSpec< NumDimensions, IndexType >::operator= ( self_t &&  other )

default

Move-assignment operator.

operator==()

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

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

inline

Equality comparison operator.

Definition at line 531 of file Dimensional.h.

  {
    return (_extents == other._extents &&
            _offsets == other._offsets &&
            _rank    == other._rank);
  }

resize() [1/3]

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

template<typename ... Args>

void dash::ViewSpec< NumDimensions, IndexType >::resize ( SizeType  arg, Args...  args  )

inline

Change the view specification's extent in every dimension.

Definition at line 550 of file Dimensional.h.

  {
    static_assert(
      sizeof...(Args) == (NumDimensions-1),
      "Invalid number of arguments");
    std::array<SizeType, NumDimensions> extents =
      { arg, (SizeType)(args)... };
    resize(extents);
  }

resize() [2/3]

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

void dash::ViewSpec< NumDimensions, IndexType >::resize ( const std::array< ViewPair_t, NumDimensions > &  view )

inline

Change the view specification's extent and offset in every dimension.

Definition at line 563 of file Dimensional.h.

  {
    _rank = NumDimensions;
    for (dim_t i = 0; i < NumDimensions; i++) {
      _offsets[i] = view[i].offset;
      _extents[i] = view[i].extent;
    }
    update_size();
  }

resize() [3/3]

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

template<typename SizeType_ >

void dash::ViewSpec< NumDimensions, IndexType >::resize ( const std::array< SizeType_, NumDimensions > &  extents )

inline

Change the view specification's extent in every dimension.

Definition at line 577 of file Dimensional.h.

  {
    _rank = NumDimensions;
    for (dim_t i = 0; i < NumDimensions; i++) {
      _extents[i] = extents[i];
    }
    update_size();
  }

resize_dim()

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

void dash::ViewSpec< NumDimensions, IndexType >::resize_dim ( dim_t  dimension, IndexType  offset, SizeType  extent  )

inline

Change the view specification's extent and offset in the given dimension.

Definition at line 590 of file Dimensional.h.

  {
    _offsets[dimension] = offset;
    _extents[dimension] = extent;
    update_size();
  }

set_rank()

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

void dash::ViewSpec< NumDimensions, IndexType >::set_rank ( dim_t  dimensions )

inline

Set rank of the view spec to a dimensionality between 1 and NumDimensions.

Definition at line 643 of file Dimensional.h.

  {
    DASH_ASSERT_LT(
      dimensions, NumDimensions+1,
      "Maximum dimension for ViewSpec::set_rank is " << NumDimensions);
    _rank = dimensions;
    update_size();
  }

slice()

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

ViewSpec<NumDimensions-1, IndexType> dash::ViewSpec< NumDimensions, IndexType >::slice ( dim_t  dimension )

inline

Slice the view in the specified dimension at the given offset.

This is different from resizing the dimension to extent 1 (resize_dim) which does not affect the view dimensionality or rank. Slicing removes the specified dimension and reduces the view dimensionality by 1.

All dimensions higher than the sliced dimension are projected downwards. Example:

dimensions: 0 1 2 3 : : : : extents: 3 4 5 6 | slice_dim(1, 2) | v dimensions: 0 x 1 2 : : : extents: 3 5 6

Returns

A copy if this view spec as a new instance of ViewSpec<NDim-1> with the sliced dimension removed

Definition at line 627 of file Dimensional.h.

  {
    std::array<SizeType, NumDimensions-1>  slice_extents;
    std::array<IndexType, NumDimensions-1> slice_offsets;
    for (dim_t d = dimension; d < _rank-1; d++) {
      slice_offsets[d] = _offsets[d+1];
      slice_extents[d] = _extents[d+1];
    }
    return ViewSpec<NumDimensions-1, IndexType>(slice_offsets,
                                                slice_extents);
  }

---

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

• /tmp/tmporruphar/dash/include/dash/Dimensional.h