Eigen::ArithmeticSequence Class Reference

#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

This class represents an arithmetic progression defined by its first value , its size (aka length) n, and the increment (aka stride) that is equal to 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

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)

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

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

protected

Definition at line 148 of file ArithmeticSequence.h.

ReverseIncrType

typedef internal::aseq_negate<IncrType>::type Eigen::ArithmeticSequence::ReverseIncrType

protected

Definition at line 147 of file ArithmeticSequence.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SizeAtCompileTime
IncrAtCompileTime

Definition at line 116 of file ArithmeticSequence.h.

Constructor & Destructor Documentation

ArithmeticSequence() [1/2]

Eigen::ArithmeticSequence::ArithmeticSequence ( FirstType  first, SizeType  size  )

inline

Definition at line 113 of file ArithmeticSequence.h.

ArithmeticSequence() [2/2]

Eigen::ArithmeticSequence::ArithmeticSequence ( FirstType  first, SizeType  size, IncrType  incr  )

inline

Definition at line 114 of file ArithmeticSequence.h.

Member Function Documentation

first()

Index Eigen::ArithmeticSequence::first ( ) const

inline

Returns

the first element in the sequence

Definition at line 125 of file ArithmeticSequence.h.

firstObject()

const FirstType& Eigen::ArithmeticSequence::firstObject ( ) const

inline

Definition at line 130 of file ArithmeticSequence.h.

incrObject()

const IncrType& Eigen::ArithmeticSequence::incrObject ( ) const

inline

Definition at line 132 of file ArithmeticSequence.h.

operator[]()

Index Eigen::ArithmeticSequence::operator[] ( Index  i ) const

inline

Returns

the value at index i in the sequence.

Definition at line 128 of file ArithmeticSequence.h.

reverse()

ArithmeticSequence<ReverseFirstType,SizeType,ReverseIncrType> Eigen::ArithmeticSequence::reverse ( ) const

inline

Definition at line 151 of file ArithmeticSequence.h.

size()

Index Eigen::ArithmeticSequence::size ( ) const

inline

Returns

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

Definition at line 122 of file ArithmeticSequence.h.

sizeObject()

const SizeType& Eigen::ArithmeticSequence::sizeObject ( ) const

inline

Definition at line 131 of file ArithmeticSequence.h.

Member Data Documentation

m_first

FirstType Eigen::ArithmeticSequence::m_first

protected

Definition at line 135 of file ArithmeticSequence.h.

m_incr

IncrType Eigen::ArithmeticSequence::m_incr

protected

Definition at line 137 of file ArithmeticSequence.h.

m_size

SizeType Eigen::ArithmeticSequence::m_size

protected

Definition at line 136 of file ArithmeticSequence.h.

---

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

• ArithmeticSequence.h