Expression of a dense or sparse matrix with zero or too small values removed. More...

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

Inheritance diagram for Eigen::SparseView< MatrixType >:

Collaboration diagram for Eigen::SparseView< MatrixType >:

Public Types
typedef internal::remove_all< MatrixType >::type	NestedExpression

enum

typedef internal::traits< SparseView< MatrixType > >::Scalar	Scalar

typedef Scalar	value_type

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef internal::traits< SparseView< MatrixType > >::StorageKind	StorageKind

typedef internal::traits< SparseView< MatrixType > >::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< SparseView< MatrixType > >	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 Block< SparseView< MatrixType >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType

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

typedef Block< SparseView< MatrixType >, Dynamic, Dynamic, true >	InnerVectorsReturnType

typedef Block< const SparseView< MatrixType >, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType

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

Public Member Functions
	SparseView (const MatrixType &mat, const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision())

Index	rows () const

Index	cols () const

Index	innerSize () const

Index	outerSize () const

const internal::remove_all< MatrixTypeNested >::type &	nestedExpression () const

Scalar	reference () const

RealScalar	epsilon () const

const SparseView< MatrixType > &	derived () const

SparseView< MatrixType > &	derived ()

SparseView< MatrixType > &	const_cast_derived () const

Index	size () const

bool	isVector () const

bool	isRValue () const

SparseView< MatrixType > &	markAsRValue ()

SparseView< MatrixType > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

SparseView< MatrixType > &	operator+= (const DiagonalBase< OtherDerived > &other)

SparseView< MatrixType > &	operator+= (const EigenBase< OtherDerived > &other)

EIGEN_STRONG_INLINE SparseView< MatrixType > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

SparseView< MatrixType > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

SparseView< MatrixType > &	operator-= (const DiagonalBase< OtherDerived > &other)

SparseView< MatrixType > &	operator-= (const EigenBase< OtherDerived > &other)

EIGEN_STRONG_INLINE SparseView< MatrixType > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

SparseView< MatrixType > &	operator*= (const Scalar &other)

SparseView< MatrixType > &	operator*= (const SparseMatrixBase< OtherDerived > &other)

SparseView< MatrixType > &	operator/= (const Scalar &other)

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

EIGEN_STRONG_INLINE const SparseMatrixBase< SparseView< MatrixType > >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

const Product< SparseView< MatrixType >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const

const Product< SparseView< MatrixType >, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const

const Product< SparseView< MatrixType >, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const

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

const TriangularView< const SparseView< MatrixType >, Mode >	triangularView () const

ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const

SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()

SparseMatrixBase< SparseView< MatrixType > >::template ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const

SparseMatrixBase< SparseView< MatrixType > >::template SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()

Scalar	dot (const MatrixBase< OtherDerived > &other) const

Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

internal::traits< SparseView< MatrixType > >::Scalar	dot (const MatrixBase< OtherDerived > &other) const

internal::traits< SparseView< MatrixType > >::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

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

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

const internal::eval< SparseView< MatrixType > >::type	eval () const

Scalar	sum () const

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

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
SparseView< MatrixType > &	assign (const OtherDerived &other)

void	assignGeneric (const OtherDerived &other)

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

Protected Attributes
MatrixTypeNested	m_matrix

Scalar	m_reference

RealScalar	m_epsilon

bool	m_isRValue

Private Types
typedef MatrixType::Nested	MatrixTypeNested

typedef internal::remove_all< MatrixTypeNested >::type	_MatrixTypeNested

typedef SparseMatrixBase< SparseView >	Base

Private Member Functions
void	evalTo (Dest &) const

Detailed Description

template<typename MatrixType>
class Eigen::SparseView< MatrixType >

Expression of a dense or sparse matrix with zero or too small values removed.

Template Parameters

MatrixType the type of the object of which we are removing the small entries

This class represents an expression of a given dense or sparse matrix with entries smaller than reference * epsilon are removed. It is the return type of MatrixBase::sparseView() and SparseMatrixBase::pruned() and most of the time this is the only way it is used.

See also: MatrixBase::sparseView(), SparseMatrixBase::pruned()

Member Typedef Documentation

◆ _MatrixTypeNested

template<typename MatrixType >

typedef internal::remove_all<MatrixTypeNested>::type Eigen::SparseView< MatrixType >::_MatrixTypeNested

private

◆ AdjointReturnType

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

inherited

◆ Base

template<typename MatrixType >

typedef SparseMatrixBase<SparseView > Eigen::SparseView< MatrixType >::Base

private

◆ CoeffReturnType

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

inherited

◆ ConstantReturnType

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

inherited

◆ ConstInnerVectorReturnType

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

inherited

◆ ConstInnerVectorsReturnType

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

inherited

◆ ConstTransposeReturnType

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

inherited

◆ DenseMatrixType

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

inherited

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

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

inherited

◆ InnerVectorReturnType

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

inherited

◆ InnerVectorsReturnType

typedef Block<SparseView< MatrixType > ,Dynamic,Dynamic,true> Eigen::SparseMatrixBase< SparseView< MatrixType > >::InnerVectorsReturnType

inherited

◆ MatrixTypeNested

template<typename MatrixType >

typedef MatrixType::Nested Eigen::SparseView< MatrixType >::MatrixTypeNested

private

◆ NestedExpression

template<typename MatrixType >

typedef internal::remove_all<MatrixType>::type Eigen::SparseView< MatrixType >::NestedExpression

◆ PacketReturnType

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

inherited

◆ PacketScalar

typedef internal::packet_traits<Scalar>::type Eigen::SparseMatrixBase< SparseView< MatrixType > >::PacketScalar

inherited

◆ PlainObject

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

inherited

◆ RealScalar

typedef NumTraits<Scalar>::Real Eigen::SparseMatrixBase< SparseView< MatrixType > >::RealScalar

inherited

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

typedef internal::traits<SparseView< MatrixType > >::Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::Scalar

inherited

◆ ScalarVector

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

inherited

◆ SquareMatrixType

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

inherited

type of the equivalent square matrix

◆ StorageBaseType

typedef SparseMatrixBase Eigen::SparseMatrixBase< SparseView< MatrixType > >::StorageBaseType

inherited

◆ StorageIndex

typedef internal::traits<SparseView< MatrixType > >::StorageIndex Eigen::SparseMatrixBase< SparseView< MatrixType > >::StorageIndex

inherited

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

typedef internal::traits<SparseView< MatrixType > >::StorageKind Eigen::SparseMatrixBase< SparseView< MatrixType > >::StorageKind

inherited

◆ TransposeReturnType

typedef Transpose<SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::TransposeReturnType

inherited

◆ value_type

typedef Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::value_type

inherited

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

anonymous enum

inherited

         {
 
      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

◆ SparseView()

template<typename MatrixType >

Eigen::SparseView< MatrixType >::SparseView	(	const MatrixType &	mat,
		const Scalar &	reference = `Scalar(0)`,
		const RealScalar &	epsilon = `NumTraits<Scalar>::dummy_precision()`
	)

inlineexplicit

56 : m_matrix(mat), m_reference(reference), m_epsilon(epsilon) {}

Eigen::SparseView::reference

Scalar reference() const

Definition SparseView.h:68

Eigen::SparseView::m_reference

Scalar m_reference

Definition SparseView.h:73

Eigen::SparseView::m_epsilon

RealScalar m_epsilon

Definition SparseView.h:74

Eigen::SparseView::m_matrix

MatrixTypeNested m_matrix

Definition SparseView.h:72

Eigen::SparseView::epsilon

RealScalar epsilon() const

Definition SparseView.h:69

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

const AdjointReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::adjoint ( ) const

inlineinherited

351{ return AdjointReturnType(transpose()); }

Eigen::SparseMatrixBase< SparseView< MatrixType > >::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< SparseView< MatrixType > >::transpose

TransposeReturnType transpose()

Definition SparseMatrixBase.h:349

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

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

inlineprotectedinherited

◆ assignGeneric()

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

inlineprotectedinherited

◆ blueNorm()

NumTraits< typenameinternal::traits< SparseView< MatrixType > >::Scalar >::Real Eigen::SparseMatrixBase< SparseView< MatrixType > >::blueNorm

inlineinherited

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

◆ cols()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::cols ( ) const

inline

59{ return m_matrix.cols(); }

References Eigen::SparseView< MatrixType >::m_matrix.

◆ const_cast_derived()

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::const_cast_derived ( ) const

inlineinherited

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

Eigen::SparseMatrixBase< SparseView< MatrixType > >::SparseMatrixBase

SparseMatrixBase()

Definition SparseMatrixBase.h:192

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

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

inlinestaticprotectedinherited

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

◆ cwiseProduct() [1/2]

EIGEN_STRONG_INLINE const SparseMatrixBase< SparseView< MatrixType > >::template CwiseProductDenseReturnType< OtherDerived >::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseProduct ( const MatrixBase< OtherDerived > & other ) const

inherited

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

◆ cwiseProduct() [2/2]

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseProduct ( const MatrixBase< OtherDerived > & other ) const

inherited

◆ derived() [1/2]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::derived ( )

inlineinherited

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

◆ derived() [2/2]

const SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::derived ( ) const

inlineinherited

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

◆ dot() [1/4]

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

inherited

{
  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;
}

◆ dot() [2/4]

Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::dot ( const MatrixBase< OtherDerived > & other ) const

inherited

◆ dot() [3/4]

internal::traits< SparseView< MatrixType > >::Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::dot ( const SparseMatrixBase< OtherDerived > & other ) const

inherited

{
  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;
}

◆ dot() [4/4]

Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::dot ( const SparseMatrixBase< OtherDerived > & other ) const

inherited

◆ epsilon()

template<typename MatrixType >

RealScalar Eigen::SparseView< MatrixType >::epsilon ( ) const

inline

69{ return m_epsilon; }

References Eigen::SparseView< MatrixType >::m_epsilon.

Referenced by Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator(), and Eigen::internal::unary_evaluator< SparseView< ArgType >, IteratorBased >::InnerIterator::incrementToNonZero().

Here is the caller graph for this function:

◆ eval()

const internal::eval< SparseView< MatrixType > >::type Eigen::SparseMatrixBase< SparseView< MatrixType > >::eval ( ) const

inlineinherited

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

◆ evalTo()

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

privateinherited

◆ innerSize()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::innerSize ( ) const

inline

61{ return m_matrix.innerSize(); }

References Eigen::SparseView< MatrixType >::m_matrix.

◆ innerVector() [1/2]

SparseMatrixBase< SparseView< MatrixType > >::InnerVectorReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::innerVector ( Index outer )

inherited

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< SparseView< MatrixType > >::InnerVectorReturnType

Block< SparseView< MatrixType >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType

Definition SparseMatrixBase.h:354

◆ innerVector() [2/2]

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

inherited

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< SparseView< MatrixType > >::ConstInnerVectorReturnType

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

Definition SparseMatrixBase.h:355

◆ innerVectors() [1/2]

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

inherited

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]

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

inherited

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]

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

inlineinherited

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

Eigen::SparseMatrixBase< SparseView< MatrixType > >::toDense

DenseMatrixType toDense() const

Definition SparseMatrixBase.h:365

◆ isApprox() [2/2]

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

inherited

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

◆ isRValue()

bool Eigen::SparseMatrixBase< SparseView< MatrixType > >::isRValue ( ) const

inlineinherited

189{ return m_isRValue; }

Eigen::SparseMatrixBase< SparseView< MatrixType > >::m_isRValue

bool m_isRValue

Definition SparseMatrixBase.h:394

◆ isVector()

bool Eigen::SparseMatrixBase< SparseView< MatrixType > >::isVector ( ) const

inlineinherited

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

Eigen::SparseView::cols
Index cols() const
Definition SparseView.h:59

Eigen::SparseView::rows
Index rows() const
Definition SparseView.h:58

See also: rows(), cols(), IsVectorAtCompileTime.

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

◆ markAsRValue()

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::markAsRValue ( )

inlineinherited

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

◆ nestedExpression()

template<typename MatrixType >

const internal::remove_all< MatrixTypeNested >::type & Eigen::SparseView< MatrixType >::nestedExpression ( ) const

inline

Returns: the nested expression

66{ return m_matrix; }

References Eigen::SparseView< MatrixType >::m_matrix.

Referenced by Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator().

Here is the caller graph for this function:

◆ norm()

NumTraits< typenameinternal::traits< SparseView< MatrixType > >::Scalar >::Real Eigen::SparseMatrixBase< SparseView< MatrixType > >::norm

inlineinherited

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

◆ operator*() [1/3]

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

inlineinherited

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

◆ operator*() [2/3]

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

inlineinherited

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

◆ operator*() [3/3]

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

inlineinherited

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< SparseView< MatrixType > >::pruned
const SparseView< SparseView< MatrixType > > 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());
}

◆ operator*=() [1/2]

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

inherited

{
  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]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*= ( const SparseMatrixBase< OtherDerived > & other )

inherited

◆ operator+=() [1/4]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator+= ( const DiagonalBase< OtherDerived > & other )

inherited

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

◆ operator+=() [2/4]

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

inherited

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

◆ operator+=() [3/4]

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

inherited

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

◆ operator+=() [4/4]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator+= ( const SparseMatrixBase< OtherDerived > & other )

inherited

◆ operator-=() [1/4]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator-= ( const DiagonalBase< OtherDerived > & other )

inherited

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

◆ operator-=() [2/4]

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

inherited

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

◆ operator-=() [3/4]

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

inherited

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

◆ operator-=() [4/4]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator-= ( const SparseMatrixBase< OtherDerived > & other )

inherited

◆ operator/=()

EIGEN_STRONG_INLINE SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator/= ( const Scalar & other )

inherited

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

◆ outerSize()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::outerSize ( ) const

inline

62{ return m_matrix.outerSize(); }

References Eigen::SparseView< MatrixType >::m_matrix.

◆ pruned()

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

inlineinherited

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

◆ reference()

template<typename MatrixType >

Scalar Eigen::SparseView< MatrixType >::reference ( ) const

inline

68{ return m_reference; }

References Eigen::SparseView< MatrixType >::m_reference.

Referenced by Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator(), and Eigen::internal::unary_evaluator< SparseView< ArgType >, IteratorBased >::InnerIterator::incrementToNonZero().

Here is the caller graph for this function:

◆ rows()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::rows ( ) const

inline

58{ return m_matrix.rows(); }

References Eigen::SparseView< MatrixType >::m_matrix.

◆ selfadjointView() [1/4]

SelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::selfadjointView ( )

inlineinherited

◆ selfadjointView() [2/4]

SparseMatrixBase< SparseView< MatrixType > >::template SelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::selfadjointView ( )

inherited

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

◆ selfadjointView() [3/4]

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

inlineinherited

◆ selfadjointView() [4/4]

SparseMatrixBase< SparseView< MatrixType > >::template ConstSelfAdjointViewReturnType< UpLo >::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::selfadjointView ( ) const

inherited

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

◆ size()

Index Eigen::SparseMatrixBase< SparseView< MatrixType > >::size ( ) const

inlineinherited

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

See also: rows(), cols().

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

◆ squaredNorm()

NumTraits< typenameinternal::traits< SparseView< MatrixType > >::Scalar >::Real Eigen::SparseMatrixBase< SparseView< MatrixType > >::squaredNorm

inlineinherited

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

internal::traits< SparseView< MatrixType > >::Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::sum

inherited

{
  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;
}

◆ toDense()

DenseMatrixType Eigen::SparseMatrixBase< SparseView< MatrixType > >::toDense ( ) const

inlineinherited

    {
      return DenseMatrixType(derived());
    }

◆ transpose() [1/2]

TransposeReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::transpose ( )

inlineinherited

349{ return TransposeReturnType(derived()); }

Eigen::SparseMatrixBase< SparseView< MatrixType > >::TransposeReturnType

Transpose< SparseView< MatrixType > > TransposeReturnType

Definition SparseMatrixBase.h:110

◆ transpose() [2/2]

const ConstTransposeReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::transpose ( ) const

inlineinherited

350{ return ConstTransposeReturnType(derived()); }

Eigen::SparseMatrixBase< SparseView< MatrixType > >::ConstTransposeReturnType

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

Definition SparseMatrixBase.h:111

◆ triangularView()

const TriangularView< const SparseView< MatrixType > , Mode > Eigen::SparseMatrixBase< SparseView< MatrixType > >::triangularView

inlineinherited

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

◆ twistedBy()

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

inlineinherited

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

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

Member Data Documentation

◆ m_epsilon

template<typename MatrixType >

RealScalar Eigen::SparseView< MatrixType >::m_epsilon

protected

Referenced by Eigen::SparseView< MatrixType >::epsilon().

◆ m_isRValue

bool Eigen::SparseMatrixBase< SparseView< MatrixType > >::m_isRValue

protectedinherited

◆ m_matrix

template<typename MatrixType >

MatrixTypeNested Eigen::SparseView< MatrixType >::m_matrix

protected

Referenced by Eigen::SparseView< MatrixType >::cols(), Eigen::SparseView< MatrixType >::innerSize(), Eigen::SparseView< MatrixType >::nestedExpression(), Eigen::SparseView< MatrixType >::outerSize(), and Eigen::SparseView< MatrixType >::rows().

◆ m_reference

template<typename MatrixType >

Scalar Eigen::SparseView< MatrixType >::m_reference

protected

Referenced by Eigen::SparseView< MatrixType >::reference().

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

src/eigen/Eigen/src/Core/util/ForwardDeclarations.h
src/eigen/Eigen/src/SparseCore/SparseView.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ _MatrixTypeNested

◆ AdjointReturnType

◆ Base

◆ CoeffReturnType

◆ ConstantReturnType

◆ ConstInnerVectorReturnType

◆ ConstInnerVectorsReturnType

◆ ConstTransposeReturnType

◆ DenseMatrixType

◆ Index

◆ IndexVector

◆ InnerVectorReturnType

◆ InnerVectorsReturnType

◆ MatrixTypeNested

◆ NestedExpression

◆ PacketReturnType

◆ PacketScalar

◆ PlainObject

◆ RealScalar

◆ Scalar

◆ ScalarVector

◆ SquareMatrixType

◆ StorageBaseType

◆ StorageIndex

◆ StorageKind

◆ TransposeReturnType

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SparseView()

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]

◆ epsilon()

◆ eval()

◆ evalTo()

◆ innerSize()

◆ innerVector() [1/2]

◆ innerVector() [2/2]

◆ innerVectors() [1/2]

◆ innerVectors() [2/2]

◆ isApprox() [1/2]

◆ isApprox() [2/2]

◆ isRValue()

◆ isVector()

◆ markAsRValue()

◆ nestedExpression()

◆ norm()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]