template<typename FirstType, typename SizeType, typename IncrType>
Eigen::ArithmeticSequence class

Template parameters
FirstType type of the first element, usually an Index, but internally it can be a symbolic expression
SizeType type representing the size of the sequence, usually an Index or a compile time integral constant. Internally, it can also be a symbolic expression
IncrType type of the increment, can be a runtime Index, or a compile time integral constant (default is compile-time 1)

Contents

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.

Public functions

auto first() const -> Index
auto operator[](Index i) const -> Index
auto size() const -> Index

Function documentation

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence<FirstType, SizeType, IncrType>::first() const

Returns the first element $ a_0 $ in the sequence

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence<FirstType, SizeType, IncrType>::operator[](Index i) const

Returns the value $ a_i $ at index i in the sequence.

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence<FirstType, SizeType, IncrType>::size() const

Returns the size, i.e., number of elements, of the sequence