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

#include <src/eigen/Eigen/src/SparseCore/SparseMatrixBase.h>

Inheritance diagram for Eigen::SparseMatrixBase< Derived >:

Collaboration 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 , 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< 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

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

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType

typedef EigenBase< Derived >	Base

typedef Block< Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType

typedef Block< const Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType

typedef Block< Derived, Dynamic, Dynamic, true >	InnerVectorsReturnType

typedef Block< const Derived, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType

typedef Eigen::Index	Index
	The interface type of indices.

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

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) 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 ()

EIGEN_DEVICE_FUNC const Derived &	const_derived () 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

Private Member Functions
template<typename Dest >
void	evalTo (Dest &) const

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.

Class Documentation

◆ Eigen::SparseMatrixBase::ConstSelfAdjointViewReturnType

struct Eigen::SparseMatrixBase::ConstSelfAdjointViewReturnType

template<typename Derived>
template<unsigned int UpLo>
struct Eigen::SparseMatrixBase< Derived >::ConstSelfAdjointViewReturnType< UpLo >

Class Members
typedef const SparseSelfAdjointView< const Derived, UpLo >	Type

◆ Eigen::SparseMatrixBase::CwiseProductDenseReturnType

struct Eigen::SparseMatrixBase::CwiseProductDenseReturnType

template<typename Derived>
template<typename OtherDerived>
struct Eigen::SparseMatrixBase< Derived >::CwiseProductDenseReturnType< OtherDerived >

Class Members
typedef Scalar, typename Scalar >::ReturnType >, const Derived, const OtherDerived >	Type

◆ Eigen::SparseMatrixBase::SelfAdjointViewReturnType

struct Eigen::SparseMatrixBase::SelfAdjointViewReturnType

template<typename Derived>
template<unsigned int UpLo>
struct Eigen::SparseMatrixBase< Derived >::SelfAdjointViewReturnType< UpLo >

Class Members
typedef SparseSelfAdjointView< Derived, UpLo >	Type

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

◆ ConstInnerVectorReturnType

template<typename Derived >

typedef Block<const Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::SparseMatrixBase< Derived >::ConstInnerVectorReturnType

◆ ConstInnerVectorsReturnType

template<typename Derived >

typedef Block<const Derived,Dynamic,Dynamic,true> Eigen::SparseMatrixBase< Derived >::ConstInnerVectorsReturnType

◆ 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

◆ Index

template<typename Derived >

typedef Eigen::Index Eigen::EigenBase< Derived >::Index

inherited

The interface type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also: StorageIndex, TopicPreprocessorDirectives.

◆ IndexVector

template<typename Derived >

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

◆ InnerVectorReturnType

template<typename Derived >

typedef Block<Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::SparseMatrixBase< Derived >::InnerVectorReturnType

◆ InnerVectorsReturnType

template<typename Derived >

typedef Block<Derived,Dynamic,Dynamic,true> Eigen::SparseMatrixBase< Derived >::InnerVectorsReturnType

◆ 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).
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

         {
 
      RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
      ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
      SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
                                                   internal::traits<Derived>::ColsAtCompileTime>::ret),
      MaxRowsAtCompileTime = RowsAtCompileTime,
      MaxColsAtCompileTime = ColsAtCompileTime,
 
      MaxSizeAtCompileTime = (internal::size_at_compile_time<MaxRowsAtCompileTime,
                                                      MaxColsAtCompileTime>::ret),
 
      IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1,
      Flags = internal::traits<Derived>::Flags,
      IsRowMajor = Flags&RowMajorBit ? 1 : 0,
      
      InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
                             : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),
 
      #ifndef EIGEN_PARSED_BY_DOXYGEN
      _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0 // workaround sunCC
      #endif
    };

Constructor & Destructor Documentation

◆ SparseMatrixBase()

template<typename Derived >

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

inline

192: m_isRValue(false) { /* TODO check flags */ }

Eigen::SparseMatrixBase::m_isRValue

bool m_isRValue

Definition SparseMatrixBase.h:394

Member Function Documentation

◆ addTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::addTo ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst += res;
  }

◆ adjoint()

template<typename Derived >

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

inline

351{ return AdjointReturnType(transpose()); }

Eigen::SparseMatrixBase::AdjointReturnType

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

Definition SparseMatrixBase.h:109

Eigen::SparseMatrixBase::transpose

TransposeReturnType transpose()

Definition SparseMatrixBase.h:349

References Eigen::SparseMatrixBase< Derived >::transpose().

Referenced by Eigen::IncompleteCholesky< Scalar, _UpLo, _OrderingType >::_solve_impl(), and Eigen::SparseSelfAdjointView< MatrixType, _Mode >::rankUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyThisOnTheLeft()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheLeft ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = this->derived() * dst;
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ applyThisOnTheRight()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheRight ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = dst * this->derived();
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ 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

{
  return internal::blueNorm_impl(*this);
}

References Eigen::internal::blueNorm_impl().

Here is the call graph for this function:

◆ cols()

template<typename Derived >

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

inline

Returns: the number of columns.

See also: rows()

173{ return derived().cols(); }

Eigen::SparseMatrixBase::derived

const Derived & derived() const

Definition SparseMatrixBase.h:138

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by Eigen::SparseMatrixBase< Derived >::innerSize(), Eigen::SparseMatrixBase< Derived >::isVector(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseMatrixBase< Derived >::outerSize(), and Eigen::SparseMatrixBase< Derived >::size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ const_cast_derived()

template<typename Derived >

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

inline

141 { return *static_cast<Derived*>(const_cast<SparseMatrixBase*>(this)); }

Eigen::SparseMatrixBase::SparseMatrixBase

SparseMatrixBase()

Definition SparseMatrixBase.h:192

Referenced by Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::internal::evaluator< DynamicSparseMatrix< _Scalar, _Options, _StorageIndex > >::operator SparseMatrixType &(), Eigen::internal::evaluator< SparseVector< _Scalar, _Options, _Index > >::operator SparseVectorType &(), Eigen::DynamicSparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::viewAsCholmod(), and Eigen::viewAsCholmod().

Here is the caller graph for this function:

◆ const_derived()

template<typename Derived >

EIGEN_DEVICE_FUNC const Derived & Eigen::EigenBase< Derived >::const_derived ( ) const

inlineinherited

55 { return *static_cast<const Derived*>(this); }

◆ convert_index()

template<typename Derived >

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

inlinestaticprotected

                                                              {
      return internal::convert_index<StorageIndex>(idx);
    }

Referenced by Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::conservativeResize().

Here is the caller graph for this function:

◆ 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

{
  return typename CwiseProductDenseReturnType<OtherDerived>::Type(derived(), other.derived());
}

◆ 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

Referenced by Eigen::MatrixBase< Derived >::cwiseProduct().

Here is the caller graph for this function:

◆ derived() [1/2]

template<typename Derived >

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

inline

139{ return *static_cast<Derived*>(this); }

◆ derived() [2/2]

template<typename Derived >

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

inline

138{ return *static_cast<const Derived*>(this); }

◆ dot() [1/4]

template<typename Derived >

template<typename OtherDerived >

internal::traits< Derived >::Scalar Eigen::SparseMatrixBase< Derived >::dot ( const MatrixBase< OtherDerived > & other ) const

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(OtherDerived)
  EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(Derived,OtherDerived)
  EIGEN_STATIC_ASSERT((internal::is_same<Scalar, typename OtherDerived::Scalar>::value),
    YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY)
 
  eigen_assert(size() == other.size());
  eigen_assert(other.size()>0 && "you are using a non initialized vector");
 
  internal::evaluator<Derived> thisEval(derived());
  typename internal::evaluator<Derived>::InnerIterator i(thisEval, 0);
  Scalar res(0);
  while (i)
  {
    res += numext::conj(i.value()) * other.coeff(i.index());
    ++i;
  }
  return res;
}

References eigen_assert, EIGEN_STATIC_ASSERT, EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE, and EIGEN_STATIC_ASSERT_VECTOR_ONLY.

◆ 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

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(OtherDerived)
  EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE(Derived,OtherDerived)
  EIGEN_STATIC_ASSERT((internal::is_same<Scalar, typename OtherDerived::Scalar>::value),
    YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY)
 
  eigen_assert(size() == other.size());
 
  internal::evaluator<Derived> thisEval(derived());
  typename internal::evaluator<Derived>::InnerIterator i(thisEval, 0);
  
  internal::evaluator<OtherDerived>  otherEval(other.derived());
  typename internal::evaluator<OtherDerived>::InnerIterator j(otherEval, 0);
 
  Scalar res(0);
  while (i && j)
  {
    if (i.index()==j.index())
    {
      res += numext::conj(i.value()) * j.value();
      ++i; ++j;
    }
    else if (i.index()<j.index())
      ++i;
    else
      ++j;
  }
  return res;
}

References Eigen::SparseMatrixBase< Derived >::derived(), eigen_assert, EIGEN_STATIC_ASSERT, EIGEN_STATIC_ASSERT_SAME_VECTOR_SIZE, EIGEN_STATIC_ASSERT_VECTOR_ONLY, and Eigen::SparseMatrixBase< Derived >::size().

Here is the call graph for this function:

◆ 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.

385 { return typename internal::eval<Derived>::type(derived()); }

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by igl::biharmonic_coordinates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evalTo()

template<typename Derived >

template<typename Dest >

void Eigen::SparseMatrixBase< Derived >::evalTo ( Dest & ) const

private

◆ 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

187{ return (int(Flags)&RowMajorBit) ? this->cols() : this->rows(); }

Eigen::SparseMatrixBase::rows

Index rows() const

Definition SparseMatrixBase.h:171

Eigen::SparseMatrixBase::cols

Index cols() const

Definition SparseMatrixBase.h:173

References Eigen::SparseMatrixBase< Derived >::cols(), Eigen::SparseMatrixBase< Derived >::Flags, Eigen::RowMajorBit, and Eigen::SparseMatrixBase< Derived >::rows().

Here is the call graph for this function:

◆ innerVector() [1/2]

template<typename Derived >

SparseMatrixBase< Derived >::InnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index outer )

Returns: the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

334{ return InnerVectorReturnType(derived(), outer); }

Eigen::SparseMatrixBase::InnerVectorReturnType

Block< Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType

Definition SparseMatrixBase.h:354

◆ innerVector() [2/2]

template<typename Derived >

const SparseMatrixBase< Derived >::ConstInnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index outer ) const

Returns: the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

341{ return ConstInnerVectorReturnType(derived(), outer); }

Eigen::SparseMatrixBase::ConstInnerVectorReturnType

Block< const Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType

Definition SparseMatrixBase.h:355

◆ innerVectors() [1/2]

template<typename Derived >

SparseMatrixBase< Derived >::InnerVectorsReturnType Eigen::SparseMatrixBase< Derived >::innerVectors	(	Index	outerStart,
		Index	outerSize
	)

Returns: the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

{
  return Block<Derived,Dynamic,Dynamic,true>(derived(),
                                             IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
                                             IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
 
}

◆ innerVectors() [2/2]

template<typename Derived >

const SparseMatrixBase< Derived >::ConstInnerVectorsReturnType Eigen::SparseMatrixBase< Derived >::innerVectors	(	Index	outerStart,
		Index	outerSize
	)		const

Returns: the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

{
  return Block<const Derived,Dynamic,Dynamic,true>(derived(),
                                                  IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
                                                  IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
 
}

◆ 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

377 { return toDense().isApprox(other,prec); }

Eigen::SparseMatrixBase::toDense

DenseMatrixType toDense() const

Definition SparseMatrixBase.h:365

References Eigen::SparseMatrixBase< Derived >::toDense().

Here is the call graph for this function:

◆ 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

{
  const typename internal::nested_eval<Derived,2,PlainObject>::type actualA(derived());
  typename internal::conditional<bool(IsRowMajor)==bool(OtherDerived::IsRowMajor),
    const typename internal::nested_eval<OtherDerived,2,PlainObject>::type,
    const PlainObject>::type actualB(other.derived());
 
  return (actualA - actualB).squaredNorm() <= prec * prec * numext::mini(actualA.squaredNorm(), actualB.squaredNorm());
}

References Eigen::SparseMatrixBase< Derived >::derived(), and Eigen::numext::mini().

Here is the call graph for this function:

◆ isRValue()

template<typename Derived >

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

inline

189{ return m_isRValue; }

References Eigen::SparseMatrixBase< Derived >::m_isRValue.

Referenced by Eigen::DynamicSparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), and Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator=().

Here is the caller graph for this function:

◆ 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.

181{ return rows()==1 || cols()==1; }

References Eigen::SparseMatrixBase< Derived >::cols(), and Eigen::SparseMatrixBase< Derived >::rows().

Here is the call graph for this function:

◆ markAsRValue()

template<typename Derived >

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

inline

190{ m_isRValue = true; return derived(); }

References Eigen::SparseMatrixBase< Derived >::derived(), and Eigen::SparseMatrixBase< Derived >::m_isRValue.

Here is the call graph for this function:

◆ norm()

template<typename Derived >

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

inline

{
  using std::sqrt;
  return sqrt(squaredNorm());
}

References sqrt().

Referenced by Eigen::SPQR< _MatrixType >::compute(), and Eigen::MatrixMarketIterator< Scalar >::matrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator*() [1/3]

template<typename Derived >

template<typename OtherDerived >

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

inline

298 { return Product<Derived,OtherDerived>(derived(), other.derived()); }

References Eigen::DiagonalBase< Derived >::derived(), and Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ operator*() [2/3]

template<typename Derived >

template<typename OtherDerived >

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

inline

315 { return Product<Derived,OtherDerived>(derived(), other.derived()); }

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ 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(); // supress numerical zeros (exact)

C = (A*B).pruned(ref);

C = (A*B).pruned(ref,epsilon);

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

where ref is a meaningful non zero reference value.

{
  return Product<Derived,OtherDerived,AliasFreeProduct>(derived(), other.derived());
}

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ operator*=() [1/2]

template<typename Derived >

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

{
  typedef typename internal::evaluator<Derived>::InnerIterator EvalIterator;
  internal::evaluator<Derived> thisEval(derived());
  for (Index j=0; j<outerSize(); ++j)
    for (EvalIterator i(thisEval,j); i; ++i)
      i.valueRef() *= other;
  return derived();
}

◆ 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 )

{
  call_assignment_no_alias(derived(), other.derived(), internal::add_assign_op<Scalar,typename OtherDerived::Scalar>());
  return derived();
}

References Eigen::DiagonalBase< Derived >::derived().

Here is the call graph for this function:

◆ operator+=() [2/4]

template<typename Derived >

template<typename OtherDerived >

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

{
  call_assignment(derived(), other.derived(), internal::add_assign_op<Scalar,typename OtherDerived::Scalar>());
  return derived();
}

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ operator+=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

{
  return derived() = derived() + other.derived();
}

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ 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 )

{
  call_assignment_no_alias(derived(), other.derived(), internal::sub_assign_op<Scalar,typename OtherDerived::Scalar>());
  return derived();
}

References Eigen::DiagonalBase< Derived >::derived().

Here is the call graph for this function:

◆ operator-=() [2/4]

template<typename Derived >

template<typename OtherDerived >

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

{
  call_assignment(derived(), other.derived(), internal::assign_op<Scalar,typename OtherDerived::Scalar>());
  return derived();
}

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ operator-=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

{
  return derived() = derived() - other.derived();
}

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ 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 )

{
  typedef typename internal::evaluator<Derived>::InnerIterator EvalIterator;
  internal::evaluator<Derived> thisEval(derived());
  for (Index j=0; j<outerSize(); ++j)
    for (EvalIterator i(thisEval,j); i; ++i)
      i.valueRef() /= other;
  return derived();
}

◆ operator=() [1/4]

template<typename Derived >

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

inline

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

References Eigen::internal::call_assignment_no_alias().

Here is the call graph for this function:

◆ operator=() [2/4]

template<typename Derived >

template<typename OtherDerived >

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

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

References Eigen::internal::call_assignment_no_alias(), and Eigen::EigenBase< Derived >::derived().

Referenced by Eigen::DynamicSparseMatrix< _Scalar, _Options, _StorageIndex >::DynamicSparseMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

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

References Eigen::ReturnByValue< Derived >::evalTo().

Here is the call graph for this function:

◆ operator=() [4/4]

template<typename Derived >

template<typename OtherDerived >

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

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();
}

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ 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

184{ return (int(Flags)&RowMajorBit) ? this->rows() : this->cols(); }

References Eigen::SparseMatrixBase< Derived >::cols(), Eigen::SparseMatrixBase< Derived >::Flags, Eigen::RowMajorBit, and Eigen::SparseMatrixBase< Derived >::rows().

Referenced by Eigen::SparseCompressedBase< Derived >::nonZeros().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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.

{
  return SparseView<Derived>(derived(), reference, epsilon);
}

◆ rows()

template<typename Derived >

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

inline

Returns: the number of rows.

See also: cols()

171{ return derived().rows(); }

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by Eigen::SparseMatrixBase< Derived >::innerSize(), Eigen::SparseMatrixBase< Derived >::isVector(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseMatrixBase< Derived >::outerSize(), Eigen::SparseMatrixBase< Derived >::size(), and Eigen::SparseQR< _MatrixType, _OrderingType >::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 ( )

{
  return SparseSelfAdjointView<Derived, UpLo>(derived());
}

References Eigen::EigenBase< SparseSelfAdjointView< MatrixType, _Mode > >::derived().

Here is the call graph for this function:

◆ 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

{
  return SparseSelfAdjointView<const Derived, UpLo>(derived());
}

References Eigen::EigenBase< SparseSelfAdjointView< MatrixType, _Mode > >::derived().

Here is the call graph for this function:

◆ size()

template<typename Derived >

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

inline

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

See also: rows(), cols().

176{ return rows() * cols(); }

References Eigen::SparseMatrixBase< Derived >::cols(), and Eigen::SparseMatrixBase< Derived >::rows().

Referenced by igl::active_set(), igl::cat(), igl::diag(), Eigen::SparseMatrixBase< Derived >::dot(), Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::finalize(), igl::invert_diag(), igl::min_quad_with_fixed_precompute(), Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator=(), Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator=(), and Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >::resizeNonZeros().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ squaredNorm()

template<typename Derived >

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

inline

{
  return numext::real((*this).cwiseAbs2().sum());
}

◆ subTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::subTo ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst -= res;
  }

References Eigen::EigenBase< Derived >::cols(), Eigen::EigenBase< Derived >::evalTo(), and Eigen::EigenBase< Derived >::rows().

Here is the call graph for this function:

◆ sum()

template<typename Derived >

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

{
  eigen_assert(rows()>0 && cols()>0 && "you are using a non initialized matrix");
  Scalar res(0);
  internal::evaluator<Derived> thisEval(derived());
  for (Index j=0; j<outerSize(); ++j)
    for (typename internal::evaluator<Derived>::InnerIterator iter(thisEval,j); iter; ++iter)
      res += iter.value();
  return res;
}

References eigen_assert.

◆ toDense()

template<typename Derived >

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

inline

    {
      return DenseMatrixType(derived());
    }

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by Eigen::SparseMatrixBase< Derived >::isApprox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transpose() [1/2]

template<typename Derived >

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

inline

349{ return TransposeReturnType(derived()); }

Eigen::SparseMatrixBase::TransposeReturnType

Transpose< Derived > TransposeReturnType

Definition SparseMatrixBase.h:110

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by Eigen::SparseMatrixBase< Derived >::adjoint(), Eigen::IncompleteLUT< _Scalar, _StorageIndex >::analyzePattern(), igl::arap_dof_precomputation(), igl::AtA_cached_precompute(), igl::slim::build_linear_system(), igl::copyleft::comiso::PoissonSolver< DerivedV, DerivedF >::BuildLaplacianMatrix(), Eigen::PastixLU< _MatrixType, IsStrSym >::grabMatrix(), igl::hessian(), igl::hessian_energy(), igl::min_quad_with_fixed_precompute(), igl::mosek::mosek_quadprog(), igl::orientable_patches(), igl::shapeup_precomputation(), and igl::straighten_seams().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transpose() [2/2]

template<typename Derived >

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

inline

350{ return ConstTransposeReturnType(derived()); }

Eigen::SparseMatrixBase::ConstTransposeReturnType

internal::add_const< Transpose< constDerived > >::type ConstTransposeReturnType

Definition SparseMatrixBase.h:111

References Eigen::SparseMatrixBase< Derived >::derived().

Here is the call graph for this function:

◆ triangularView()

template<typename Derived >

template<int Mode>

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

inline

{
  return TriangularView<const Derived, Mode>(derived());
}

Referenced by igl::mosek::mosek_quadprog().

Here is the caller graph for this function:

◆ 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

    {
      return SparseSymmetricPermutationProduct<Derived,Upper|Lower>(derived(), perm);
    }

References Eigen::SparseMatrixBase< Derived >::derived().

Referenced by Eigen::IncompleteLUT< _Scalar, _StorageIndex >::factorize(), Eigen::IncompleteCholesky< Scalar, _UpLo, _OrderingType >::factorize(), Eigen::PardisoLLT< MatrixType, _UpLo >::getMatrix(), and Eigen::PardisoLDLT< MatrixType, Options >::getMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ operator* [1/2]

template<typename Derived >

template<typename OtherDerived >

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

friend

304 { return Product<OtherDerived,Derived>(lhs.derived(), rhs.derived()); }

◆ operator* [2/2]

template<typename Derived >

template<typename OtherDerived >

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

friend

321 { return Product<OtherDerived,Derived>(lhs.derived(), rhs.derived()); }

◆ operator<<

template<typename Derived >

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

friend

    {
      typedef typename Derived::Nested Nested;
      typedef typename internal::remove_all<Nested>::type NestedCleaned;
 
      if (Flags&RowMajorBit)
      {
        Nested nm(m.derived());
        internal::evaluator<NestedCleaned> thisEval(nm);
        for (Index row=0; row<nm.outerSize(); ++row)
        {
          Index col = 0;
          for (typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval, row); it; ++it)
          {
            for ( ; col<it.index(); ++col)
              s << "0 ";
            s << it.value() << " ";
            ++col;
          }
          for ( ; col<m.cols(); ++col)
            s << "0 ";
          s << std::endl;
        }
      }
      else
      {
        Nested nm(m.derived());
        internal::evaluator<NestedCleaned> thisEval(nm);
        if (m.cols() == 1) {
          Index row = 0;
          for (typename internal::evaluator<NestedCleaned>::InnerIterator it(thisEval, 0); it; ++it)
          {
            for ( ; row<it.index(); ++row)
              s << "0" << std::endl;
            s << it.value() << std::endl;
            ++row;
          }
          for ( ; row<m.rows(); ++row)
            s << "0" << std::endl;
        }
        else
        {
          SparseMatrix<Scalar, RowMajorBit, StorageIndex> trans = m;
          s << static_cast<const SparseMatrixBase<SparseMatrix<Scalar, RowMajorBit, StorageIndex> >&>(trans);
        }
      }
      return s;
    }

Member Data Documentation

◆ m_isRValue

template<typename Derived >

bool Eigen::SparseMatrixBase< Derived >::m_isRValue

protected

Referenced by Eigen::SparseMatrixBase< Derived >::isRValue(), and Eigen::SparseMatrixBase< Derived >::markAsRValue().

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

src/eigen/Eigen/src/Core/util/ForwardDeclarations.h
src/eigen/Eigen/src/SparseCore/SparseMatrixBase.h
src/eigen/Eigen/src/SparseCore/SparseAssign.h
src/eigen/Eigen/src/SparseCore/SparseBlock.h
src/eigen/Eigen/src/SparseCore/SparseCwiseBinaryOp.h
src/eigen/Eigen/src/SparseCore/SparseCwiseUnaryOp.h
src/eigen/Eigen/src/SparseCore/SparseDot.h
src/eigen/Eigen/src/SparseCore/SparseFuzzy.h
src/eigen/Eigen/src/SparseCore/SparseProduct.h
src/eigen/Eigen/src/SparseCore/SparseRedux.h
src/eigen/Eigen/src/SparseCore/SparseSelfAdjointView.h
src/eigen/Eigen/src/SparseCore/SparseTriangularView.h
src/eigen/Eigen/src/SparseCore/SparseView.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Class Documentation

◆ Eigen::SparseMatrixBase::ConstSelfAdjointViewReturnType

◆ Eigen::SparseMatrixBase::CwiseProductDenseReturnType

◆ Eigen::SparseMatrixBase::SelfAdjointViewReturnType

Member Typedef Documentation

◆ AdjointReturnType

◆ Base

◆ CoeffReturnType

◆ ConstantReturnType

◆ ConstInnerVectorReturnType

◆ ConstInnerVectorsReturnType

◆ ConstTransposeReturnType

◆ DenseMatrixType

◆ Index

◆ IndexVector

◆ InnerVectorReturnType

◆ InnerVectorsReturnType

◆ PacketReturnType

◆ PacketScalar

◆ PlainObject

◆ RealScalar

◆ Scalar

◆ ScalarVector

◆ SquareMatrixType

◆ StorageBaseType

◆ StorageIndex

◆ StorageKind

◆ TransposeReturnType

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SparseMatrixBase()

Member Function Documentation

◆ addTo()

◆ adjoint()

◆ applyThisOnTheLeft()

◆ applyThisOnTheRight()

◆ assign()

◆ assignGeneric()

◆ blueNorm()

◆ cols()

◆ const_cast_derived()

◆ const_derived()

◆ convert_index()

◆ cwiseProduct() [1/2]

◆ cwiseProduct() [2/2]

◆ derived() [1/2]

◆ derived() [2/2]

◆ dot() [1/4]

◆ dot() [2/4]

◆ dot() [3/4]

◆ dot() [4/4]

◆ eval()

◆ evalTo()

◆ innerSize()

◆ innerVector() [1/2]

◆ innerVector() [2/2]

◆ innerVectors() [1/2]

◆ innerVectors() [2/2]

◆ isApprox() [1/2]

◆ isApprox() [2/2]

◆ isRValue()

◆ isVector()

◆ markAsRValue()

◆ norm()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]