Eigen::SparseMatrixBase< Derived > Class Template Reference

Base class of any sparse matrices or sparse expressions. More...

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

Inheritance diagram for Eigen::SparseMatrixBase< Derived >:

Classes
struct	ConstSelfAdjointViewReturnType
struct	CwiseProductDenseReturnType
struct	SelfAdjointViewReturnType

Public Types
enum	{   RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime , ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime = RowsAtCompileTime ,   MaxColsAtCompileTime = ColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1 , NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0 : bool(IsVectorAtCompileTime) ? 1 : 2 ,   Flags = internal::traits<Derived>::Flags , IsRowMajor = Flags&RowMajorBit ? 1 : 0 , InnerSizeAtCompileTime , _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0 }
typedef internal::traits< Derived >::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< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::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< Derived >	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< Derived >	Base
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
const Derived &	derived () const
Derived &	derived ()
Derived &	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
Derived &	markAsRValue ()
	SparseMatrixBase ()
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)
Derived &	operator= (const Derived &other)
template<typename OtherDerived >
Derived &	operator+= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator-= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator+= (const DiagonalBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator-= (const DiagonalBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator+= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator-= (const EigenBase< OtherDerived > &other)
Derived &	operator*= (const Scalar &other)
Derived &	operator/= (const Scalar &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const Product< Derived, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const
template<typename OtherDerived >
const Product< Derived, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const Product< Derived, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const
SparseSymmetricPermutationProduct< Derived, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
template<typename OtherDerived >
Derived &	operator*= (const SparseMatrixBase< OtherDerived > &other)
template<int Mode>
const TriangularView< const Derived, Mode >	triangularView () const
template<unsigned int UpLo>
ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
template<unsigned int UpLo>
SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
template<typename OtherDerived >
Scalar	dot (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
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
template<typename OtherDerived >
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval< Derived >::type	eval () const
Scalar	sum () const
const SparseView< Derived >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
internal::traits< Derived >::Scalar	dot (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
internal::traits< Derived >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
template<unsigned int UpLo>
SparseMatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
template<unsigned int UpLo>
SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	operator-= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	operator+= (const SparseMatrixBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE const SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	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
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Member Functions
template<typename OtherDerived >
Derived &	assign (const OtherDerived &other)
template<typename OtherDerived >
void	assignGeneric (const OtherDerived &other)

Static Protected Member Functions
static StorageIndex	convert_index (const Index idx)

Protected Attributes
bool	m_isRValue

Friends
std::ostream &	operator<< (std::ostream &s, const SparseMatrixBase &m)
template<typename OtherDerived >
const Product< OtherDerived, Derived >	operator* (const DiagonalBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)
template<typename OtherDerived >
const Product< OtherDerived, Derived >	operator* (const MatrixBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)

Detailed Description

template<typename Derived>
class Eigen::SparseMatrixBase< Derived >

Base class of any sparse matrices or sparse expressions.

Template Parameters

Derived

is the derived type, e.g. a sparse matrix type, or an expression, etc.

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

Member Typedef Documentation

AdjointReturnType

template<typename Derived >

typedef internal::conditional<NumTraits<Scalar>::IsComplex,CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>,Eigen::Transpose<constDerived>>,Transpose<constDerived>>::type Eigen::SparseMatrixBase< Derived >::AdjointReturnType

Base

template<typename Derived >

typedef EigenBase<Derived> Eigen::SparseMatrixBase< Derived >::Base

CoeffReturnType

template<typename Derived >

typedef internal::conditional<_HasDirectAccess,constScalar&,Scalar>::type Eigen::SparseMatrixBase< Derived >::CoeffReturnType

ConstantReturnType

template<typename Derived >

typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,Matrix<Scalar,Dynamic,Dynamic> > Eigen::SparseMatrixBase< Derived >::ConstantReturnType

ConstTransposeReturnType

template<typename Derived >

typedef internal::add_const<Transpose<constDerived>>::type Eigen::SparseMatrixBase< Derived >::ConstTransposeReturnType

DenseMatrixType

template<typename Derived >

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::SparseMatrixBase< Derived >::DenseMatrixType

type of the equivalent dense matrix

IndexVector

template<typename Derived >

typedef Matrix<StorageIndex,Dynamic,1> Eigen::SparseMatrixBase< Derived >::IndexVector

PacketReturnType

template<typename Derived >

typedef internal::add_const_on_value_type_if_arithmetic<typenameinternal::packet_traits<Scalar>::type>::type Eigen::SparseMatrixBase< Derived >::PacketReturnType

PacketScalar

template<typename Derived >

typedef internal::packet_traits<Scalar>::type Eigen::SparseMatrixBase< Derived >::PacketScalar

PlainObject

template<typename Derived >

typedef SparseMatrix<Scalar, Flags&RowMajorBit ? RowMajor : ColMajor, StorageIndex> Eigen::SparseMatrixBase< Derived >::PlainObject

RealScalar

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::SparseMatrixBase< Derived >::RealScalar

This is the "real scalar" type; if the Scalar type is already real numbers (e.g.

int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.

See also

class NumTraits

Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::Scalar

ScalarVector

template<typename Derived >

typedef Matrix<Scalar,Dynamic,1> Eigen::SparseMatrixBase< Derived >::ScalarVector

SquareMatrixType

template<typename Derived >

typedef Matrix<Scalar,EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime)> Eigen::SparseMatrixBase< Derived >::SquareMatrixType

type of the equivalent square matrix

StorageBaseType

template<typename Derived >

typedef SparseMatrixBase Eigen::SparseMatrixBase< Derived >::StorageBaseType

StorageIndex

template<typename Derived >

typedef internal::traits<Derived>::StorageIndex Eigen::SparseMatrixBase< Derived >::StorageIndex

The integer type used to store indices within a SparseMatrix.

For a SparseMatrix<Scalar,Options,IndexType> it an alias of the third template parameter IndexType.

StorageKind

template<typename Derived >

typedef internal::traits<Derived>::StorageKind Eigen::SparseMatrixBase< Derived >::StorageKind

TransposeReturnType

template<typename Derived >

typedef Transpose<Derived> Eigen::SparseMatrixBase< Derived >::TransposeReturnType

value_type

template<typename Derived >

typedef Scalar Eigen::SparseMatrixBase< Derived >::value_type

The numeric type of the expression' coefficients, e.g.

float, double, int or std::complex<float>, etc.

It is an alias for the Scalar type

Member Enumeration Documentation

anonymous enum

template<typename Derived >

anonymous enum

Enumerator
RowsAtCompileTime	The number of rows at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. See also MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime	The number of columns at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. See also MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime	This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time. See also RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
MaxSizeAtCompileTime
IsVectorAtCompileTime	This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).
NumDimensions	This value is equal to Tensor::NumDimensions, i.e. 0 for scalars, 1 for vectors, and 2 for matrices.
Flags	This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.
IsRowMajor
InnerSizeAtCompileTime
_HasDirectAccess

Constructor & Destructor Documentation

SparseMatrixBase()

template<typename Derived >

Eigen::SparseMatrixBase< Derived >::SparseMatrixBase ( )

inline

Member Function Documentation

adjoint()

template<typename Derived >

const AdjointReturnType Eigen::SparseMatrixBase< Derived >::adjoint ( ) const

inline

assign()

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::assign ( const OtherDerived &  other )

inlineprotected

assignGeneric()

template<typename Derived >

template<typename OtherDerived >

void Eigen::SparseMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other )

inlineprotected

blueNorm()

template<typename Derived >

NumTraits< typenameinternal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::blueNorm

inline

cols()

template<typename Derived >

Index Eigen::SparseMatrixBase< Derived >::cols ( ) const

inline

Returns

the number of columns.

See also

rows()

const_cast_derived()

template<typename Derived >

Derived & Eigen::SparseMatrixBase< Derived >::const_cast_derived ( ) const

inline

convert_index()

template<typename Derived >

static StorageIndex Eigen::SparseMatrixBase< Derived >::convert_index ( const Index  idx )

inlinestaticprotected

cwiseProduct() [1/2]

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type Eigen::SparseMatrixBase< Derived >::cwiseProduct

(

const MatrixBase< OtherDerived > &

other

)

const

cwiseProduct() [2/2]

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type Eigen::SparseMatrixBase< Derived >::cwiseProduct

(

const MatrixBase< OtherDerived > &

other

)

const

derived() [1/2]

template<typename Derived >

Derived & Eigen::SparseMatrixBase< Derived >::derived ( )

inline

derived() [2/2]

template<typename Derived >

const Derived & Eigen::SparseMatrixBase< Derived >::derived ( ) const

inline

dot() [1/4]

template<typename Derived >

template<typename OtherDerived >

internal::traits< Derived >::Scalar Eigen::SparseMatrixBase< Derived >::dot

(

const MatrixBase< OtherDerived > &

other

)

const

dot() [2/4]

template<typename Derived >

template<typename OtherDerived >

Scalar Eigen::SparseMatrixBase< Derived >::dot

(

const MatrixBase< OtherDerived > &

other

)

const

dot() [3/4]

template<typename Derived >

template<typename OtherDerived >

internal::traits< Derived >::Scalar Eigen::SparseMatrixBase< Derived >::dot

(

const SparseMatrixBase< OtherDerived > &

other

)

const

dot() [4/4]

template<typename Derived >

template<typename OtherDerived >

Scalar Eigen::SparseMatrixBase< Derived >::dot

(

const SparseMatrixBase< OtherDerived > &

other

)

const

eval()

template<typename Derived >

const internal::eval< Derived >::type Eigen::SparseMatrixBase< Derived >::eval ( ) const

inline

Returns

the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

innerSize()

template<typename Derived >

Index Eigen::SparseMatrixBase< Derived >::innerSize ( ) const

inline

Returns

the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

isApprox() [1/2]

template<typename Derived >

template<typename OtherDerived >

bool Eigen::SparseMatrixBase< Derived >::isApprox ( const MatrixBase< OtherDerived > &  other, const RealScalar &  prec = NumTraits<Scalar>::dummy_precision()  ) const

inline

isApprox() [2/2]

template<typename Derived >

template<typename OtherDerived >

bool Eigen::SparseMatrixBase< Derived >::isApprox	(	const SparseMatrixBase< OtherDerived > &	other,
		const RealScalar &	prec = NumTraits<Scalar>::dummy_precision()
	)		const

isRValue()

template<typename Derived >

bool Eigen::SparseMatrixBase< Derived >::isRValue ( ) const

inline

isVector()

template<typename Derived >

bool Eigen::SparseMatrixBase< Derived >::isVector ( ) const

inline

Returns

true if either the number of rows or the number of columns is equal to 1. In other words, this function returns

rows()==1 || cols()==1 

See also

rows(), cols(), IsVectorAtCompileTime.

markAsRValue()

template<typename Derived >

Derived & Eigen::SparseMatrixBase< Derived >::markAsRValue ( )

inline

norm()

template<typename Derived >

NumTraits< typenameinternal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::norm

inline

operator*() [1/3]

template<typename Derived >

template<typename OtherDerived >

const Product< Derived, OtherDerived > Eigen::SparseMatrixBase< Derived >::operator* ( const DiagonalBase< OtherDerived > &  other ) const

inline

operator*() [2/3]

template<typename Derived >

template<typename OtherDerived >

const Product< Derived, OtherDerived > Eigen::SparseMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other ) const

inline

operator*() [3/3]

template<typename Derived >

template<typename OtherDerived >

const Product< Derived, OtherDerived, AliasFreeProduct > Eigen::SparseMatrixBase< Derived >::operator* ( const SparseMatrixBase< OtherDerived > &  other ) const

inline

Returns

an expression of the product of two sparse matrices. By default a conservative product preserving the symbolic non zeros is performed. The automatic pruning of the small values can be achieved by calling the pruned() function in which case a totally different product algorithm is employed:

C = (A*B).pruned();             // suppress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);

where ref is a meaningful non zero reference value.

operator*=() [1/2]

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator*=

(

const Scalar &

other

)

operator*=() [2/2]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator*=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator+=() [1/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator+=

(

const DiagonalBase< OtherDerived > &

other

)

operator+=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator+=

(

const EigenBase< OtherDerived > &

other

)

operator+=() [3/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator+=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator+=() [4/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator+=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator-=() [1/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator-=

(

const DiagonalBase< OtherDerived > &

other

)

operator-=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator-=

(

const EigenBase< OtherDerived > &

other

)

operator-=() [3/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator-=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator-=() [4/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator-=

(

const SparseMatrixBase< OtherDerived > &

other

)

operator/=()

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::SparseMatrixBase< Derived >::operator/=

(

const Scalar &

other

)

operator=() [1/4]

template<typename Derived >

Derived & Eigen::SparseMatrixBase< Derived >::operator= ( const Derived &  other )

inline

operator=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator=

(

const EigenBase< OtherDerived > &

other

)

operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator=

(

const ReturnByValue< OtherDerived > &

other

)

operator=() [4/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator= ( const SparseMatrixBase< OtherDerived > &  other )

inline

outerSize()

template<typename Derived >

Index Eigen::SparseMatrixBase< Derived >::outerSize ( ) const

inline

Returns

the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

pruned()

template<typename Derived >

const SparseView< Derived > Eigen::SparseMatrixBase< Derived >::pruned ( const Scalar &  reference = Scalar(0), const RealScalar &  epsilon = NumTraits<Scalar>::dummy_precision()  ) const

inline

Returns

an expression of *this with values smaller than reference * epsilon removed.

This method is typically used in conjunction with the product of two sparse matrices to automatically prune the smallest values as follows:

C = (A*B).pruned();             // suppress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);

where ref is a meaningful non zero reference value.

rows()

template<typename Derived >

Index Eigen::SparseMatrixBase< Derived >::rows ( ) const

inline

Returns

the number of rows.

See also

cols()

selfadjointView() [1/4]

template<typename Derived >

template<unsigned int UpLo>

SelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( )

inline

selfadjointView() [2/4]

template<typename Derived >

template<unsigned int UpLo>

SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< Derived >::selfadjointView

(

)

selfadjointView() [3/4]

template<typename Derived >

template<unsigned int UpLo>

ConstSelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( ) const

inline

selfadjointView() [4/4]

template<typename Derived >

template<unsigned int UpLo>

SparseMatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< Derived >::selfadjointView

(

)

const

size()

template<typename Derived >

Index Eigen::SparseMatrixBase< Derived >::size ( ) const

inline

Returns

the number of coefficients, which is rows()*cols().

See also

rows(), cols().

squaredNorm()

template<typename Derived >

NumTraits< typenameinternal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::squaredNorm

inline

sum()

template<typename Derived >

internal::traits< Derived >::Scalar Eigen::SparseMatrixBase< Derived >::sum

toDense()

template<typename Derived >

DenseMatrixType Eigen::SparseMatrixBase< Derived >::toDense ( ) const

inline

transpose() [1/2]

template<typename Derived >

TransposeReturnType Eigen::SparseMatrixBase< Derived >::transpose ( )

inline

transpose() [2/2]

template<typename Derived >

const ConstTransposeReturnType Eigen::SparseMatrixBase< Derived >::transpose ( ) const

inline

triangularView()

template<typename Derived >

template<int Mode>

const TriangularView< const Derived, Mode > Eigen::SparseMatrixBase< Derived >::triangularView

inline

twistedBy()

template<typename Derived >

SparseSymmetricPermutationProduct< Derived, Upper|Lower > Eigen::SparseMatrixBase< Derived >::twistedBy ( const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &  perm ) const

inline

Returns

an expression of P H P^-1 where H is the matrix represented by *this

Friends And Related Function Documentation

operator* [1/2]

template<typename Derived >

template<typename OtherDerived >

const Product< OtherDerived, Derived > operator* ( const DiagonalBase< OtherDerived > &  lhs, const SparseMatrixBase< Derived > &  rhs  )

friend

operator* [2/2]

template<typename Derived >

template<typename OtherDerived >

const Product< OtherDerived, Derived > operator* ( const MatrixBase< OtherDerived > &  lhs, const SparseMatrixBase< Derived > &  rhs  )

friend

operator<<

template<typename Derived >

std::ostream & operator<< ( std::ostream &  s, const SparseMatrixBase< Derived > &  m  )

friend

Member Data Documentation

m_isRValue

template<typename Derived >

bool Eigen::SparseMatrixBase< Derived >::m_isRValue

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/SparseMatrixBase.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/SparseDot.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseView.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseTriangularView.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseProduct.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseSelfAdjointView.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseCwiseBinaryOp.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseFuzzy.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseAssign.h
• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseCwiseUnaryOp.h