Eigen::SparseView< MatrixType > Class Template Reference

---

Detailed Description

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

Definition at line 45 of file Sparse.

Inheritance diagram for Eigen::SparseView< MatrixType >:

List of all members.

Classes
class	InnerIterator
Public Types
enum
typedef internal::traits < SparseView< MatrixType > >::Scalar	Scalar
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef internal::traits < SparseView< MatrixType > >::StorageKind	StorageKind
typedef internal::traits < SparseView< MatrixType > >::Index	Index
typedef SparseMatrixBase	StorageBaseType
typedef EigenBase< SparseView < MatrixType > >	Base
typedef internal::conditional < NumTraits< Scalar > ::IsComplex, CwiseUnaryOp < internal::scalar_conjugate_op < Scalar >, Eigen::Transpose < const SparseView< MatrixType > > >, Transpose< const SparseView< MatrixType > > >::type	AdjointReturnType
typedef SparseMatrix< Scalar, Flags &RowMajorBit?RowMajor:ColMajor >	PlainObject
Public Member Functions
	SparseView (const MatrixType &mat, const Scalar &m_reference=Scalar(0), typename NumTraits< Scalar >::Real m_epsilon=NumTraits< Scalar >::dummy_precision())
Index	rows () const
Index	cols () const
Index	innerSize () const
Index	outerSize () const
const CwiseUnaryOp < internal::scalar_opposite_op < typename internal::traits < SparseView< MatrixType > >::Scalar >, const SparseView < MatrixType > >	operator- () const
const ScalarMultipleReturnType	operator* (const Scalar &scalar) const
const ScalarMultipleReturnType	operator* (const RealScalar &scalar) const
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const SparseView < MatrixType > >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.
const SparseSparseProductReturnType < SparseView< MatrixType > , OtherDerived >::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const
const SparseDiagonalProduct < SparseView< MatrixType > , OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const
const SparseDenseProductReturnType < SparseView< MatrixType > , OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const
	sparse * dense (returns a dense object unless it is an outer product)
const CwiseUnaryOp < internal::scalar_quotient1_op < typename internal::traits < SparseView< MatrixType > >::Scalar >, const SparseView < MatrixType > >	operator/ (const Scalar &scalar) const
internal::cast_return_type < SparseView< MatrixType > , const CwiseUnaryOp < internal::scalar_cast_op < typename internal::traits < SparseView< MatrixType > >::Scalar, NewType >, const SparseView< MatrixType > > >::type	cast () const
ConjugateReturnType	conjugate () const
RealReturnType	real () const
NonConstRealReturnType	real ()
const ImagReturnType	imag () const
NonConstImagReturnType	imag ()
const CwiseUnaryOp < CustomUnaryOp, const SparseView< MatrixType > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.
const CwiseUnaryView < CustomViewOp, const SparseView< MatrixType > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseView< MatrixType > , const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const SparseView < MatrixType > >	cwiseAbs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const SparseView < MatrixType > >	cwiseAbs2 () const
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const SparseView < MatrixType > >	cwiseSqrt () const
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const SparseView < MatrixType > >	cwiseInverse () const
const CwiseUnaryOp < std::binder1st < std::equal_to< Scalar > >, const SparseView < MatrixType > >	cwiseEqual (const Scalar &s) const
const CwiseBinaryOp < std::equal_to< Scalar > , const SparseView< MatrixType > , const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (SparseView< MatrixType >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseBinaryOp < std::not_equal_to< Scalar > , const SparseView< MatrixType > , const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const SparseView < MatrixType >, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const SparseView < MatrixType >, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const SparseView < MatrixType >, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
Index	size () const
Index	nonZeros () const
bool	isVector () const
bool	isRValue () const
SparseView< MatrixType > &	markAsRValue ()
void	assignGeneric (const OtherDerived &other)
void	_experimentalNewProduct (const Lhs &lhs, const Rhs &rhs)
SparseView< MatrixType > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
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 EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE	cwiseProduct (const MatrixBase< OtherDerived > &other) const
const SparseTriangularView < SparseView< MatrixType > , Mode >	triangularView () const
const SparseSelfAdjointView < SparseView< MatrixType > , UpLo >	selfadjointView () const
SparseSelfAdjointView < SparseView< MatrixType > , UpLo >	selfadjointView ()
Scalar	dot (const MatrixBase< OtherDerived > &other) const
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
RealScalar	squaredNorm () const
RealScalar	norm () const
Transpose< SparseView < MatrixType > >	transpose ()
const Transpose< const SparseView< MatrixType > >	transpose () const
const AdjointReturnType	adjoint () const
SparseInnerVectorSet < SparseView< MatrixType >, 1 >	row (Index i)
const SparseInnerVectorSet < SparseView< MatrixType >, 1 >	row (Index i) const
SparseInnerVectorSet < SparseView< MatrixType >, 1 >	col (Index j)
const SparseInnerVectorSet < SparseView< MatrixType >, 1 >	col (Index j) const
SparseInnerVectorSet < SparseView< MatrixType >, 1 >	innerVector (Index outer)
const SparseInnerVectorSet < SparseView< MatrixType >, 1 >	innerVector (Index outer) const
SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	subrows (Index start, Index size)
const SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	subrows (Index start, Index size) const
SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	subcols (Index start, Index size)
const SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	subcols (Index start, Index size) const
SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	innerVectors (Index outerStart, Index outerSize)
const SparseInnerVectorSet < SparseView< MatrixType > , Dynamic >	innerVectors (Index outerStart, Index outerSize) const
void	evalTo (MatrixBase< DenseDerived > &dst) const
void	evalTo (Dest &dst) const
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApprox (const MatrixBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval < SparseView< MatrixType > >::type	eval () const
Scalar	sum () const
SparseView< MatrixType > &	derived ()
const SparseView< MatrixType > &	derived () const
SparseView< MatrixType > &	const_cast_derived () const
const SparseView< MatrixType > &	const_derived () const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
Protected Attributes
const MatrixTypeNested	m_matrix
Scalar	m_reference
NumTraits< Scalar >::Real	m_epsilon
bool	m_isRValue
Private Types
typedef MatrixType::Nested	MatrixTypeNested
typedef internal::remove_all < MatrixTypeNested >::type	_MatrixTypeNested
Friends
const ScalarMultipleReturnType	operator* (const Scalar &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const SparseView < MatrixType > >	operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
const SparseDiagonalProduct < OtherDerived, SparseView < MatrixType > >	operator* (const DiagonalBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)
const DenseSparseProductReturnType < OtherDerived, SparseView < MatrixType > >::Type	operator* (const MatrixBase< OtherDerived > &lhs, const SparseView< MatrixType > &rhs)
	dense * sparse (return a dense object unless it is an outer product)
std::ostream &	operator<< (std::ostream &s, const SparseMatrixBase &m)

---

Member Typedef Documentation

template<typename MatrixType >

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

Definition at line 48 of file Sparse.

typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, Eigen::Transpose<const SparseView< MatrixType > > >, Transpose<const SparseView< MatrixType > > >::type Eigen::SparseMatrixBase< SparseView< MatrixType > >::AdjointReturnType [inherited]

Definition at line 124 of file Sparse.

typedef EigenBase<SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::Base [inherited]

Definition at line 50 of file Sparse.

typedef internal::traits<SparseView< MatrixType > >::Index Eigen::SparseMatrixBase< SparseView< MatrixType > >::Index [inherited]

Reimplemented from Eigen::EigenBase< SparseView< MatrixType > >.

Definition at line 47 of file Sparse.

template<typename MatrixType >

typedef MatrixType::Nested Eigen::SparseView< MatrixType >::MatrixTypeNested [private]

Definition at line 47 of file Sparse.

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

Definition at line 45 of file Sparse.

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

Definition at line 127 of file Sparse.

typedef internal::traits<SparseView< MatrixType > >::Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::Scalar [inherited]

Definition at line 44 of file Sparse.

typedef SparseMatrixBase Eigen::SparseMatrixBase< SparseView< MatrixType > >::StorageBaseType [inherited]

Definition at line 49 of file Sparse.

typedef internal::traits<SparseView< MatrixType > >::StorageKind Eigen::SparseMatrixBase< SparseView< MatrixType > >::StorageKind [inherited]

Reimplemented from Eigen::EigenBase< SparseView< MatrixType > >.

Definition at line 46 of file Sparse.

---

Member Enumeration Documentation

anonymous enum [inherited]

Definition at line 61 of file Sparse.

---

Constructor & Destructor Documentation

template<typename MatrixType >

Eigen::SparseView< MatrixType >::SparseView	(	const MatrixType &	mat,
		const Scalar &	m_reference = Scalar(0),
		typename NumTraits< Scalar >::Real	m_epsilon = NumTraits<Scalar>::dummy_precision()
	)		[inline]

Definition at line 52 of file Sparse.

---

Member Function Documentation

void Eigen::SparseMatrixBase< SparseView< MatrixType > >::_experimentalNewProduct	(	const Lhs &	lhs,
		const Rhs &	rhs
	)		[inline, inherited]

void Eigen::EigenBase< SparseView< MatrixType > >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

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

(

)

const [inline, inherited]

Definition at line 430 of file Sparse.

void Eigen::EigenBase< SparseView< MatrixType > >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< SparseView< MatrixType > >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

void Eigen::SparseMatrixBase< SparseView< MatrixType > >::assignGeneric

(

const OtherDerived &

other

)

[inline, inherited]

Definition at line 211 of file Sparse.

EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::binaryExpr	(	const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &	other,
		const CustomBinaryOp &	func = CustomBinaryOp()
	)		const [inline, inherited]

Returns:

an expression of the difference of *this and other

Note:

If you want to substract a given scalar from all coefficients, see Cwise::operator-().

See also:

class CwiseBinaryOp, operator-=()

Returns:

an expression of the sum of *this and other

Note:

If you want to add a given scalar to all coefficients, see Cwise::operator+().

See also:

class CwiseBinaryOp, operator+=()

Returns:

an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

Output:

See also:

class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 58 of file Sparse.

internal::cast_return_type<SparseView< MatrixType > ,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<SparseView< MatrixType > >::Scalar, NewType>, const SparseView< MatrixType > > >::type Eigen::SparseMatrixBase< SparseView< MatrixType > >::cast

(

)

const [inline, inherited]

Returns:

an expression of *this with the Scalar type casted to NewScalar.

The template parameter NewScalar is the type we are casting the scalars to.

See also:

class CwiseUnaryOp

Definition at line 108 of file Sparse.

SparseInnerVectorSet<SparseView< MatrixType > ,1> Eigen::SparseMatrixBase< SparseView< MatrixType > >::col

(

Index

j

)

[inherited]

Returns:

the i-th column of the matrix *this. For column-major matrix only.

const SparseInnerVectorSet<SparseView< MatrixType > ,1> Eigen::SparseMatrixBase< SparseView< MatrixType > >::col

(

Index

j

)

const [inherited]

Returns:

the i-th column of the matrix *this. For column-major matrix only. (read-only version)

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

Definition at line 59 of file Sparse.

ConjugateReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::conjugate

(

)

const [inline, inherited]

Returns:

an expression of the complex conjugate of *this.

See also:

adjoint()

Definition at line 117 of file Sparse.

SparseView< MatrixType > & Eigen::EigenBase< SparseView< MatrixType > >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const SparseView< MatrixType > & Eigen::EigenBase< SparseView< MatrixType > >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseAbs

(

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also:

cwiseAbs2()

Definition at line 37 of file Sparse.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseAbs2

(

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also:

cwiseAbs()

Definition at line 47 of file Sparse.

const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseEqual

(

const Scalar &

s

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise == operator of *this and a scalar s

Warning:

this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

See also:

cwiseEqual(const MatrixBase<OtherDerived> &) const

Definition at line 79 of file Sparse.

const CwiseBinaryOp<std::equal_to<Scalar>, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseEqual

(

const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &

other

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise == operator of *this and other

Warning:

this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:

cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 57 of file Sparse.

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseInverse

(

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also:

cwiseProduct()

Definition at line 67 of file Sparse.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseMax

(

const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &

other

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise max of *this and other

Example:

Output:

See also:

class CwiseBinaryOp, min()

Definition at line 104 of file Sparse.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseMin

(

const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &

other

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise min of *this and other

Example:

Output:

See also:

class CwiseBinaryOp, max()

Definition at line 90 of file Sparse.

const CwiseBinaryOp<std::not_equal_to<Scalar>, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseNotEqual

(

const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &

other

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise != operator of *this and other

Warning:

this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:

cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 76 of file Sparse.

EIGEN_STRONG_INLINE const EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseProduct

(

const MatrixBase< OtherDerived > &

other

)

const [inherited]

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const SparseView< MatrixType > , const OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseQuotient

(

const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &

other

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise quotient of *this and other

Example:

Output:

See also:

class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 118 of file Sparse.

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::cwiseSqrt

(

)

const [inline, inherited]

Returns:

an expression of the coefficient-wise square root of *this.

Example:

Output:

See also:

cwisePow(), cwiseSquare()

Definition at line 57 of file Sparse.

SparseView< MatrixType > & Eigen::EigenBase< SparseView< MatrixType > >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

const SparseView< MatrixType > & Eigen::EigenBase< SparseView< MatrixType > >::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::dot

(

const MatrixBase< OtherDerived > &

other

)

const [inherited]

Scalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::dot

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inherited]

EIGEN_STRONG_INLINE const Eigen::SparseMatrixBase< SparseView< MatrixType > >::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	SparseView< MatrixType >	,
		OtherDerived
	)		const [inline, inherited]

Returns:

an expression of the Schur product (coefficient wise product) of *this and other

Example:

Output:

See also:

class CwiseBinaryOp, cwiseAbs2

Definition at line 37 of file Sparse.

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

(

)

const [inline, inherited]

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.

Definition at line 577 of file Sparse.

void Eigen::SparseMatrixBase< SparseView< MatrixType > >::evalTo

(

MatrixBase< DenseDerived > &

dst

)

const [inline, inherited]

Definition at line 518 of file Sparse.

void Eigen::EigenBase< SparseView< MatrixType > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 67 of file Core.

NonConstImagReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::imag

(

)

[inline, inherited]

Returns:

a non const expression of the imaginary part of *this.

See also:

real()

Definition at line 188 of file Sparse.

const ImagReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::imag

(

)

const [inline, inherited]

Returns:

an read-only expression of the imaginary part of *this.

See also:

real()

Definition at line 132 of file Sparse.

template<typename MatrixType >

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

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

Definition at line 61 of file Sparse.

SparseInnerVectorSet<SparseView< MatrixType > ,1> 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).

const SparseInnerVectorSet<SparseView< MatrixType > ,1> 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.

SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> 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).

const SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> 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.

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

Definition at line 532 of file Sparse.

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

Definition at line 537 of file Sparse.

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

(

)

const [inline, inherited]

Definition at line 187 of file Sparse.

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

(

)

const [inline, inherited]

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.

Definition at line 179 of file Sparse.

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

(

)

[inline, inherited]

Definition at line 188 of file Sparse.

Index Eigen::SparseMatrixBase< SparseView< MatrixType > >::nonZeros

(

)

const [inline, inherited]

Returns:

the number of nonzero coefficients which is in practice the number of stored coefficients.

Definition at line 174 of file Sparse.

RealScalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::norm

(

)

const [inherited]

const SparseDiagonalProduct<SparseView< MatrixType > ,OtherDerived> Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const DiagonalBase< OtherDerived > &

other

)

const [inherited]

const SparseDenseProductReturnType<SparseView< MatrixType > ,OtherDerived>::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const MatrixBase< OtherDerived > &

other

)

const [inherited]

sparse * dense (returns a dense object unless it is an outer product)

const SparseSparseProductReturnType<SparseView< MatrixType > ,OtherDerived>::Type Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const SparseMatrixBase< OtherDerived > &

other

)

const [inherited]

const ScalarMultipleReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const Scalar &

scalar

)

const [inline, inherited]

Returns:

an expression of *this scaled by the scalar factor scalar

Definition at line 65 of file Sparse.

const ScalarMultipleReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const RealScalar &

scalar

)

const [inherited]

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*

(

const std::complex< Scalar > &

scalar

)

const [inline, inherited]

Overloaded for efficient real matrix times complex scalar value.

Definition at line 85 of file Sparse.

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inherited]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator*=

(

const Scalar &

other

)

[inherited]

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator+=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inherited]

const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<SparseView< MatrixType > >::Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator-

(

)

const [inline, inherited]

Returns:

an expression of the opposite of *this

Definition at line 60 of file Sparse.

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator-=

(

const SparseMatrixBase< OtherDerived > &

other

)

[inherited]

const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<SparseView< MatrixType > >::Scalar>, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator/

(

const Scalar &

scalar

)

const [inline, inherited]

Returns:

an expression of *this divided by the scalar value scalar

Definition at line 77 of file Sparse.

SparseView< MatrixType > & Eigen::SparseMatrixBase< SparseView< MatrixType > >::operator/=

(

const Scalar &

other

)

[inherited]

template<typename MatrixType >

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

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

Definition at line 62 of file Sparse.

RealReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::real

(

)

const [inline, inherited]

Returns:

a read-only expression of the real part of *this.

See also:

imag()

Definition at line 126 of file Sparse.

NonConstRealReturnType Eigen::SparseMatrixBase< SparseView< MatrixType > >::real

(

)

[inline, inherited]

Returns:

a non const expression of the real part of *this.

See also:

imag()

Definition at line 182 of file Sparse.

const SparseInnerVectorSet<SparseView< MatrixType > ,1> Eigen::SparseMatrixBase< SparseView< MatrixType > >::row

(

Index

i

)

const [inherited]

Returns:

the i-th row of the matrix *this. For row-major matrix only. (read-only version)

SparseInnerVectorSet<SparseView< MatrixType > ,1> Eigen::SparseMatrixBase< SparseView< MatrixType > >::row

(

Index

i

)

[inherited]

Returns:

the i-th row of the matrix *this. For row-major matrix only.

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

Definition at line 58 of file Sparse.

SparseSelfAdjointView<SparseView< MatrixType > , UpLo> Eigen::SparseMatrixBase< SparseView< MatrixType > >::selfadjointView

(

)

[inline, inherited]

const SparseSelfAdjointView<SparseView< MatrixType > , UpLo> Eigen::SparseMatrixBase< SparseView< MatrixType > >::selfadjointView

(

)

const [inline, inherited]

Index Eigen::SparseMatrixBase< SparseView< MatrixType > >::size

(

)

const [inline, inherited]

Returns:

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

See also:

rows(), cols(), SizeAtCompileTime.

Reimplemented from Eigen::EigenBase< SparseView< MatrixType > >.

Definition at line 171 of file Sparse.

RealScalar Eigen::SparseMatrixBase< SparseView< MatrixType > >::squaredNorm

(

)

const [inherited]

const SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> Eigen::SparseMatrixBase< SparseView< MatrixType > >::subcols	(	Index	start,
		Index	size
	)		const [inherited]

Returns:

the i-th column of the matrix *this. For column-major matrix only. (read-only version)

SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> Eigen::SparseMatrixBase< SparseView< MatrixType > >::subcols	(	Index	start,
		Index	size
	)		[inherited]

Returns:

the i-th column of the matrix *this. For column-major matrix only.

SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> Eigen::SparseMatrixBase< SparseView< MatrixType > >::subrows	(	Index	start,
		Index	size
	)		[inherited]

Returns:

the i-th row of the matrix *this. For row-major matrix only.

const SparseInnerVectorSet<SparseView< MatrixType > ,Dynamic> Eigen::SparseMatrixBase< SparseView< MatrixType > >::subrows	(	Index	start,
		Index	size
	)		const [inherited]

Returns:

the i-th row of the matrix *this. For row-major matrix only. (read-only version)

void Eigen::EigenBase< SparseView< MatrixType > >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

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

(

)

const [inherited]

Returns:

number of elements to skip to pass from one row (resp. column) to another for a row-major (resp. column-major) matrix. Combined with coeffRef() and the Flags flags, it allows a direct access to the data of the underlying matrix.

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

(

)

const [inline, inherited]

Definition at line 526 of file Sparse.

const Transpose<const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::transpose

(

)

const [inline, inherited]

Definition at line 428 of file Sparse.

Transpose<SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::transpose

(

)

[inline, inherited]

Definition at line 427 of file Sparse.

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

(

)

const [inline, inherited]

const CwiseUnaryOp<CustomUnaryOp, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::unaryExpr

(

const CustomUnaryOp &

func = CustomUnaryOp()

)

const [inline, inherited]

Apply a unary operator coefficient-wise.

Parameters:

[in]

func

Functor implementing the unary operator

Template Parameters:

CustomUnaryOp

Type of func

Returns:

An expression of a custom coefficient-wise unary operator func of *this

The function ptr_fun() from the C++ standard library can be used to make functors out of normal functions.

Example:

Output:

Genuine functors allow for more possibilities, for instance it may contain a state.

Example:

Output:

See also:

class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 155 of file Sparse.

const CwiseUnaryView<CustomViewOp, const SparseView< MatrixType > > Eigen::SparseMatrixBase< SparseView< MatrixType > >::unaryViewExpr

(

const CustomViewOp &

func = CustomViewOp()

)

const [inline, inherited]

Returns:

an expression of a custom coefficient-wise unary operator func of *this

The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.

Example:

Output:

See also:

class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 173 of file Sparse.

---

Friends And Related Function Documentation

const ScalarMultipleReturnType operator*	(	const Scalar &	scalar,
		const StorageBaseType &	matrix
	)		[friend, inherited]

Definition at line 92 of file Sparse.

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const SparseView< MatrixType > > operator*	(	const std::complex< Scalar > &	scalar,
		const StorageBaseType &	matrix
	)		[friend, inherited]

Definition at line 96 of file Sparse.

const DenseSparseProductReturnType<OtherDerived,SparseView< MatrixType > >::Type operator*	(	const MatrixBase< OtherDerived > &	lhs,
		const SparseView< MatrixType > &	rhs
	)		[friend, inherited]

dense * sparse (return a dense object unless it is an outer product)

Definition at line 390 of file Sparse.

const SparseDiagonalProduct<OtherDerived,SparseView< MatrixType > > operator*	(	const DiagonalBase< OtherDerived > &	lhs,
		const SparseMatrixBase< SparseView< MatrixType > > &	rhs
	)		[friend, inherited]

Definition at line 384 of file Sparse.

std::ostream& operator<<	(	std::ostream &	s,
		const SparseMatrixBase< SparseView< MatrixType > > &	m
	)		[friend, inherited]

Definition at line 282 of file Sparse.

---

Member Data Documentation

template<typename MatrixType >

NumTraits<Scalar>::Real Eigen::SparseView< MatrixType >::m_epsilon [protected]

Definition at line 67 of file Sparse.

bool Eigen::SparseMatrixBase< SparseView< MatrixType > >::m_isRValue [protected, inherited]

Definition at line 703 of file Sparse.

template<typename MatrixType >

const MatrixTypeNested Eigen::SparseView< MatrixType >::m_matrix [protected]

Definition at line 65 of file Sparse.

template<typename MatrixType >

Scalar Eigen::SparseView< MatrixType >::m_reference [protected]

Definition at line 66 of file Sparse.