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 >:
Inheritance graph
[legend]

List of all members.

Classes

class  InnerIterator

Public Member Functions

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

Protected Types

enum  { IsRowMajor = Base::IsRowMajor }

Protected Attributes

Indexm_innerIndices
Index m_innerSize
Index m_nnz
Indexm_outerIndex
Index m_outerSize
Scalarm_values

Detailed Description

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

Sparse matrix.

Parameters:
_Scalarthe 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.

Definition at line 44 of file MappedSparseMatrix.h.


Member Enumeration Documentation

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

Definition at line 51 of file MappedSparseMatrix.h.


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]

Definition at line 119 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
MappedSparseMatrix< _Scalar, _Flags, _Index >::~MappedSparseMatrix ( ) [inline]

Empty destructor

Definition at line 125 of file MappedSparseMatrix.h.


Member Function Documentation

template<typename _Scalar , int _Flags, typename _Index >
const Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_innerIndexPtr ( ) const [inline]

Definition at line 73 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_innerIndexPtr ( ) [inline]

Definition at line 74 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
const Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_outerIndexPtr ( ) const [inline]

Definition at line 76 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::_outerIndexPtr ( ) [inline]

Definition at line 77 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
const Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::_valuePtr ( ) const [inline]

Definition at line 70 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::_valuePtr ( ) [inline]

Definition at line 71 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Scalar MappedSparseMatrix< _Scalar, _Flags, _Index >::coeff ( Index  row,
Index  col 
) const [inline]

Definition at line 80 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Scalar& MappedSparseMatrix< _Scalar, _Flags, _Index >::coeffRef ( Index  row,
Index  col 
) [inline]

Definition at line 99 of file MappedSparseMatrix.h.

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 > >.

Definition at line 63 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::innerNonZeros ( Index  j) const [inline]

Definition at line 66 of file MappedSparseMatrix.h.

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 > >.

Definition at line 64 of file MappedSparseMatrix.h.

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 > >.

Definition at line 117 of file MappedSparseMatrix.h.

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 > >.

Definition at line 65 of file MappedSparseMatrix.h.

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 > >.

Definition at line 62 of file MappedSparseMatrix.h.


Member Data Documentation

template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerIndices [protected]

Definition at line 57 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_innerSize [protected]

Definition at line 54 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_nnz [protected]

Definition at line 55 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerIndex [protected]

Definition at line 56 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Index MappedSparseMatrix< _Scalar, _Flags, _Index >::m_outerSize [protected]

Definition at line 53 of file MappedSparseMatrix.h.

template<typename _Scalar , int _Flags, typename _Index >
Scalar* MappedSparseMatrix< _Scalar, _Flags, _Index >::m_values [protected]

Definition at line 58 of file MappedSparseMatrix.h.


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


libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:21