Eigen::SparseView< MatrixType > Class Template Reference

#include <SparseView.h>

Inheritance diagram for Eigen::SparseView< MatrixType >:

Collaboration diagram for Eigen::SparseView< MatrixType >:

List of all members.

Public Types
typedef internal::remove_all < MatrixType >::type	NestedExpression
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
Protected Attributes
MatrixTypeNested	m_matrix
Scalar	m_reference
RealScalar	m_epsilon
Private Types
typedef MatrixType::Nested	MatrixTypeNested
typedef internal::remove_all < MatrixTypeNested >::type	_MatrixTypeNested
typedef SparseMatrixBase < SparseView >	Base

---

Detailed Description

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

Definition at line 31 of file SparseView.h.

---

Member Typedef Documentation

template<typename MatrixType>

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

Definition at line 34 of file SparseView.h.

template<typename MatrixType>

typedef SparseMatrixBase<SparseView > Eigen::SparseView< MatrixType >::Base [private]

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

Definition at line 35 of file SparseView.h.

template<typename MatrixType>

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

Definition at line 33 of file SparseView.h.

template<typename MatrixType>

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

Definition at line 38 of file SparseView.h.

---

Constructor & Destructor Documentation

template<typename MatrixType>

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

Definition at line 40 of file SparseView.h.

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

---

Member Function Documentation

template<typename MatrixType>

Index Eigen::SparseView< MatrixType >::cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows()

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

Definition at line 45 of file SparseView.h.

{ return m_matrix.cols(); }

template<typename MatrixType>

RealScalar Eigen::SparseView< MatrixType >::epsilon

(

)

const [inline]

Definition at line 55 of file SparseView.h.

{ return m_epsilon; }

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 47 of file SparseView.h.

{ return m_matrix.innerSize(); }

template<typename MatrixType>

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

(

)

const [inline]

Returns:

the nested expression

Definition at line 52 of file SparseView.h.

{ return m_matrix; }

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 48 of file SparseView.h.

{ return m_matrix.outerSize(); }

template<typename MatrixType>

Scalar Eigen::SparseView< MatrixType >::reference

(

)

const [inline]

Definition at line 54 of file SparseView.h.

{ return m_reference; }

template<typename MatrixType>

Index Eigen::SparseView< MatrixType >::rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols()

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

Definition at line 44 of file SparseView.h.

{ return m_matrix.rows(); }

---

Member Data Documentation

template<typename MatrixType>

RealScalar Eigen::SparseView< MatrixType >::m_epsilon [protected]

Definition at line 60 of file SparseView.h.

template<typename MatrixType>

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

Definition at line 58 of file SparseView.h.

template<typename MatrixType>

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

Definition at line 59 of file SparseView.h.

---

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

• SparseView.h