Eigen: Eigen::SparseCompressedBase< Derived

Searching...

No Matches

#include <Eigen/src/SparseCore/SparseCompressedBase.h>

Detailed Description

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

Common base class for sparse [compressed]-{row|column}-storage format.

This class defines the common interface for all derived classes implementing the compressed sparse storage format, such as:

Inheritance diagram for Eigen::SparseCompressedBase< Derived >:

Public Member Functions
Map< Array< Scalar, Dynamic, 1 > >	coeffs ()

const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const

StorageIndex *	innerIndexPtr ()

const StorageIndex *	innerIndexPtr () const

template<class Comp = std::less<>>
Index	innerIndicesAreSorted () const

template<class Comp = std::less<>>
Index	innerIndicesAreSorted (Index begin, Index end) const

StorageIndex *	innerNonZeroPtr ()

const StorageIndex *	innerNonZeroPtr () const

bool	isCompressed () const

Index	nonZeros () const

StorageIndex *	outerIndexPtr ()

const StorageIndex *	outerIndexPtr () const

template<class Comp = std::less<>>
void	sortInnerIndices ()

template<class Comp = std::less<>>
void	sortInnerIndices (Index begin, Index end)

Scalar *	valuePtr ()

const Scalar *	valuePtr () const

Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
template<typename CustomBinaryOp, typename OtherDerived>
constexpr const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const Eigen::SparseMatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

template<int NRows, int NCols>
constexpr FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)

template<int NRows, int NCols>
constexpr const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index).

template<int NRows, int NCols>
constexpr FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

template<int NRows, int NCols>
constexpr const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index).

template<typename NRowsType, typename NColsType>
constexpr FixedBlockXpr<...,... >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)

template<typename NRowsType, typename NColsType>
constexpr const ConstFixedBlockXpr<...,... >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const
	This is the const version of block(Index,Index,NRowsType,NColsType)

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>().

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index).

template<typename NRowsType, typename NColsType>
constexpr FixedBlockXpr<...,... >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols)

template<typename NRowsType, typename NColsType>
constexpr ConstFixedBlockXpr<...,... >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomLeftCorner(NRowsType, NColsType).

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>().

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index).

template<typename NRowsType, typename NColsType>
constexpr FixedBlockXpr<...,... >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols)

template<typename NRowsType, typename NColsType>
constexpr const ConstFixedBlockXpr<...,... >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomRightCorner(NRowsType, NColsType).

template<int N>
constexpr NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

template<int N>
constexpr ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>().

template<typename NRowsType>
constexpr NRowsBlockXpr<... >::Type	bottomRows (NRowsType n)

template<typename NRowsType>
constexpr const ConstNRowsBlockXpr<... >::Type	bottomRows (NRowsType n) const
	This is the const version of bottomRows(NRowsType).

template<typename NewType>
constexpr CastXpr< NewType >::Type	cast () const

constexpr ColXpr	col (Index i)

constexpr ConstColXpr	col (Index i) const
	This is the const version of col().

Index	cols () const

constexpr ConjugateReturnType	conjugate () const

template<bool Cond>
constexpr std::conditional_t< Cond, ConjugateReturnType, const Derived & >	conjugateIf () const

const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived >	cwiseAbs () const

const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived >	cwiseAbs2 () const

const CwiseUnaryOp< internal::scalar_arg_op< Scalar >, const Derived >	cwiseArg () const

const CwiseUnaryOp< internal::scalar_cbrt_op< Scalar >, const Derived >	cwiseCbrt () const

template<typename OtherDerived>
constexpr const CwiseBinaryEqualReturnType< OtherDerived >	cwiseEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

template<typename OtherDerived>
constexpr const CwiseBinaryGreaterReturnType< OtherDerived >	cwiseGreater (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarGreaterReturnType	cwiseGreater (const Scalar &s) const

template<typename OtherDerived>
constexpr const CwiseBinaryGreaterOrEqualReturnType< OtherDerived >	cwiseGreaterOrEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarGreaterOrEqualReturnType	cwiseGreaterOrEqual (const Scalar &s) const

const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived >	cwiseInverse () const

template<typename OtherDerived>
constexpr const CwiseBinaryLessReturnType< OtherDerived >	cwiseLess (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarLessReturnType	cwiseLess (const Scalar &s) const

template<typename OtherDerived>
constexpr const CwiseBinaryLessOrEqualReturnType< OtherDerived >	cwiseLessOrEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarLessOrEqualReturnType	cwiseLessOrEqual (const Scalar &s) const

template<int NaNPropagation = PropagateFast, typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar, NaNPropagation >, const Derived, const OtherDerived >	cwiseMax (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<int NaNPropagation = PropagateFast>
constexpr const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar, NaNPropagation >, const Derived, const ConstantReturnType >	cwiseMax (const Scalar &other) const

template<int NaNPropagation = PropagateFast, typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar, NaNPropagation >, const Derived, const OtherDerived >	cwiseMin (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<int NaNPropagation = PropagateFast>
constexpr const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar, NaNPropagation >, const Derived, const ConstantReturnType >	cwiseMin (const Scalar &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryNotEqualReturnType< OtherDerived >	cwiseNotEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseScalarNotEqualReturnType	cwiseNotEqual (const Scalar &s) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived >	cwiseProduct (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const Derived >	cwiseSign () const

const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived >	cwiseSqrt () const

const CwiseUnaryOp< internal::scalar_square_op< Scalar >, const Derived >	cwiseSquare () const

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

template<int N>
constexpr FixedSegmentReturnType< N >::Type	head (Index n=N)

template<int N>
constexpr ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>().

template<typename NType>
constexpr FixedSegmentReturnType<... >::Type	head (NType n)

template<typename NType>
constexpr const ConstFixedSegmentReturnType<... >::Type	head (NType n) const
	This is the const version of head(NType).

constexpr NonConstImagReturnType	imag ()

constexpr const ImagReturnType	imag () const

Index	innerSize () const

constexpr InnerVectorReturnType	innerVector (Index outer)

constexpr const ConstInnerVectorReturnType	innerVector (Index outer) const

constexpr InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

constexpr const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

bool	isVector () const

template<int N>
constexpr NColsBlockXpr< N >::Type	leftCols (Index n=N)

template<int N>
constexpr ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>().

template<typename NColsType>
constexpr NColsBlockXpr<... >::Type	leftCols (NColsType n)

template<typename NColsType>
constexpr const ConstNColsBlockXpr<... >::Type	leftCols (NColsType n) const
	This is the const version of leftCols(NColsType).

template<int N>
constexpr NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

template<int N>
constexpr ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>().

template<typename NColsType>
constexpr NColsBlockXpr<... >::Type	middleCols (Index startCol, NColsType numCols)

template<typename NColsType>
constexpr const ConstNColsBlockXpr<... >::Type	middleCols (Index startCol, NColsType numCols) const
	This is the const version of middleCols(Index,NColsType).

template<int N>
constexpr NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

template<int N>
constexpr ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>().

template<typename NRowsType>
constexpr NRowsBlockXpr<... >::Type	middleRows (Index startRow, NRowsType n)

template<typename NRowsType>
constexpr const ConstNRowsBlockXpr<... >::Type	middleRows (Index startRow, NRowsType n) const
	This is the const version of middleRows(Index,NRowsType).

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_bitwise_and_op< Scalar >, const Derived, const OtherDerived >	operator& (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_boolean_and_op< Scalar >, const Derived, const OtherDerived >	operator&& (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
const Product< Derived, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
const CwiseBinaryOp< internal::scalar_sum_op< Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived >	operator+ (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const NegativeReturnType	operator- () const

template<typename OtherDerived>
const CwiseBinaryOp< internal::scalar_difference_op< Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived >	operator- (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_bitwise_xor_op< Scalar >, const Derived, const OtherDerived >	operator^ (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_bitwise_or_op< Scalar >, const Derived, const OtherDerived >	operator\| (const Eigen::SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived>
constexpr const CwiseBinaryOp< internal::scalar_boolean_or_op< Scalar >, const Derived, const OtherDerived >	operator\|\| (const Eigen::SparseMatrixBase< OtherDerived > &other) const

Index	outerSize () const

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

constexpr NonConstRealReturnType	real ()

constexpr RealReturnType	real () const

template<int N>
constexpr NColsBlockXpr< N >::Type	rightCols (Index n=N)

template<int N>
constexpr ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>().

template<typename NColsType>
constexpr NColsBlockXpr<... >::Type	rightCols (NColsType n)

template<typename NColsType>
constexpr const ConstNColsBlockXpr<... >::Type	rightCols (NColsType n) const
	This is the const version of rightCols(NColsType).

constexpr RowXpr	row (Index i)

constexpr ConstRowXpr	row (Index i) const
	This is the const version of row().

Index	rows () const

template<int N>
constexpr FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

template<int N>
constexpr ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index).

template<typename NType>
constexpr FixedSegmentReturnType<... >::Type	segment (Index start, NType n)

template<typename NType>
constexpr const ConstFixedSegmentReturnType<... >::Type	segment (Index start, NType n) const
	This is the const version of segment(Index,NType).

Index	size () const

template<DirectionType Direction>
constexpr std::conditional_t< Direction==Vertical, ColXpr, RowXpr >	subVector (Index i)

template<DirectionType Direction>
constexpr std::conditional_t< Direction==Vertical, ConstColXpr, ConstRowXpr >	subVector (Index i) const

template<DirectionType Direction>
constexpr Index	subVectors () const

template<int N>
constexpr FixedSegmentReturnType< N >::Type	tail (Index n=N)

template<int N>
constexpr ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>().

template<typename NType>
constexpr FixedSegmentReturnType<... >::Type	tail (NType n)

template<typename NType>
constexpr const ConstFixedSegmentReturnType<... >::Type	tail (NType n) const
	This is the const version of tail(NType).

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>().

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index).

template<typename NRowsType, typename NColsType>
constexpr FixedBlockXpr<...,... >::Type	topLeftCorner (NRowsType cRows, NColsType cCols)

template<typename NRowsType, typename NColsType>
constexpr const ConstFixedBlockXpr<...,... >::Type	topLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topLeftCorner(Index, Index).

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>().

template<int CRows, int CCols>
constexpr FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
constexpr const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index).

template<typename NRowsType, typename NColsType>
constexpr FixedBlockXpr<...,... >::Type	topRightCorner (NRowsType cRows, NColsType cCols)

template<typename NRowsType, typename NColsType>
constexpr const ConstFixedBlockXpr<...,... >::Type	topRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topRightCorner(NRowsType, NColsType).

template<int N>
constexpr NRowsBlockXpr< N >::Type	topRows (Index n=N)

template<int N>
constexpr ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>().

template<typename NRowsType>
constexpr NRowsBlockXpr<... >::Type	topRows (NRowsType n)

template<typename NRowsType>
constexpr const ConstNRowsBlockXpr<... >::Type	topRows (NRowsType n) const
	This is the const version of topRows(NRowsType).

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

template<typename CustomUnaryOp>
constexpr const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.

template<typename CustomViewOp>
constexpr CwiseUnaryView< CustomViewOp, Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp())

template<typename CustomViewOp>
constexpr const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr Index	cols () const noexcept

constexpr Derived &	derived ()

constexpr const Derived &	derived () const

constexpr Index	rows () const noexcept

constexpr Index	size () const noexcept

Protected Member Functions
	SparseCompressedBase ()=default

Additional Inherited Members
Public Types inherited from Eigen::SparseMatrixBase< Derived >
enum	{ RowsAtCompileTime , ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime , NumDimensions , Flags , IsRowMajor , InnerSizeAtCompileTime }

using	RealScalar

using	StorageIndex

using	value_type

Public Types inherited from Eigen::EigenBase< Derived >
using	Index
	The interface type of indices.

Constructor & Destructor Documentation

◆ SparseCompressedBase()

template<typename Derived>

Eigen::SparseCompressedBase< Derived >::SparseCompressedBase ( )

protecteddefault

Default constructor. Do nothing.

Member Function Documentation

◆ coeffs() [1/2]

template<typename Derived>

Map< Array< Scalar, Dynamic, 1 > > Eigen::SparseCompressedBase< Derived >::coeffs ( )

inline

Returns: a read-write view of the stored coefficients as a 1D array expression

Warning: this method is for compressed storage only, and it will trigger an assertion otherwise.

Here is an example:

// SPDX-FileCopyrightText: The Eigen Authors
// SPDX-License-Identifier: MPL-2.0
 
SparseMatrix<double> A(3, 3);
A.insert(1, 2) = 0;
A.insert(0, 1) = 1;
A.insert(2, 0) = 2;
A.makeCompressed();
cout << "The matrix A is:" << endl << MatrixXd(A) << endl;
cout << "it has " << A.nonZeros() << " stored non zero coefficients that are: " << A.coeffs().transpose() << endl;
A.coeffs() += 10;
cout << "After adding 10 to every stored non zero coefficient, the matrix A is:" << endl << MatrixXd(A) << endl;

and the output is:

The matrix A is:
0 1 0
0 0 0
2 0 0
it has 3 stored non zero coefficients that are: 2 1 0
After adding 10 to every stored non zero coefficient, the matrix A is:
 0 11  0
 0  0 10
12  0  0

See also: valuePtr(), isCompressed()

◆ coeffs() [2/2]

template<typename Derived>

const Map< const Array< Scalar, Dynamic, 1 > > Eigen::SparseCompressedBase< Derived >::coeffs ( ) const

inline

Returns: a read-only view of the stored coefficients as a 1D array expression.

Warning: this method is for compressed storage only, and it will trigger an assertion otherwise.

See also: valuePtr(), isCompressed()

◆ innerIndexPtr() [1/2]

template<typename Derived>

StorageIndex * Eigen::SparseCompressedBase< Derived >::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 Derived>

const StorageIndex * Eigen::SparseCompressedBase< Derived >::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()

◆ innerIndicesAreSorted() [1/2]

template<typename Derived>

template<class Comp = std::less<>>

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

inline

Returns: the index of the first inner vector in the range [0,outerSize) that is not sorted with respect to Comp, or outerSize if the range is fully sorted

See also: sortInnerIndices()

◆ innerIndicesAreSorted() [2/2]

template<typename Derived>

template<class Comp = std::less<>>

Index Eigen::SparseCompressedBase< Derived >::innerIndicesAreSorted	(	Index	begin,
		Index	end ) const

inline

Returns: the index of the first inner vector in the range [begin,end) that is not sorted with respect to Comp, or end if the range is fully sorted

See also: sortInnerIndices()

◆ innerNonZeroPtr() [1/2]

template<typename Derived>

StorageIndex * Eigen::SparseCompressedBase< Derived >::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 Derived>

const StorageIndex * Eigen::SparseCompressedBase< Derived >::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

◆ isCompressed()

template<typename Derived>

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

inline

Returns: whether *this is in compressed form.

◆ nonZeros()

template<typename Derived>

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

inline

Returns: the number of non zero coefficients

◆ outerIndexPtr() [1/2]

template<typename Derived>

StorageIndex * Eigen::SparseCompressedBase< Derived >::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.

Warning: it returns the null pointer 0 for SparseVector

See also: valuePtr(), innerIndexPtr()

◆ outerIndexPtr() [2/2]

template<typename Derived>

const StorageIndex * Eigen::SparseCompressedBase< Derived >::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.

Warning: it returns the null pointer 0 for SparseVector

See also: valuePtr(), innerIndexPtr()

◆ sortInnerIndices() [1/2]

template<typename Derived>

template<class Comp = std::less<>>

void Eigen::SparseCompressedBase< Derived >::sortInnerIndices ( )

inline

sorts the inner vectors in the range [0,outerSize) with respect to Comp

See also: innerIndicesAreSorted()

◆ sortInnerIndices() [2/2]

template<typename Derived>

template<class Comp = std::less<>>

void Eigen::SparseCompressedBase< Derived >::sortInnerIndices	(	Index	begin,
		Index	end )

inline

sorts the inner vectors in the range [begin,end) with respect to Comp

See also: innerIndicesAreSorted()

◆ valuePtr() [1/2]

template<typename Derived>

Scalar * Eigen::SparseCompressedBase< Derived >::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 Derived>

const Scalar * Eigen::SparseCompressedBase< Derived >::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()

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

/builds/libeigen/eigen/Eigen/src/SparseCore/SparseCompressedBase.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SparseCompressedBase()

Member Function Documentation

◆ coeffs() [1/2]

◆ coeffs() [2/2]

◆ innerIndexPtr() [1/2]

◆ innerIndexPtr() [2/2]

◆ innerIndicesAreSorted() [1/2]

◆ innerIndicesAreSorted() [2/2]

◆ innerNonZeroPtr() [1/2]

◆ innerNonZeroPtr() [2/2]

◆ isCompressed()

◆ nonZeros()

◆ outerIndexPtr() [1/2]

◆ outerIndexPtr() [2/2]

◆ sortInnerIndices() [1/2]

◆ sortInnerIndices() [2/2]

◆ valuePtr() [1/2]

◆ valuePtr() [2/2]