yakl::Dims Class Reference

This class holds C-style dimensions for using in yakl::Array objects. More...

#include <YAKL_Array.h>

Public Member Functions
YAKL_INLINE	Dims ()
template<class INT , unsigned int RANK, typename std::enable_if< std::is_integral< INT >::value, bool >::type = false>
	Dims (CSArray< INT, 1, RANK > const dims)
	This constructor allows converting a CSArray object to a yakl::Dims object. More...
YAKL_INLINE	Dims (Dims &&dims)
YAKL_INLINE	Dims (Dims const &dims)
YAKL_INLINE	Dims (int i0)
	Construct a 1-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1)
	Construct a 2-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2)
	Construct a 3-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2, int i3)
	Construct a 4-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2, int i3, int i4)
	Construct a 5-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2, int i3, int i4, int i5)
	Construct a 6-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2, int i3, int i4, int i5, int i6)
	Construct a 7-D Dims object) More...
YAKL_INLINE	Dims (int i0, int i1, int i2, int i3, int i4, int i5, int i6, int i7)
	Construct an 8-D Dims object) More...
template<class INT , typename std::enable_if< std::is_integral< INT >::value, bool >::type = false>
	Dims (std::vector< INT > const dims)
	This constructor allows converting a std::vector or initializer list to a yakl::Dims object. More...
YAKL_INLINE Dims &	operator= (Dims &&dims)
YAKL_INLINE Dims &	operator= (Dims const &dims)
YAKL_INLINE int	operator[] (int i) const
	These objects are always indexed with square bracket notation like a std::vector or std::array. More...
YAKL_INLINE int	size () const
	Get the number of dimensions. More...

Detailed Description

This class holds C-style dimensions for using in yakl::Array objects.

You can pass an initializer list {...} or std::vector as a parameter to this type, and it can be converted to a yakl::Dims object.

Constructor & Destructor Documentation

Dims() [1/13]

YAKL_INLINE yakl::Dims::Dims ( )

inline

Dims() [2/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0 )

inline

Construct a 1-D Dims object)

Dims() [3/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1  )

inline

Construct a 2-D Dims object)

Dims() [4/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2  )

inline

Construct a 3-D Dims object)

Dims() [5/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2, int  i3  )

inline

Construct a 4-D Dims object)

Dims() [6/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2, int  i3, int  i4  )

inline

Construct a 5-D Dims object)

Dims() [7/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2, int  i3, int  i4, int  i5  )

inline

Construct a 6-D Dims object)

Dims() [8/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2, int  i3, int  i4, int  i5, int  i6  )

inline

Construct a 7-D Dims object)

Dims() [9/13]

YAKL_INLINE yakl::Dims::Dims ( int  i0, int  i1, int  i2, int  i3, int  i4, int  i5, int  i6, int  i7  )

inline

Construct an 8-D Dims object)

Dims() [10/13]

YAKL_INLINE yakl::Dims::Dims ( Dims const &  dims )

inline

Dims() [11/13]

YAKL_INLINE yakl::Dims::Dims ( Dims &&  dims )

inline

Dims() [12/13]

template<class INT , typename std::enable_if< std::is_integral< INT >::value, bool >::type = false>

yakl::Dims::Dims ( std::vector< INT > const  dims )

inline

This constructor allows converting a std::vector or initializer list to a yakl::Dims object.

Dims() [13/13]

template<class INT , unsigned int RANK, typename std::enable_if< std::is_integral< INT >::value, bool >::type = false>

yakl::Dims::Dims ( CSArray< INT, 1, RANK > const  dims )

inline

This constructor allows converting a CSArray object to a yakl::Dims object.

Member Function Documentation

operator=() [1/2]

YAKL_INLINE Dims& yakl::Dims::operator= ( Dims &&  dims )

inline

operator=() [2/2]

YAKL_INLINE Dims& yakl::Dims::operator= ( Dims const &  dims )

inline

operator[]()

YAKL_INLINE int yakl::Dims::operator[] ( int  i ) const

inline

These objects are always indexed with square bracket notation like a std::vector or std::array.

size()

YAKL_INLINE int yakl::Dims::size ( ) const

inline

Get the number of dimensions.

---

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

• YAKL/src/YAKL_Array.h