Eigen::internal::AmbiVector< _Scalar, _StorageIndex > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/AmbiVector.h>

Classes
class	Iterator
	Iterator over the nonzero coefficients. More...
struct	ListEl

Public Types
typedef _Scalar	Scalar
typedef _StorageIndex	StorageIndex
typedef NumTraits< Scalar >::Real	RealScalar

Public Member Functions
	AmbiVector (Index size)
void	init (double estimatedDensity)
void	init (int mode)
Index	nonZeros () const
void	setBounds (Index start, Index end)
	Specifies a sub-vector to work on. More...
void	setZero ()
	Set all coefficients of current subvector to zero. More...
void	restart ()
	Must be called whenever we might perform a write access with an index smaller than the previous one. More...
Scalar &	coeffRef (Index i)
Scalar &	coeff (Index i)
	~AmbiVector ()
void	resize (Index size)
StorageIndex	size () const

Protected Member Functions
StorageIndex	convert_index (Index idx)
void	reallocate (Index size)
void	reallocateSparse ()

Protected Attributes
Scalar *	m_buffer
Scalar	m_zero
StorageIndex	m_size
StorageIndex	m_start
StorageIndex	m_end
StorageIndex	m_allocatedSize
StorageIndex	m_allocatedElements
StorageIndex	m_mode
StorageIndex	m_llStart
StorageIndex	m_llCurrent
StorageIndex	m_llSize

Member Typedef Documentation

RealScalar

template<typename _Scalar , typename _StorageIndex >

typedef NumTraits<Scalar>::Real Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::RealScalar

Scalar

template<typename _Scalar , typename _StorageIndex >

typedef _Scalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::Scalar

StorageIndex

template<typename _Scalar , typename _StorageIndex >

typedef _StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::StorageIndex

Constructor & Destructor Documentation

AmbiVector()

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::AmbiVector ( Index  size )

inlineexplicit

~AmbiVector()

template<typename _Scalar , typename _StorageIndex >

Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::~AmbiVector ( )

inline

Member Function Documentation

coeff()

template<typename _Scalar , typename _StorageIndex >

_Scalar & Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::coeff

(

Index

i

)

coeffRef()

template<typename _Scalar , typename _StorageIndex >

_Scalar & Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::coeffRef

(

Index

i

)

convert_index()

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::convert_index ( Index  idx )

inlineprotected

init() [1/2]

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::init

(

double

estimatedDensity

)

init() [2/2]

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::init

(

int

mode

)

nonZeros()

template<typename _Scalar , typename _StorageIndex >

Index Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::nonZeros

Returns

the number of non zeros in the current sub vector

reallocate()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::reallocate ( Index  size )

inlineprotected

reallocateSparse()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::reallocateSparse ( )

inlineprotected

resize()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::resize ( Index  size )

inline

restart()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::restart

Must be called whenever we might perform a write access with an index smaller than the previous one.

Don't worry, this function is extremely cheap.

setBounds()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::setBounds ( Index  start, Index  end  )

inline

Specifies a sub-vector to work on.

setZero()

template<typename _Scalar , typename _StorageIndex >

void Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::setZero

Set all coefficients of current subvector to zero.

size()

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::size ( ) const

inline

Member Data Documentation

m_allocatedElements

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_allocatedElements

protected

m_allocatedSize

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_allocatedSize

protected

m_buffer

template<typename _Scalar , typename _StorageIndex >

Scalar* Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_buffer

protected

m_end

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_end

protected

m_llCurrent

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_llCurrent

protected

m_llSize

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_llSize

protected

m_llStart

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_llStart

protected

m_mode

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_mode

protected

m_size

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_size

protected

m_start

template<typename _Scalar , typename _StorageIndex >

StorageIndex Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_start

protected

m_zero

template<typename _Scalar , typename _StorageIndex >

Scalar Eigen::internal::AmbiVector< _Scalar, _StorageIndex >::m_zero

protected

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/AmbiVector.h