Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
Eigen::ArithmeticSequence< FirstType, SizeType, IncrType > Class Template Reference
Dense matrix and array manipulation » Reference » Core_Module

#include <ArithmeticSequence.h>

Public Types

enum  { SizeAtCompileTime = internal::get_fixed_value<SizeType>::value, IncrAtCompileTime = internal::get_fixed_value<IncrType,DynamicIndex>::value }
 

Public Member Functions

 ArithmeticSequence (FirstType first, SizeType size)
 
 ArithmeticSequence (FirstType first, SizeType size, IncrType incr)
 
Index first () const
 
const FirstType & firstObject () const
 
const IncrType & incrObject () const
 
Index operator[] (Index i) const
 
ArithmeticSequence< ReverseFirstType, SizeType, ReverseIncrType > reverse () const
 
Index size () const
 
const SizeType & sizeObject () const
 

Protected Types

typedef internal::aseq_reverse_first_type< FirstType, SizeType, IncrType >::type ReverseFirstType
 
typedef internal::aseq_negate< IncrType >::type ReverseIncrType
 

Protected Attributes

FirstType m_first
 
IncrType m_incr
 
SizeType m_size
 

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

Definition at line 82 of file ArithmeticSequence.h.

Member Typedef Documentation

◆ ReverseFirstType

template<typename FirstType, typename SizeType, typename IncrType>
typedef internal::aseq_reverse_first_type<FirstType,SizeType,IncrType>::type Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::ReverseFirstType
protected

Definition at line 148 of file ArithmeticSequence.h.

◆ ReverseIncrType

template<typename FirstType, typename SizeType, typename IncrType>
typedef internal::aseq_negate<IncrType>::type Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::ReverseIncrType
protected

Definition at line 147 of file ArithmeticSequence.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename FirstType, typename SizeType, typename IncrType>
anonymous enum
Enumerator
SizeAtCompileTime 
IncrAtCompileTime 

Definition at line 116 of file ArithmeticSequence.h.

Constructor & Destructor Documentation

◆ ArithmeticSequence() [1/2]

template<typename FirstType, typename SizeType, typename IncrType>
Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::ArithmeticSequence ( FirstType  first,
SizeType  size 
)
inline

Definition at line 113 of file ArithmeticSequence.h.

◆ ArithmeticSequence() [2/2]

template<typename FirstType, typename SizeType, typename IncrType>
Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::ArithmeticSequence ( FirstType  first,
SizeType  size,
IncrType  incr 
)
inline

Definition at line 114 of file ArithmeticSequence.h.

Member Function Documentation

◆ first()

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

Definition at line 125 of file ArithmeticSequence.h.

◆ firstObject()

template<typename FirstType, typename SizeType, typename IncrType>
const FirstType& Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::firstObject ( ) const
inline

Definition at line 130 of file ArithmeticSequence.h.

◆ incrObject()

template<typename FirstType, typename SizeType, typename IncrType>
const IncrType& Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::incrObject ( ) const
inline

Definition at line 132 of file ArithmeticSequence.h.

◆ operator[]()

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

Definition at line 128 of file ArithmeticSequence.h.

◆ reverse()

template<typename FirstType, typename SizeType, typename IncrType>
ArithmeticSequence<ReverseFirstType,SizeType,ReverseIncrType> Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::reverse ( ) const
inline

Definition at line 151 of file ArithmeticSequence.h.

◆ size()

template<typename FirstType, typename SizeType, typename IncrType>
Index Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::size ( ) const
inline
Returns
the size, i.e., number of elements, of the sequence

Definition at line 122 of file ArithmeticSequence.h.

◆ sizeObject()

template<typename FirstType, typename SizeType, typename IncrType>
const SizeType& Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::sizeObject ( ) const
inline

Definition at line 131 of file ArithmeticSequence.h.

Member Data Documentation

◆ m_first

template<typename FirstType, typename SizeType, typename IncrType>
FirstType Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::m_first
protected

Definition at line 135 of file ArithmeticSequence.h.

◆ m_incr

template<typename FirstType, typename SizeType, typename IncrType>
IncrType Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::m_incr
protected

Definition at line 137 of file ArithmeticSequence.h.

◆ m_size

template<typename FirstType, typename SizeType, typename IncrType>
SizeType Eigen::ArithmeticSequence< FirstType, SizeType, IncrType >::m_size
protected

Definition at line 136 of file ArithmeticSequence.h.

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

gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:11