util::TensorIndices< 1U > Class Template Reference

#include <TensorIndices.h>

Public Types
using	Index_t = TensorIndicesBasicTypes::Index_t
using	DimSize_t = TensorIndicesBasicTypes::DimSize_t
using	LinIndex_t = TensorIndicesBasicTypes::LinIndex_t

Public Member Functions
	TensorIndices (DimSize_t dim)
template<typename ITER , typename = std::enable_if_t <std::is_convertible<decltype(*(ITER())), DimSize_t>::value, void>>
	TensorIndices (ITER dimIter)
LinIndex_t	operator() (Index_t index) const
template<typename ITER >
std::enable_if_t < std::is_convertible < decltype(*(ITER())), DimSize_t >::value, LinIndex_t >	operator() (ITER indexIter) const
LinIndex_t	at (Index_t index) const
template<typename ITER >
std::enable_if_t < std::is_convertible < decltype(*(ITER())), DimSize_t >::value, LinIndex_t >	at (ITER indexIter) const
bool	has (Index_t index) const
template<typename ITER >
std::enable_if_t < std::is_convertible < decltype(*(ITER())), DimSize_t >::value, bool >	has (ITER indexIter) const
template<unsigned int DIM = 0>
DimSize_t	size () const
template<unsigned int DIM>
DimSize_t	dim () const
template<unsigned int DIM>
bool	hasIndex (Index_t index) const
bool	hasLinIndex (LinIndex_t linIndex) const
bool	operator== (TensorIndices< 1U > const &t) const
bool	operator!= (TensorIndices< 1U > const &t) const

Static Public Member Functions
static constexpr unsigned int	rank ()

Protected Member Functions
Index_t	checkOuterIndex (Index_t index) const
DimSize_t	dim0 () const
	Returns the size of the outer dimension. More...

Private Member Functions
DimSize_t	totalSize () const
	Returns the total size of this tensor. More...

Private Attributes
DimSize_t	dimSize
	size of the largest dimension More...

Friends
template<unsigned int R, unsigned int D>
struct	details::ExtractTensorDimension

Detailed Description

template<>
class util::TensorIndices< 1U >

Specialisation for vector index (rank 1).

Documentation is in the general template. No public methods are added respect to it (but the minor() method is removed).

Definition at line 63 of file TensorIndices.h.

Member Typedef Documentation

using util::TensorIndices< 1U >::DimSize_t = TensorIndicesBasicTypes::DimSize_t

Definition at line 68 of file TensorIndices.h.

using util::TensorIndices< 1U >::Index_t = TensorIndicesBasicTypes::Index_t

Definition at line 66 of file TensorIndices.h.

using util::TensorIndices< 1U >::LinIndex_t = TensorIndicesBasicTypes::LinIndex_t

Definition at line 70 of file TensorIndices.h.

Constructor & Destructor Documentation

util::TensorIndices< 1U >::TensorIndices ( DimSize_t  dim )

inline

Definition at line 75 of file TensorIndices.h.

: dimSize(dim) {}

template<typename ITER , typename = std::enable_if_t <std::is_convertible<decltype(*(ITER())), DimSize_t>::value, void>>

util::TensorIndices< 1U >::TensorIndices ( ITER  dimIter )

inline

Definition at line 82 of file TensorIndices.h.

: TensorIndices(*dimIter) {}

Member Function Documentation

LinIndex_t util::TensorIndices< 1U >::at ( Index_t  index ) const

inline

Definition at line 92 of file TensorIndices.h.

{ return checkOuterIndex(index); }

template<typename ITER >

std::enable_if_t<std::is_convertible<decltype(*(ITER())), DimSize_t>::value, LinIndex_t> util::TensorIndices< 1U >::at ( ITER  indexIter ) const

inline

Definition at line 97 of file TensorIndices.h.

      { return checkOuterIndex(*indexIter); }

Index_t util::TensorIndices< 1U >::checkOuterIndex ( Index_t  index ) const

inlineprotected

Definition at line 136 of file TensorIndices.h.

      {
        if (has(index)) return index; // good
        throw std::out_of_range("Requested index " + std::to_string(index)
          + " for a dimension of size " + std::to_string(size()));
      }

template<unsigned int DIM>

DimSize_t util::TensorIndices< 1U >::dim ( ) const

inline

Definition at line 114 of file TensorIndices.h.

      {
        static_assert(DIM == 0, "Invalid dimension requested");
        return dimSize;
      } // dim()

DimSize_t util::TensorIndices< 1U >::dim0 ( ) const

inlineprotected

Returns the size of the outer dimension.

Definition at line 145 of file TensorIndices.h.

{ return dimSize; }

bool util::TensorIndices< 1U >::has ( Index_t  index ) const

inline

Definition at line 100 of file TensorIndices.h.

      { return (index >= 0) && ((DimSize_t) index < size()); }

template<typename ITER >

std::enable_if_t<std::is_convertible<decltype(*(ITER())), DimSize_t>::value, bool> util::TensorIndices< 1U >::has ( ITER  indexIter ) const

inline

Definition at line 106 of file TensorIndices.h.

      { return (*indexIter >= 0) && ((DimSize_t) *indexIter < size()); }

template<unsigned int DIM>

bool util::TensorIndices< 1U >::hasIndex ( Index_t  index ) const

inline

Definition at line 121 of file TensorIndices.h.

      {
        static_assert(DIM == 0, "Invalid dimension requested");
        return has(index);
      }

bool util::TensorIndices< 1U >::hasLinIndex ( LinIndex_t  linIndex ) const

inline

Definition at line 127 of file TensorIndices.h.

      { return has((Index_t) linIndex); }

bool util::TensorIndices< 1U >::operator!= ( TensorIndices< 1U > const &  t ) const

inline

Definition at line 132 of file TensorIndices.h.

      { return t.size() != size(); }

LinIndex_t util::TensorIndices< 1U >::operator() ( Index_t  index ) const

inline

Definition at line 85 of file TensorIndices.h.

{ return index; }

template<typename ITER >

std::enable_if_t<std::is_convertible<decltype(*(ITER())), DimSize_t>::value, LinIndex_t> util::TensorIndices< 1U >::operator() ( ITER  indexIter ) const

inline

Definition at line 90 of file TensorIndices.h.

{ return *indexIter; }

bool util::TensorIndices< 1U >::operator== ( TensorIndices< 1U > const &  t ) const

inline

Definition at line 130 of file TensorIndices.h.

      { return t.size() == size(); }

static constexpr unsigned int util::TensorIndices< 1U >::rank ( )

inlinestatic

Definition at line 72 of file TensorIndices.h.

{ return 1U; }

template<unsigned int DIM = 0>

DimSize_t util::TensorIndices< 1U >::size ( ) const

inline

Definition at line 111 of file TensorIndices.h.

{ return (DIM == 0)? totalSize(): dim<DIM>(); }

DimSize_t util::TensorIndices< 1U >::totalSize ( ) const

inlineprivate

Returns the total size of this tensor.

Definition at line 154 of file TensorIndices.h.

{ return dim0(); }

Friends And Related Function Documentation

template<unsigned int R, unsigned int D>

friend struct details::ExtractTensorDimension

friend

Definition at line 149 of file TensorIndices.h.

Member Data Documentation

DimSize_t util::TensorIndices< 1U >::dimSize

private

size of the largest dimension

Definition at line 151 of file TensorIndices.h.

---

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

• TensorIndices.h