Eigen::Sizes< Indices > Struct Template Reference

#include <TensorDimensions.h>

Public Types
typedef internal::numeric_list< std::ptrdiff_t, Indices... >	Base

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t	rank () const
EIGEN_DEVICE_FUNC	Sizes ()
template<typename DenseIndex >
EIGEN_DEVICE_FUNC	Sizes (const array< DenseIndex, Base::count > &)
template<typename... DenseIndex>
EIGEN_DEVICE_FUNC	Sizes (DenseIndex...)
EIGEN_DEVICE_FUNC	Sizes (std::initializer_list< std::ptrdiff_t >)
template<typename T >
Sizes &	operator= (const T &)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t	operator[] (const std::ptrdiff_t index) const
template<typename DenseIndex >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ptrdiff_t	IndexOfColMajor (const array< DenseIndex, Base::count > &indices) const
template<typename DenseIndex >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ptrdiff_t	IndexOfRowMajor (const array< DenseIndex, Base::count > &indices) const

Static Public Member Functions
static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t	TotalSize ()

Public Attributes
const Base	t = Base()

Static Public Attributes
static const std::ptrdiff_t	total_size = internal::arg_prod(Indices...)
static const ptrdiff_t	count = Base::count

Member Typedef Documentation

Base

template<typename std::ptrdiff_t... Indices>

typedef internal::numeric_list<std::ptrdiff_t, Indices...> Eigen::Sizes< Indices >::Base

Constructor & Destructor Documentation

Sizes() [1/4]

template<typename std::ptrdiff_t... Indices>

EIGEN_DEVICE_FUNC Eigen::Sizes< Indices >::Sizes ( )

inline

{}

Sizes() [2/4]

template<typename std::ptrdiff_t... Indices>

template<typename DenseIndex >

EIGEN_DEVICE_FUNC Eigen::Sizes< Indices >::Sizes ( const array< DenseIndex, Base::count > &  )

inlineexplicit

                                                                          {
    // todo: add assertion
  }

Sizes() [3/4]

template<typename std::ptrdiff_t... Indices>

template<typename... DenseIndex>

EIGEN_DEVICE_FUNC Eigen::Sizes< Indices >::Sizes ( DenseIndex...  )

inline

{}

Sizes() [4/4]

template<typename std::ptrdiff_t... Indices>

EIGEN_DEVICE_FUNC Eigen::Sizes< Indices >::Sizes ( std::initializer_list< std::ptrdiff_t >  )

inlineexplicit

                                                                        {
    // todo: add assertion
  }

Member Function Documentation

IndexOfColMajor()

template<typename std::ptrdiff_t... Indices>

template<typename DenseIndex >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ptrdiff_t Eigen::Sizes< Indices >::IndexOfColMajor ( const array< DenseIndex, Base::count > &  indices ) const

inline

                                                                                                                     {
    return internal::fixed_size_tensor_index_linearization_helper<DenseIndex, Base::count, Base::count, false>::run(
        indices, t);
  }

References Eigen::internal::fixed_size_tensor_index_linearization_helper< Index, NumIndices, n, RowMajor >::run(), and Eigen::Sizes< Indices >::t.

IndexOfRowMajor()

template<typename std::ptrdiff_t... Indices>

template<typename DenseIndex >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ptrdiff_t Eigen::Sizes< Indices >::IndexOfRowMajor ( const array< DenseIndex, Base::count > &  indices ) const

inline

                                                                                                                     {
    return internal::fixed_size_tensor_index_linearization_helper<DenseIndex, Base::count, Base::count, true>::run(
        indices, t);
  }

References Eigen::internal::fixed_size_tensor_index_linearization_helper< Index, NumIndices, n, RowMajor >::run(), and Eigen::Sizes< Indices >::t.

operator=()

template<typename std::ptrdiff_t... Indices>

template<typename T >

Sizes& Eigen::Sizes< Indices >::operator= ( const T &  )

inline

                               {
    // add assertion failure if the size of other is different
    return *this;
  }

operator[]()

template<typename std::ptrdiff_t... Indices>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t Eigen::Sizes< Indices >::operator[] ( const std::ptrdiff_t  index ) const

inline

                                                                                                {
    return internal::fixed_size_tensor_index_extraction_helper<std::ptrdiff_t, Base::count>::run(index, t);
  }

References Eigen::internal::fixed_size_tensor_index_extraction_helper< Index, n >::run(), and Eigen::Sizes< Indices >::t.

rank()

template<typename std::ptrdiff_t... Indices>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t Eigen::Sizes< Indices >::rank ( ) const

inline

{ return Base::count; }

References Eigen::internal::numeric_list< T, nn >::count.

Referenced by test_rank_zero().

TotalSize()

template<typename std::ptrdiff_t... Indices>

static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE std::ptrdiff_t Eigen::Sizes< Indices >::TotalSize ( )

inlinestatic

{ return internal::arg_prod(Indices...); }

References Eigen::internal::arg_prod.

Referenced by test_fixed_size(), and test_rank_zero().

Member Data Documentation

count

template<typename std::ptrdiff_t... Indices>

const ptrdiff_t Eigen::Sizes< Indices >::count = Base::count

static

t

template<typename std::ptrdiff_t... Indices>

const Base Eigen::Sizes< Indices >::t = Base()

Referenced by Eigen::Sizes< Indices >::IndexOfColMajor(), Eigen::Sizes< Indices >::IndexOfRowMajor(), and Eigen::Sizes< Indices >::operator[]().

total_size

template<typename std::ptrdiff_t... Indices>

const std::ptrdiff_t Eigen::Sizes< Indices >::total_size = internal::arg_prod(Indices...)

static

---

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

• TensorDimensions.h