Eigen  3.4.90 (git rev 9589cc4e7fd8e4538bedef80dd36c7738977a8be)
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Eigen::ArithmeticSequence< FirstType, SizeType, IncrType > Class Template Reference
Dense matrix and array manipulation » Reference » Core module

#include <Eigen/src/Core/ArithmeticSequence.h>

Detailed Description

template<typename FirstType, typename SizeType, typename IncrType>
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

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

Member Function Documentation

◆ first()

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::first ( ) const
inlineconstexpr
Returns
the first element $ a_0 $ in the sequence

◆ operator[]()

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::operator[] ( Index i) const
inlineconstexpr
Returns
the value $ a_i $ at index i in the sequence.

◆ size()

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::size ( ) const
inlineconstexpr
Returns
the size, i.e., number of elements, of the sequence
The documentation for this class was generated from the following files: