Eigen::SparseMapBase< Derived, ReadOnlyAccessors > Class Template Reference

Common base class for Map and Ref instance of sparse matrix and vector. More...

#include <SparseMap.h>

Inheritance diagram for Eigen::SparseMapBase< Derived, ReadOnlyAccessors >:

Public Types
enum	{ IsRowMajor = Base::IsRowMajor }
typedef SparseCompressedBase< Derived >	Base
typedef Base::Scalar	Scalar
typedef Base::StorageIndex	StorageIndex
Public Types inherited from Eigen::SparseCompressedBase< Derived >
typedef SparseMatrixBase< Derived >	Base
Public Types inherited from Eigen::SparseMatrixBase< Derived >
enum	{   RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime , ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime , SizeAtCompileTime = (internal::size_of_xpr_at_compile_time<Derived>::ret) , MaxRowsAtCompileTime = RowsAtCompileTime ,   MaxColsAtCompileTime = ColsAtCompileTime , MaxSizeAtCompileTime = internal::size_at_compile_time(MaxRowsAtCompileTime, MaxColsAtCompileTime) , IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1 , NumDimensions ,   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
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::StorageIndex	StorageIndex
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType
typedef SparseMatrixBase	StorageBaseType
typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector
typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector
typedef std::conditional_t< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > >	AdjointReturnType
typedef Transpose< Derived >	TransposeReturnType
typedef Transpose< const Derived >	ConstTransposeReturnType
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex >	PlainObject
typedef NumTraits< Scalar >::Real	RealScalar
typedef std::conditional_t< HasDirectAccess_, const Scalar &, Scalar >	CoeffReturnType
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef Matrix< Scalar, internal::max_size_prefer_dynamic(RowsAtCompileTime, ColsAtCompileTime), internal::max_size_prefer_dynamic(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
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
Index	rows () const
Index	cols () const
Index	innerSize () const
Index	outerSize () const
Index	nonZeros () const
bool	isCompressed () const
const Scalar *	valuePtr () const
const StorageIndex *	innerIndexPtr () const
const StorageIndex *	outerIndexPtr () const
const StorageIndex *	innerNonZeroPtr () const
Scalar	coeff (Index row, Index col) const
	SparseMapBase (Index rows, Index cols, Index nnz, IndexPointer outerIndexPtr, IndexPointer innerIndexPtr, ScalarPointer valuePtr, IndexPointer innerNonZerosPtr=0)
	SparseMapBase (Index size, Index nnz, IndexPointer innerIndexPtr, ScalarPointer valuePtr)
	~SparseMapBase ()
template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)
Derived &	operator= (const Derived &other)
Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
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 ()
template<class Comp = std::less<>>
void	sortInnerIndices (Index begin, Index end)
template<class Comp = std::less<>>
Index	innerIndicesAreSorted (Index begin, Index end) const
template<class Comp = std::less<>>
void	sortInnerIndices ()
template<class Comp = std::less<>>
Index	innerIndicesAreSorted () const
template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)
Derived &	operator= (const Derived &other)
Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
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 >
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
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 ()
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()
constexpr 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
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< Derived, Device >	device (Device &device)
template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const Derived, Device >	device (Device &device) const

Protected Types
typedef std::conditional_t< bool(internal::is_lvalue< Derived >::value), Scalar *, const Scalar * >	ScalarPointer
typedef std::conditional_t< bool(internal::is_lvalue< Derived >::value), StorageIndex *, const StorageIndex * >	IndexPointer
Protected Types inherited from Eigen::SparseCompressedBase< Derived >
typedef Base::IndexVector	IndexVector

Protected Member Functions
	SparseMapBase ()
Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Eigen::Map< IndexVector >	innerNonZeros ()
const Eigen::Map< const IndexVector >	innerNonZeros () const
	SparseCompressedBase ()
internal::LowerBoundIndex	lower_bound (Index row, Index col) const
Protected Member Functions inherited from Eigen::SparseMatrixBase< Derived >
template<typename OtherDerived >
Derived &	assign (const OtherDerived &other)
template<typename OtherDerived >
void	assignGeneric (const OtherDerived &other)

Protected Attributes
Index	m_outerSize
Index	m_innerSize
Array< StorageIndex, 2, 1 >	m_zero_nnz
IndexPointer	m_outerIndex
IndexPointer	m_innerIndices
ScalarPointer	m_values
IndexPointer	m_innerNonZeros
Protected Attributes inherited from Eigen::SparseMatrixBase< Derived >
bool	m_isRValue

Additional Inherited Members
Static Protected Member Functions inherited from Eigen::SparseMatrixBase< Derived >
static StorageIndex	convert_index (const Index idx)

Detailed Description

template<typename Derived>
class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >

Common base class for Map and Ref instance of sparse matrix and vector.

class SparseMapBase

Member Typedef Documentation

Base

template<typename Derived >

typedef SparseCompressedBase<Derived> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Base

IndexPointer

template<typename Derived >

typedef std::conditional_t<bool(internal::is_lvalue<Derived>::value), StorageIndex*, const StorageIndex*> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::IndexPointer

protected

Scalar

template<typename Derived >

typedef Base::Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Scalar

ScalarPointer

template<typename Derived >

typedef std::conditional_t<bool(internal::is_lvalue<Derived>::value), Scalar*, const Scalar*> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::ScalarPointer

protected

StorageIndex

template<typename Derived >

typedef Base::StorageIndex Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::StorageIndex

Member Enumeration Documentation

anonymous enum

template<typename Derived >

anonymous enum

Enumerator
IsRowMajor

{ IsRowMajor = Base::IsRowMajor };

Constructor & Destructor Documentation

SparseMapBase() [1/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase ( Index  rows, Index  cols, Index  nnz, IndexPointer  outerIndexPtr, IndexPointer  innerIndexPtr, ScalarPointer  valuePtr, IndexPointer  innerNonZerosPtr = 0  )

inline

      : m_outerSize(IsRowMajor ? rows : cols),
        m_innerSize(IsRowMajor ? cols : rows),
        m_zero_nnz(0, internal::convert_index<StorageIndex>(nnz)),
        m_outerIndex(outerIndexPtr),
        m_innerIndices(innerIndexPtr),
        m_values(valuePtr),
        m_innerNonZeros(innerNonZerosPtr) {}

SparseMapBase() [2/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase ( Index  size, Index  nnz, IndexPointer  innerIndexPtr, ScalarPointer  valuePtr  )

inline

      : m_outerSize(1),
        m_innerSize(size),
        m_zero_nnz(0, internal::convert_index<StorageIndex>(nnz)),
        m_outerIndex(m_zero_nnz.data()),
        m_innerIndices(innerIndexPtr),
        m_values(valuePtr),
        m_innerNonZeros(0) {}

~SparseMapBase()

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::~SparseMapBase ( )

inline

Empty destructor

{}

SparseMapBase() [3/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase ( )

inlineprotected

{}

Member Function Documentation

coeff()

template<typename Derived >

Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

                                                  {
    const Index outer = IsRowMajor ? row : col;
    const Index inner = IsRowMajor ? col : row;
 
    Index start = m_outerIndex[outer];
    Index end = isCompressed() ? m_outerIndex[outer + 1] : start + m_innerNonZeros[outer];
    if (start == end)
      return Scalar(0);
    else if (end > 0 && inner == m_innerIndices[end - 1])
      return m_values[end - 1];
    // ^^  optimization: let's first check if it is the last coefficient
    // (very common in high level algorithms)
 
    const StorageIndex* r = std::lower_bound(&m_innerIndices[start], &m_innerIndices[end - 1], inner);
    const Index id = r - &m_innerIndices[0];
    return ((*r == inner) && (id < end)) ? m_values[id] : Scalar(0);
  }

References col(), Eigen::placeholders::end, UniformPSDSelfTest::r, row(), and oomph::CumulativeTimings::start().

cols()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::cols ( ) const

inline

Returns

the number of columns.

See also

rows()

{ return IsRowMajor ? m_innerSize : m_outerSize; }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

innerIndexPtr()

template<typename Derived >

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

{ return m_innerIndices; }

innerNonZeroPtr()

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

{ return m_innerNonZeros; }

innerSize()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

{ return m_innerSize; }

isCompressed()

template<typename Derived >

bool Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::isCompressed ( ) const

inline

Returns

whether *this is in compressed form.

{ return m_innerNonZeros == 0; }

nonZeros()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::nonZeros ( ) const

inline

Returns

the number of non zero coefficients

{ return m_zero_nnz[1]; }

operator=() [1/4]

template<typename Derived >

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

inline

                                                                         {
  internal::call_assignment_no_alias(derived(), other.derived());
  return derived();
}

operator=() [2/4]

template<typename Derived >

template<typename OtherDerived >

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

(

typename OtherDerived

)

                                                                                  {
  internal::call_assignment_no_alias(derived(), other.derived());
  return derived();
}

operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

(

typename OtherDerived

)

                                                                                      {
  // TODO use the evaluator mechanism
  other.evalTo(derived());
  return derived();
}

operator=() [4/4]

template<typename Derived >

template<typename OtherDerived >

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

inline

                                                                                                {
  // by default sparse evaluation do not alias, so we can safely bypass the generic call_assignment routine
  internal::Assignment<Derived, OtherDerived, internal::assign_op<Scalar, typename OtherDerived::Scalar>>::run(
      derived(), other.derived(), internal::assign_op<Scalar, typename OtherDerived::Scalar>());
  return derived();
}

outerIndexPtr()

template<typename Derived >

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

{ return m_outerIndex; }

outerSize()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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

{ return m_outerSize; }

rows()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::rows ( ) const

inline

Returns

the number of rows.

See also

cols()

{ return IsRowMajor ? m_outerSize : m_innerSize; }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

valuePtr()

template<typename Derived >

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

{ return m_values; }

Member Data Documentation

m_innerIndices

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerIndices

protected

m_innerNonZeros

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerNonZeros

protected

m_innerSize

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerSize

protected

m_outerIndex

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_outerIndex

protected

m_outerSize

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_outerSize

protected

m_values

template<typename Derived >

ScalarPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_values

protected

m_zero_nnz

template<typename Derived >

Array<StorageIndex, 2, 1> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_zero_nnz

protected

---

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

• SparseMap.h