Eigen  3.3.90 (mercurial changeset b6d3e557dd16)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::ArithmeticSequence< FirstType, SizeType, IncrType > Class Template Reference

Detailed Description

template<typename FirstType = Index, typename SizeType = Index, typename IncrType = internal::FixedInt<1>>
class Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >

This class represents an arithmetic progression $ a_0, a_1, a_2, ..., a_{n-1}$ defined by its first value $ a_0 $, its size (aka length) n, and the increment (aka stride) that is equal to $ a_{i+1}-a_{i}$ for any i.

It is internally used as the return type of the Eigen::seq and Eigen::seqN functions, and as the input arguments of DenseBase::operator()(const RowIndices&, const ColIndices&), and most of the time this is the only way it is used.

Template Parameters
FirstTypetype of the first element, usually an Index, but internally it can be a symbolic expression
SizeTypetype representing the size of the sequence, usually an Index or a compile time integral constant. Internally, it can also be a symbolic expression
IncrTypetype of the increment, can be a runtime Index, or a compile time integral constant (default is compile-time 1)
See Also
Eigen::seq, Eigen::seqN, DenseBase::operator()(const RowIndices&, const ColIndices&), class IndexedView

Public Member Functions

Index first () const
 
Index operator[] (Index i) const
 
Index size () const
 

Member Function Documentation

template<typename FirstType = Index, typename SizeType = Index, typename IncrType = internal::FixedInt<1>>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::first ( ) const
inline
Returns
the first element $ a_0 $ in the sequence
template<typename FirstType = Index, typename SizeType = Index, typename IncrType = internal::FixedInt<1>>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::operator[] ( Index  i) const
inline
Returns
the value $ a_i $ at index i in the sequence.
template<typename FirstType = Index, typename SizeType = Index, typename IncrType = internal::FixedInt<1>>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::size ( ) const
inline
Returns
the size, i.e., number of elements, of the sequence

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