Classes | Public Member Functions | Protected Types | Protected Attributes

MappedSparseMatrix< _Scalar, _Flags, _Index > Class Template Reference

Sparse matrix. More...

#include <MappedSparseMatrix.h>

Inheritance diagram for MappedSparseMatrix< _Scalar, _Flags, _Index >:
SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > > EigenBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >

List of all members.

Classes

class  InnerIterator

Public Member Functions

Index rows () const
Index cols () const
Index innerSize () const
Index outerSize () const
Index innerNonZeros (Index j) const
const Scalar_valuePtr () const
Scalar_valuePtr ()
const Index_innerIndexPtr () const
Index_innerIndexPtr ()
const Index_outerIndexPtr () const
Index_outerIndexPtr ()
Scalar coeff (Index row, Index col) const
ScalarcoeffRef (Index row, Index col)
Index nonZeros () const
 MappedSparseMatrix (Index rows, Index cols, Index nnz, Index *outerIndexPtr, Index *innerIndexPtr, Scalar *valuePtr)
 ~MappedSparseMatrix ()

Protected Types

enum  { IsRowMajor = Base::IsRowMajor }

Protected Attributes

Index m_outerSize
Index m_innerSize
Index m_nnz
Indexm_outerIndex
Indexm_innerIndices
Scalarm_values

Detailed Description

template<typename _Scalar, int _Flags, typename _Index>
class MappedSparseMatrix< _Scalar, _Flags, _Index >

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 Enumeration Documentation

template<typename _Scalar , int _Flags, typename _Index >
anonymous enum [protected]
Enumerator:
IsRowMajor 

Constructor & Destructor Documentation

template<typename _Scalar , int _Flags, typename _Index >
MappedSparseMatrix< _Scalar, _Flags, _Index >::MappedSparseMatrix ( Index  rows,
Index  cols,
Index  nnz,
Index outerIndexPtr,
Index innerIndexPtr,
Scalar valuePtr 
) [inline]
template<typename _Scalar , int _Flags, typename _Index >
MappedSparseMatrix< _Scalar, _Flags, _Index >::~MappedSparseMatrix (  )  [inline]

Empty destructor


Member Function Documentation

template<typename _Scalar , int _Flags, typename _Index >
const Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_innerIndexPtr (  )  const [inline]
template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_innerIndexPtr (  )  [inline]
template<typename _Scalar , int _Flags, typename _Index >
const Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_outerIndexPtr (  )  const [inline]
template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_outerIndexPtr (  )  [inline]
template<typename _Scalar , int _Flags, typename _Index >
const Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::_valuePtr (  )  const [inline]
template<typename _Scalar , int _Flags, typename _Index >
Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::_valuePtr (  )  [inline]
template<typename _Scalar , int _Flags, typename _Index >
Scalar MappedSparseMatrix< _Scalar, _Flags, _Index >::coeff ( Index  row,
Index  col 
) const [inline]
template<typename _Scalar , int _Flags, typename _Index >
Scalar& MappedSparseMatrix< _Scalar, _Flags, _Index >::coeffRef ( Index  row,
Index  col 
) [inline]
template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::cols ( void   )  const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::innerNonZeros ( Index  j  )  const [inline]
template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::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 SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::nonZeros (  )  const [inline]
Returns:
the number of non zero coefficients

Reimplemented from SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::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 SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::rows ( void   )  const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >.


Member Data Documentation

template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerIndices [protected]
template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerSize [protected]
template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_nnz [protected]
template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerIndex [protected]
template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerSize [protected]
template<typename _Scalar , int _Flags, typename _Index >
Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_values [protected]

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