Classes | Public Types | Public Member Functions | Protected Attributes
Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index > Class Template Reference

Sparse matrix. More...

#include <MappedSparseMatrix.h>

Inheritance diagram for Eigen::MappedSparseMatrix< _Scalar, _Flags, _Index >:
Inheritance graph
[legend]

List of all members.

Classes

class  InnerIterator
class  ReverseInnerIterator

Public Types

enum  { IsRowMajor = Base::IsRowMajor }

Public Member Functions

Scalar coeff (Index row, Index col) const
ScalarcoeffRef (Index row, Index col)
Index cols () const
const IndexinnerIndexPtr () const
IndexinnerIndexPtr ()
Index innerSize () const
 MappedSparseMatrix (Index rows, Index cols, Index nnz, Index *outerIndexPtr, Index *innerIndexPtr, Scalar *valuePtr)
Index nonZeros () const
const IndexouterIndexPtr () const
IndexouterIndexPtr ()
Index outerSize () const
Index rows () const
const ScalarvaluePtr () const
ScalarvaluePtr ()
 ~MappedSparseMatrix ()

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 Eigen::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 31 of file MappedSparseMatrix.h.


Member Enumeration Documentation

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

Definition at line 36 of file MappedSparseMatrix.h.


Constructor & Destructor Documentation

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

Definition at line 106 of file MappedSparseMatrix.h.

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

Empty destructor

Definition at line 112 of file MappedSparseMatrix.h.


Member Function Documentation

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

Definition at line 66 of file MappedSparseMatrix.h.

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

Definition at line 85 of file MappedSparseMatrix.h.

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

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

Definition at line 50 of file MappedSparseMatrix.h.

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

Definition at line 59 of file MappedSparseMatrix.h.

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

Definition at line 60 of file MappedSparseMatrix.h.

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

Definition at line 51 of file MappedSparseMatrix.h.

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

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

Definition at line 104 of file MappedSparseMatrix.h.

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

Definition at line 62 of file MappedSparseMatrix.h.

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

Definition at line 63 of file MappedSparseMatrix.h.

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

Definition at line 52 of file MappedSparseMatrix.h.

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

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

Definition at line 49 of file MappedSparseMatrix.h.

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

Definition at line 56 of file MappedSparseMatrix.h.

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

Definition at line 57 of file MappedSparseMatrix.h.


Member Data Documentation

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

Definition at line 44 of file MappedSparseMatrix.h.

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

Definition at line 41 of file MappedSparseMatrix.h.

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

Definition at line 42 of file MappedSparseMatrix.h.

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

Definition at line 43 of file MappedSparseMatrix.h.

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

Definition at line 40 of file MappedSparseMatrix.h.

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

Definition at line 45 of file MappedSparseMatrix.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 12:01:58