Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex > Class Template Reference

Sparse matrix. More...

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

Inheritance diagram for Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >:

Collaboration diagram for Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >:

Public Types
typedef Base::StorageIndex	StorageIndex
typedef Base::Scalar	Scalar
typedef Base::PointerType	PointerType
typedef PointerType	PointerArgType

Public Member Functions
	MappedSparseMatrix (Index rows, Index cols, Index nnz, StorageIndex *outerIndexPtr, StorageIndex *innerIndexPtr, Scalar *valuePtr, StorageIndex *innerNonZeroPtr=0)
	~MappedSparseMatrix ()
EIGEN_DEVICE_FUNC PointerType	cast_to_pointer_type (PointerArgType ptr)
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC Index	outerStride () const

Protected Attributes
StrideType	m_stride

Private Types
typedef Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > >	Base

Detailed Description

template<typename _Scalar, int _Flags, typename _StorageIndex>
class Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >

Sparse matrix.

Parameters

_Scalar

the scalar type, i.e. the type of the coefficients

See http://www.netlib.org/linalg/html_templates/node91.html for details on the storage scheme.

Member Typedef Documentation

Base

template<typename _Scalar , int _Flags, typename _StorageIndex >

typedef Map<SparseMatrix<_Scalar, _Flags, _StorageIndex> > Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >::Base

private

PointerArgType

typedef PointerType Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::PointerArgType

inherited

PointerType

typedef Base::PointerType Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::PointerType

inherited

Scalar

template<typename _Scalar , int _Flags, typename _StorageIndex >

typedef Base::Scalar Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >::Scalar

StorageIndex

template<typename _Scalar , int _Flags, typename _StorageIndex >

typedef Base::StorageIndex Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >::StorageIndex

Constructor & Destructor Documentation

MappedSparseMatrix()

template<typename _Scalar , int _Flags, typename _StorageIndex >

Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >::MappedSparseMatrix ( Index  rows, Index  cols, Index  nnz, StorageIndex *  outerIndexPtr, StorageIndex *  innerIndexPtr, Scalar *  valuePtr, StorageIndex *  innerNonZeroPtr = 0  )

inline

      : Base(rows, cols, nnz, outerIndexPtr, innerIndexPtr, valuePtr, innerNonZeroPtr)
    {}

~MappedSparseMatrix()

template<typename _Scalar , int _Flags, typename _StorageIndex >

Eigen::MappedSparseMatrix< _Scalar, _Flags, _StorageIndex >::~MappedSparseMatrix ( )

inline

Empty destructor

{}

Member Function Documentation

cast_to_pointer_type()

EIGEN_DEVICE_FUNC PointerType Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::cast_to_pointer_type ( PointerArgType  ptr )

inlineinherited

{ return ptr; }

innerStride()

EIGEN_DEVICE_FUNC Index Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::innerStride ( ) const

inlineinherited

    {
      return StrideType::InnerStrideAtCompileTime != 0 ? m_stride.inner() : 1;
    }

outerStride()

EIGEN_DEVICE_FUNC Index Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::outerStride ( ) const

inlineinherited

    {
      return int(StrideType::OuterStrideAtCompileTime) != 0 ? m_stride.outer()
           : int(internal::traits<Map>::OuterStrideAtCompileTime) != Dynamic ? Index(internal::traits<Map>::OuterStrideAtCompileTime)
           : IsVectorAtCompileTime ? (this->size() * innerStride())
           : (int(Flags)&RowMajorBit) ? (this->cols() * innerStride())
           : (this->rows() * innerStride());
    }

Member Data Documentation

m_stride

StrideType Eigen::Map< SparseMatrix< _Scalar, _Flags, _StorageIndex > , MapOptions, StrideType >::m_stride

protectedinherited

---

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

• src/eigen/Eigen/src/SparseCore/MappedSparseMatrix.h