Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex > Class Template Reference

A versatible sparse matrix representation. More...

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

Inheritance diagram for Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >:

Classes
struct	IndexPosPair
class	SingletonVector

Public Types
enum	{ Options = _Options }
typedef MappedSparseMatrix< Scalar, Flags >	Map
typedef Diagonal< SparseMatrix >	DiagonalReturnType
typedef Diagonal< const SparseMatrix >	ConstDiagonalReturnType
typedef Base::InnerIterator	InnerIterator
typedef Base::ReverseInnerIterator	ReverseInnerIterator
typedef internal::CompressedStorage< Scalar, StorageIndex >	Storage
typedef Base::IndexVector	IndexVector
typedef Base::ScalarVector	ScalarVector
Public Types inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >	Base
Public Types inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
enum
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::Scalar	Scalar
typedef Scalar	value_type
	The numeric type of the expression' coefficients, e.g. More...
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::StorageKind	StorageKind
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::StorageIndex	StorageIndex
	The integer type used to store indices within a SparseMatrix. More...
typedef internal::add_const_on_value_type_if_arithmetic< typenameinternal::packet_traits< Scalar >::type >::type	PacketReturnType
typedef SparseMatrixBase	StorageBaseType
typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector
typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< constDerived > >, Transpose< constDerived > >::type	AdjointReturnType
typedef Transpose< SparseMatrix< _Scalar, _Options, _StorageIndex > >	TransposeReturnType
typedef internal::add_const< Transpose< constDerived > >::type	ConstTransposeReturnType
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex >	PlainObject
typedef NumTraits< Scalar >::Real	RealScalar
	This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...
typedef internal::conditional< _HasDirectAccess, constScalar &, Scalar >::type	CoeffReturnType
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
	type of the equivalent dense matrix More...
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
	type of the equivalent square matrix More...
typedef EigenBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >	Base
Public Types inherited from Eigen::EigenBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::StorageKind	StorageKind

Public Member Functions
Index	rows () const
Index	cols () const
Index	innerSize () const
Index	outerSize () const
const Scalar *	valuePtr () const
Scalar *	valuePtr ()
const StorageIndex *	innerIndexPtr () const
StorageIndex *	innerIndexPtr ()
const StorageIndex *	outerIndexPtr () const
StorageIndex *	outerIndexPtr ()
const StorageIndex *	innerNonZeroPtr () const
StorageIndex *	innerNonZeroPtr ()
Storage &	data ()
const Storage &	data () const
Scalar	coeff (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
Scalar &	insert (Index row, Index col)
void	setZero ()
	Removes all non zeros but keep allocated memory. More...
void	reserve (Index reserveSize)
	Preallocates reserveSize non zeros. More...
template<class SizesType >
void	reserve (const SizesType &reserveSizes, const typename SizesType::value_type &enableif=typename SizesType::value_type())
Scalar &	insertBack (Index row, Index col)
Scalar &	insertBackByOuterInner (Index outer, Index inner)
Scalar &	insertBackByOuterInnerUnordered (Index outer, Index inner)
void	startVec (Index outer)
void	finalize ()
template<typename InputIterators >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end)
	Fill the matrix *this with the list of triplets defined by the iterator range begin - end. More...
template<typename InputIterators , typename DupFunctor >
void	setFromTriplets (const InputIterators &begin, const InputIterators &end, DupFunctor dup_func)
	The same as setFromTriplets but when duplicates are met the functor dup_func is applied: More...
void	sumupDuplicates ()
template<typename DupFunctor >
void	collapseDuplicates (DupFunctor dup_func=DupFunctor())
Scalar &	insertByOuterInner (Index j, Index i)
void	makeCompressed ()
	Turns the matrix into the compressed format. More...
void	uncompress ()
	Turns the matrix into the uncompressed mode. More...
void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
	Suppresses all nonzeros which are much smaller than reference under the tolerance epsilon. More...
template<typename KeepFunc >
void	prune (const KeepFunc &keep=KeepFunc())
	Turns the matrix into compressed format, and suppresses all nonzeros which do not satisfy the predicate keep. More...
void	conservativeResize (Index rows, Index cols)
	Resizes the matrix to a rows x cols matrix leaving old values untouched. More...
void	resize (Index rows, Index cols)
	Resizes the matrix to a rows x cols matrix and initializes it to zero. More...
void	resizeNonZeros (Index size)
const ConstDiagonalReturnType	diagonal () const
DiagonalReturnType	diagonal ()
	SparseMatrix ()
	Default constructor yielding an empty 0 x 0 matrix. More...
	SparseMatrix (Index rows, Index cols)
	Constructs a rows x cols empty matrix. More...
template<typename OtherDerived >
	SparseMatrix (const SparseMatrixBase< OtherDerived > &other)
	Constructs a sparse matrix from the sparse expression other. More...
template<typename OtherDerived , unsigned int UpLo>
	SparseMatrix (const SparseSelfAdjointView< OtherDerived, UpLo > &other)
	Constructs a sparse matrix from the sparse selfadjoint view other. More...
	SparseMatrix (const SparseMatrix &other)
	Copy constructor (it performs a deep copy) More...
template<typename OtherDerived >
	SparseMatrix (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...
template<typename OtherDerived >
	SparseMatrix (const DiagonalBase< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...
void	swap (SparseMatrix &other)
	Swaps the content of two sparse matrices of the same type. More...
void	setIdentity ()
	Sets *this to the identity matrix. More...
SparseMatrix &	operator= (const SparseMatrix &other)
template<typename OtherDerived >
SparseMatrix &	operator= (const EigenBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
SparseMatrix &	operator= (const Product< Lhs, Rhs, AliasFreeProduct > &other)
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix &	operator= (const SparseMatrixBase< OtherDerived > &other)
	~SparseMatrix ()
	Destructor. More...
Scalar	sum () const
	Overloaded for performance. More...
EIGEN_STRONG_INLINE Scalar &	insertBackUncompressed (Index row, Index col)
template<typename Lhs , typename Rhs >
SparseMatrix< Scalar, _Options, _StorageIndex > &	operator= (const Product< Lhs, Rhs, AliasFreeProduct > &src)
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseMatrix< Scalar, _Options, _StorageIndex > &	operator= (const SparseMatrixBase< OtherDerived > &other)
bool	isCompressed () const
Index	nonZeros () const
Public Member Functions inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
Index	nonZeros () const
const Scalar *	valuePtr () const
Scalar *	valuePtr ()
const StorageIndex *	innerIndexPtr () const
StorageIndex *	innerIndexPtr ()
const StorageIndex *	outerIndexPtr () const
StorageIndex *	outerIndexPtr ()
const StorageIndex *	innerNonZeroPtr () const
StorageIndex *	innerNonZeroPtr ()
bool	isCompressed () const
const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const
Map< Array< Scalar, Dynamic, 1 > >	coeffs ()
Public Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator= (const EigenBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator= (const ReturnByValue< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator= (const SparseMatrix< _Scalar, _Options, _StorageIndex > &other)
const SparseMatrix< _Scalar, _Options, _StorageIndex > &	derived () const
SparseMatrix< _Scalar, _Options, _StorageIndex > &	derived ()
SparseMatrix< _Scalar, _Options, _StorageIndex > &	const_cast_derived () const
Index	rows () const
Index	cols () const
Index	size () const
bool	isVector () const
Index	outerSize () const
Index	innerSize () const
bool	isRValue () const
SparseMatrix< _Scalar, _Options, _StorageIndex > &	markAsRValue ()
	SparseMatrixBase ()
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator+= (const DiagonalBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator+= (const EigenBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator-= (const DiagonalBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator-= (const EigenBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator*= (const Scalar &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator*= (const SparseMatrixBase< OtherDerived > &other)
SparseMatrix< _Scalar, _Options, _StorageIndex > &	operator/= (const Scalar &other)
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
EIGEN_STRONG_INLINE const SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const
const Product< SparseMatrix< _Scalar, _Options, _StorageIndex >, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const
SparseSymmetricPermutationProduct< SparseMatrix< _Scalar, _Options, _StorageIndex >, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
const TriangularView< const SparseMatrix< _Scalar, _Options, _StorageIndex >, Mode >	triangularView () const
ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >::template ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >::template SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
Scalar	dot (const MatrixBase< OtherDerived > &other) const
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::Scalar	dot (const MatrixBase< OtherDerived > &other) const
internal::traits< SparseMatrix< _Scalar, _Options, _StorageIndex > >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
RealScalar	squaredNorm () const
RealScalar	norm () const
RealScalar	blueNorm () const
TransposeReturnType	transpose ()
const ConstTransposeReturnType	transpose () const
const AdjointReturnType	adjoint () const
DenseMatrixType	toDense () const
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval< SparseMatrix< _Scalar, _Options, _StorageIndex > >::type	eval () const
Scalar	sum () const
const SparseView< SparseMatrix< _Scalar, _Options, _StorageIndex > >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Public Member Functions inherited from Eigen::EigenBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
EIGEN_DEVICE_FUNC SparseMatrix< _Scalar, _Options, _StorageIndex > &	derived ()
EIGEN_DEVICE_FUNC const SparseMatrix< _Scalar, _Options, _StorageIndex > &	derived () const
EIGEN_DEVICE_FUNC SparseMatrix< _Scalar, _Options, _StorageIndex > &	const_cast_derived () const
EIGEN_DEVICE_FUNC const SparseMatrix< _Scalar, _Options, _StorageIndex > &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Types
typedef SparseMatrix< Scalar,(Flags &~RowMajorBit)|(IsRowMajor?RowMajorBit:0)>	TransposedSparseMatrix
Protected Types inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
typedef Base::IndexVector	IndexVector

Protected Member Functions
template<class SizesType >
void	reserveInnerVectors (const SizesType &reserveSizes)
template<typename Other >
void	initAssignment (const Other &other)
EIGEN_DONT_INLINE Scalar &	insertCompressed (Index row, Index col)
EIGEN_DONT_INLINE Scalar &	insertUncompressed (Index row, Index col)
template<typename DiagXpr , typename Func >
void	assignDiagonal (const DiagXpr diagXpr, const Func &assignFunc)
Protected Member Functions inherited from Eigen::SparseCompressedBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
Eigen::Map< IndexVector >	innerNonZeros ()
const Eigen::Map< const IndexVector >	innerNonZeros () const
	SparseCompressedBase ()
	Default constructor. More...
internal::LowerBoundIndex	lower_bound (Index row, Index col) const
Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
SparseMatrix< _Scalar, _Options, _StorageIndex > &	assign (const OtherDerived &other)
void	assignGeneric (const OtherDerived &other)

Protected Attributes
Index	m_outerSize
Index	m_innerSize
StorageIndex *	m_outerIndex
StorageIndex *	m_innerNonZeros
Storage	m_data
Protected Attributes inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
bool	m_isRValue

Friends
class	SparseVector< _Scalar, 0, _StorageIndex >
template<typename , typename , typename , typename , typename >
struct	internal::Assignment
std::ostream &	operator<< (std::ostream &s, const SparseMatrix &m)

Additional Inherited Members
Static Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >
static StorageIndex	convert_index (const Index idx)

Detailed Description

template<typename _Scalar, int _Options, typename _StorageIndex>
class Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >

A versatible sparse matrix representation.

This class implements a more versatile variants of the common compressed row/column storage format. Each colmun's (resp. row) non zeros are stored as a pair of value with associated row (resp. colmiun) index. All the non zeros are stored in a single large buffer. Unlike the compressed format, there might be extra space in between the nonzeros of two successive colmuns (resp. rows) such that insertion of new non-zero can be done with limited memory reallocation and copies.

A call to the function makeCompressed() turns the matrix into the standard compressed format compatible with many library.

More details on this storage sceheme are given in the manual pages.

Template Parameters

_Scalar	the scalar type, i.e. the type of the coefficients
_Options	Union of bit flags controlling the storage scheme. Currently the only possibility is ColMajor or RowMajor. The default is 0 which means column-major.
_StorageIndex	the type of the indices. It has to be a signed type (e.g., short, int, std::ptrdiff_t). Default is int.

Warning

In Eigen 3.2, the undocumented type SparseMatrix::Index was improperly defined as the storage index type (e.g., int), whereas it is now (starting from Eigen 3.3) deprecated and always defined as Eigen::Index. Codes making use of SparseMatrix::Index, might thus likely have to be changed to use SparseMatrix::StorageIndex instead.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizing_Plugins by defining the preprocessor symbol EIGEN_SPARSEMATRIX_PLUGIN.

Member Typedef Documentation

ConstDiagonalReturnType

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Diagonal<const SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ConstDiagonalReturnType

DiagonalReturnType

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Diagonal<SparseMatrix> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::DiagonalReturnType

IndexVector

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::IndexVector Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::IndexVector

InnerIterator

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::InnerIterator Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::InnerIterator

Map

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef MappedSparseMatrix<Scalar,Flags> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::Map

ReverseInnerIterator

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::ReverseInnerIterator Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ReverseInnerIterator

ScalarVector

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef Base::ScalarVector Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::ScalarVector

Storage

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef internal::CompressedStorage<Scalar,StorageIndex> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::Storage

TransposedSparseMatrix

template<typename _Scalar , int _Options, typename _StorageIndex >

typedef SparseMatrix<Scalar,(Flags&~RowMajorBit)|(IsRowMajor?RowMajorBit:0)> Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::TransposedSparseMatrix

protected

Member Enumeration Documentation

anonymous enum

template<typename _Scalar , int _Options, typename _StorageIndex >

anonymous enum

Enumerator
Options

Constructor & Destructor Documentation

SparseMatrix() [1/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( )

inline

Default constructor yielding an empty 0 x 0 matrix.

SparseMatrix() [2/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( Index  rows, Index  cols  )

inline

Constructs a rows x cols empty matrix.

SparseMatrix() [3/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseMatrixBase< OtherDerived > &  other )

inline

Constructs a sparse matrix from the sparse expression other.

SparseMatrix() [4/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived , unsigned int UpLo>

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseSelfAdjointView< OtherDerived, UpLo > &  other )

inline

Constructs a sparse matrix from the sparse selfadjoint view other.

SparseMatrix() [5/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const SparseMatrix< _Scalar, _Options, _StorageIndex > &  other )

inline

Copy constructor (it performs a deep copy)

SparseMatrix() [6/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const ReturnByValue< OtherDerived > &  other )

inline

Copy constructor with in-place evaluation.

SparseMatrix() [7/7]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::SparseMatrix ( const DiagonalBase< OtherDerived > &  other )

inlineexplicit

Copy constructor with in-place evaluation.

~SparseMatrix()

template<typename _Scalar , int _Options, typename _StorageIndex >

Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::~SparseMatrix ( )

inline

Destructor.

Member Function Documentation

assignDiagonal()

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename DiagXpr , typename Func >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::assignDiagonal ( const DiagXpr  diagXpr, const Func &  assignFunc  )

inlineprotected

coeff()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::coeff ( Index  row, Index  col  ) const

inline

Returns

the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero

coeffRef()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::coeffRef ( Index  row, Index  col  )

inline

Returns

a non-const reference to the value of the matrix at position i, j

If the element does not exist then it is inserted via the insert(Index,Index) function which itself turns the matrix into a non compressed form if that was not the case.

This is a O(log(nnz_j)) operation (binary search) plus the cost of insert(Index,Index) function if the element does not already exist.

collapseDuplicates()

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename DupFunctor >

void Eigen::SparseMatrix< Scalar, _Options, _StorageIndex >::collapseDuplicates

(

DupFunctor

dup_func = DupFunctor()

)

cols()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::cols ( ) const

inline

Returns

the number of columns of the matrix

conservativeResize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::conservativeResize ( Index  rows, Index  cols  )

inline

Resizes the matrix to a rows x cols matrix leaving old values untouched.

If the sizes of the matrix are decreased, then the matrix is turned to uncompressed-mode and the storage of the out of bounds coefficients is kept and reserved. Call makeCompressed() to pack the entries and squeeze extra memory.

See also

reserve(), setZero(), makeCompressed()

data() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

Storage & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::data ( )

inline

data() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const Storage & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::data ( ) const

inline

diagonal() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

DiagonalReturnType Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::diagonal ( )

inline

Returns

a read-write expression of the diagonal coefficients.

Warning

If the diagonal entries are written, then all diagonal entries must already exist, otherwise an assertion will be raised.

diagonal() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const ConstDiagonalReturnType Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::diagonal ( ) const

inline

Returns

a const expression of the diagonal coefficients.

finalize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::finalize ( )

inline

initAssignment()

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename Other >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::initAssignment ( const Other &  other )

inlineprotected

innerIndexPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerIndexPtr ( )

inline

Returns

a non-const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also

valuePtr(), outerIndexPtr()

innerIndexPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerIndexPtr ( ) const

inline

Returns

a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also

valuePtr(), outerIndexPtr()

innerNonZeroPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerNonZeroPtr ( )

inline

Returns

a non-const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning

it returns the null pointer 0 in compressed mode

innerNonZeroPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerNonZeroPtr ( ) const

inline

Returns

a const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning

it returns the null pointer 0 in compressed mode

innerSize()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::innerSize ( ) const

inline

Returns

the number of rows (resp. columns) of the matrix if the storage order column major (resp. row major)

insert()

template<typename _Scalar , int _Options, typename _StorageIndex >

SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insert	(	Index	row,
		Index	col
	)

Returns

a reference to a novel non zero coefficient with coordinates row x col. The non zero coefficient must not already exist.

If the matrix *this is in compressed mode, then *this is turned into uncompressed mode while reserving room for 2 x this->innerSize() non zeros if reserve(Index) has not been called earlier. In this case, the insertion procedure is optimized for a sequential insertion mode where elements are assumed to be inserted by increasing outer-indices.

If that's not the case, then it is strongly recommended to either use a triplet-list to assemble the matrix, or to first call reserve(const SizesType &) to reserve the appropriate number of non-zero elements per inner vector.

Assuming memory has been appropriately reserved, this function performs a sorted insertion in O(1) if the elements of each inner vector are inserted in increasing inner index order, and in O(nnz_j) for a random insertion.

insertBack()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBack ( Index  row, Index  col  )

inline

insertBackByOuterInner()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackByOuterInner ( Index  outer, Index  inner  )

inline

insertBackByOuterInnerUnordered()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackByOuterInnerUnordered ( Index  outer, Index  inner  )

inline

insertBackUncompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_STRONG_INLINE Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertBackUncompressed ( Index  row, Index  col  )

inline

insertByOuterInner()

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertByOuterInner ( Index  j, Index  i  )

inline

insertCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertCompressed ( Index  row, Index  col  )

protected

insertUncompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

EIGEN_DONT_INLINE SparseMatrix< _Scalar, _Options, _StorageIndex >::Scalar & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::insertUncompressed ( Index  row, Index  col  )

protected

isCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

bool Eigen::SparseCompressedBase< Derived >::isCompressed ( ) const

inline

Returns

whether *this is in compressed form.

makeCompressed()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::makeCompressed ( )

inline

Turns the matrix into the compressed format.

nonZeros()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseCompressedBase< Derived >::nonZeros ( ) const

inline

Returns

the number of non zero coefficients

operator=() [1/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

SparseMatrix & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const EigenBase< OtherDerived > &  other )

inline

operator=() [2/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename Lhs , typename Rhs >

SparseMatrix & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const Product< Lhs, Rhs, AliasFreeProduct > &  other )

inline

operator=() [3/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename Lhs , typename Rhs >

SparseMatrix< Scalar, _Options, _StorageIndex > & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=

(

const Product< Lhs, Rhs, AliasFreeProduct > &

src

)

operator=() [4/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

SparseMatrix & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator= ( const SparseMatrix< _Scalar, _Options, _StorageIndex > &  other )

inline

operator=() [5/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

EIGEN_DONT_INLINE SparseMatrix & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator=() [6/6]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename OtherDerived >

EIGEN_DONT_INLINE SparseMatrix< Scalar, _Options, _StorageIndex > & Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=

(

const SparseMatrixBase< OtherDerived > &

other

)

outerIndexPtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::outerIndexPtr ( )

inline

Returns

a non-const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also

valuePtr(), innerIndexPtr()

outerIndexPtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const StorageIndex * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::outerIndexPtr ( ) const

inline

Returns

a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also

valuePtr(), innerIndexPtr()

outerSize()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::outerSize ( ) const

inline

Returns

the number of columns (resp. rows) of the matrix if the storage order column major (resp. row major)

prune() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename KeepFunc >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::prune ( const KeepFunc &  keep = KeepFunc() )

inline

Turns the matrix into compressed format, and suppresses all nonzeros which do not satisfy the predicate keep.

The functor type KeepFunc must implement the following function:

bool operator() (const Index& row, const Index& col, const Scalar& value) const;

See also

prune(Scalar,RealScalar)

prune() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::prune ( const Scalar &  reference, const RealScalar &  epsilon = NumTraits<RealScalar>::dummy_precision()  )

inline

Suppresses all nonzeros which are much smaller than reference under the tolerance epsilon.

reserve() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::reserve ( const SizesType &  reserveSizes, const typename SizesType::value_type &  enableif = typename SizesType::value_type()  )

inline

reserve() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::reserve ( Index  reserveSize )

inline

Preallocates reserveSize non zeros.

Precondition: the matrix must be in compressed mode.

reserveInnerVectors()

template<typename _Scalar , int _Options, typename _StorageIndex >

template<class SizesType >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::reserveInnerVectors ( const SizesType &  reserveSizes )

inlineprotected

resize()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::resize ( Index  rows, Index  cols  )

inline

Resizes the matrix to a rows x cols matrix and initializes it to zero.

This function does not free the currently allocated memory. To release as much as memory as possible, call

mat.data().squeeze(); 

after resizing it.

See also

reserve(), setZero()

resizeNonZeros()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::resizeNonZeros ( Index  size )

inline

rows()

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::rows ( ) const

inline

Returns

the number of rows of the matrix

setFromTriplets() [1/2]

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename InputIterators >

void Eigen::SparseMatrix< Scalar, _Options, _StorageIndex >::setFromTriplets	(	const InputIterators &	begin,
		const InputIterators &	end
	)

Fill the matrix *this with the list of triplets defined by the iterator range begin - end.

A triplet is a tuple (i,j,value) defining a non-zero element. The input list of triplets does not have to be sorted, and can contains duplicated elements. In any case, the result is a sorted and compressed sparse matrix where the duplicates have been summed up. This is a O(n) operation, with n the number of triplet elements. The initial contents of *this is destroyed. The matrix *this must be properly resized beforehand using the SparseMatrix(Index,Index) constructor, or the resize(Index,Index) method. The sizes are not extracted from the triplet list.

The InputIterators value_type must provide the following interface:

Scalar value() const; // the value
Scalar row() const;   // the row index i
Scalar col() const;   // the column index j

See for instance the Eigen::Triplet template class.

Here is a typical usage example:

typedef Triplet<double> T;
std::vector<T> tripletList;
tripletList.reserve(estimation_of_entries);
for(...)
{
  // ...
  tripletList.push_back(T(i,j,v_ij));
}
SparseMatrixType m(rows,cols);
m.setFromTriplets(tripletList.begin(), tripletList.end());
// m is ready to go!

Warning

The list of triplets is read multiple times (at least twice). Therefore, it is not recommended to define an abstract iterator over a complex data-structure that would be expensive to evaluate. The triplets should rather be explicitly stored into a std::vector for instance.

setFromTriplets() [2/2]

template<typename Scalar , int _Options, typename _StorageIndex >

template<typename InputIterators , typename DupFunctor >

void Eigen::SparseMatrix< Scalar, _Options, _StorageIndex >::setFromTriplets	(	const InputIterators &	begin,
		const InputIterators &	end,
		DupFunctor	dup_func
	)

The same as setFromTriplets but when duplicates are met the functor dup_func is applied:

value = dup_func(OldValue, NewValue)

Here is a C++11 example keeping the latest entry only:

mat.setFromTriplets(triplets.begin(), triplets.end(), [] (const Scalar&,const Scalar &b) { return b; });

setIdentity()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::setIdentity ( )

inline

Sets *this to the identity matrix.

This function also turns the matrix into compressed mode, and drop any reserved memory.

setZero()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::setZero ( )

inline

Removes all non zeros but keep allocated memory.

This function does not free the currently allocated memory. To release as much as memory as possible, call

mat.data().squeeze(); 

after resizing it.

See also

resize(Index,Index), data()

startVec()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::startVec ( Index  outer )

inline

sum()

template<typename _Scalar , int _Options, typename _Index >

internal::traits< SparseMatrix< _Scalar, _Options, _Index > >::Scalar Eigen::SparseMatrix< _Scalar, _Options, _Index >::sum

Overloaded for performance.

sumupDuplicates()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::sumupDuplicates ( )

inline

swap()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::swap ( SparseMatrix< _Scalar, _Options, _StorageIndex > &  other )

inline

Swaps the content of two sparse matrices of the same type.

This is a fast operation that simply swaps the underlying pointers and parameters.

uncompress()

template<typename _Scalar , int _Options, typename _StorageIndex >

void Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::uncompress ( )

inline

Turns the matrix into the uncompressed mode.

valuePtr() [1/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

Scalar * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::valuePtr ( )

inline

Returns

a non-const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also

innerIndexPtr(), outerIndexPtr()

valuePtr() [2/2]

template<typename _Scalar , int _Options, typename _StorageIndex >

const Scalar * Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::valuePtr ( ) const

inline

Returns

a const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also

innerIndexPtr(), outerIndexPtr()

Friends And Related Function Documentation

internal::Assignment

template<typename _Scalar , int _Options, typename _StorageIndex >

template<typename , typename , typename , typename , typename >

friend struct internal::Assignment

friend

operator<<

template<typename _Scalar , int _Options, typename _StorageIndex >

std::ostream & operator<< ( std::ostream &  s, const SparseMatrix< _Scalar, _Options, _StorageIndex > &  m  )

friend

SparseVector< _Scalar, 0, _StorageIndex >

template<typename _Scalar , int _Options, typename _StorageIndex >

friend class SparseVector< _Scalar, 0, _StorageIndex >

friend

Member Data Documentation

m_data

template<typename _Scalar , int _Options, typename _StorageIndex >

Storage Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_data

protected

m_innerNonZeros

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerNonZeros

protected

m_innerSize

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_innerSize

protected

m_outerIndex

template<typename _Scalar , int _Options, typename _StorageIndex >

StorageIndex* Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_outerIndex

protected

m_outerSize

template<typename _Scalar , int _Options, typename _StorageIndex >

Index Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::m_outerSize

protected

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseUtil.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseMatrix.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseRedux.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseProduct.h