Classes | Public Member Functions | Public Attributes | Protected Types | Protected Attributes | Friends
SkylineMatrix< _Scalar, _Options > Class Template Reference

The main skyline matrix class. More...

#include <SkylineMatrix.h>

Inheritance diagram for SkylineMatrix< _Scalar, _Options >:
Inheritance graph
[legend]

List of all members.

Classes

class  InnerLowerIterator
class  InnerUpperIterator

Public Member Functions

const Scalar_diagPtr () const
Scalar_diagPtr ()
const Index_lowerProfilePtr () const
Index_lowerProfilePtr ()
const Scalar_lowerPtr () const
Scalar_lowerPtr ()
const Index_upperProfilePtr () const
Index_upperProfilePtr ()
const Scalar_upperPtr () const
Scalar_upperPtr ()
Scalar coeff (Index row, Index col) const
Scalar coeffDiag (Index idx) const
bool coeffExistLower (Index row, Index col)
bool coeffExistUpper (Index row, Index col)
Scalar coeffLower (Index row, Index col) const
ScalarcoeffRef (Index row, Index col)
ScalarcoeffRefDiag (Index idx)
ScalarcoeffRefLower (Index row, Index col)
ScalarcoeffRefUpper (Index row, Index col)
Scalar coeffUpper (Index row, Index col) const
Index cols () const
void finalize ()
Index innerSize () const
EIGEN_DONT_INLINE Scalarinsert (Index row, Index col)
Index lowerNonZeros () const
Index lowerNonZeros (Index j) const
Index nonZeros () const
SkylineMatrixoperator= (const SkylineMatrix &other)
template<typename OtherDerived >
SkylineMatrixoperator= (const SkylineMatrixBase< OtherDerived > &other)
Index outerSize () const
void prune (Scalar reference, RealScalar epsilon=dummy_precision< RealScalar >())
void reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)
void resize (size_t rows, size_t cols)
void resizeNonZeros (Index size)
Index rows () const
void setZero ()
 SkylineMatrix ()
 SkylineMatrix (size_t rows, size_t cols)
template<typename OtherDerived >
 SkylineMatrix (const SkylineMatrixBase< OtherDerived > &other)
 SkylineMatrix (const SkylineMatrix &other)
void squeeze ()
Scalar sum () const
void swap (SkylineMatrix &other)
Index upperNonZeros () const
Index upperNonZeros (Index j) const
 ~SkylineMatrix ()

Public Attributes

Indexm_colStartIndex
SkylineStorage< Scalarm_data
Indexm_rowStartIndex

Protected Types

typedef SkylineMatrix< Scalar,(Flags
&~RowMajorBit)|(IsRowMajor?RowMajorBit:0) > 
TransposedSkylineMatrix

Protected Attributes

Index m_innerSize
Index m_outerSize

Friends

std::ostream & operator<< (std::ostream &s, const SkylineMatrix &m)

Detailed Description

template<typename _Scalar, int _Options>
class SkylineMatrix< _Scalar, _Options >

The main skyline matrix class.

This class implements a skyline matrix using the very uncommon storage scheme.

Parameters:
_Scalarthe scalar type, i.e. the type of the coefficients
_OptionsUnion of bit flags controlling the storage scheme. Currently the only possibility is RowMajor. The default is 0 which means column-major.

Definition at line 64 of file SkylineMatrix.h.


Member Typedef Documentation

template<typename _Scalar , int _Options>
typedef SkylineMatrix<Scalar, (Flags&~RowMajorBit) | (IsRowMajor ? RowMajorBit : 0) > SkylineMatrix< _Scalar, _Options >::TransposedSkylineMatrix [protected]

Definition at line 75 of file SkylineMatrix.h.


Constructor & Destructor Documentation

template<typename _Scalar , int _Options>
SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( ) [inline]

Definition at line 643 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( size_t  rows,
size_t  cols 
) [inline]

Definition at line 648 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
template<typename OtherDerived >
SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrixBase< OtherDerived > &  other) [inline]

Definition at line 654 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
SkylineMatrix< _Scalar, _Options >::SkylineMatrix ( const SkylineMatrix< _Scalar, _Options > &  other) [inline]

Definition at line 659 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
SkylineMatrix< _Scalar, _Options >::~SkylineMatrix ( ) [inline]

Destructor

Definition at line 738 of file SkylineMatrix.h.


Member Function Documentation

template<typename _Scalar , int _Options>
const Scalar* SkylineMatrix< _Scalar, _Options >::_diagPtr ( ) const [inline]

Definition at line 119 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar* SkylineMatrix< _Scalar, _Options >::_diagPtr ( ) [inline]

Definition at line 123 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
const Index* SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( ) const [inline]

Definition at line 151 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index* SkylineMatrix< _Scalar, _Options >::_lowerProfilePtr ( ) [inline]

Definition at line 155 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
const Scalar* SkylineMatrix< _Scalar, _Options >::_lowerPtr ( ) const [inline]

Definition at line 135 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar* SkylineMatrix< _Scalar, _Options >::_lowerPtr ( ) [inline]

Definition at line 139 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
const Index* SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( ) const [inline]

Definition at line 143 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index* SkylineMatrix< _Scalar, _Options >::_upperProfilePtr ( ) [inline]

Definition at line 147 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
const Scalar* SkylineMatrix< _Scalar, _Options >::_upperPtr ( ) const [inline]

Definition at line 127 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar* SkylineMatrix< _Scalar, _Options >::_upperPtr ( ) [inline]

Definition at line 131 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar SkylineMatrix< _Scalar, _Options >::coeff ( Index  row,
Index  col 
) const [inline]

Definition at line 159 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar SkylineMatrix< _Scalar, _Options >::coeffDiag ( Index  idx) const [inline]

Definition at line 247 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
bool SkylineMatrix< _Scalar, _Options >::coeffExistLower ( Index  row,
Index  col 
) [inline]

Definition at line 325 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
bool SkylineMatrix< _Scalar, _Options >::coeffExistUpper ( Index  row,
Index  col 
) [inline]

Definition at line 361 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar SkylineMatrix< _Scalar, _Options >::coeffLower ( Index  row,
Index  col 
) const [inline]

Definition at line 253 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar& SkylineMatrix< _Scalar, _Options >::coeffRef ( Index  row,
Index  col 
) [inline]

Definition at line 208 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar& SkylineMatrix< _Scalar, _Options >::coeffRefDiag ( Index  idx) [inline]

Definition at line 300 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar& SkylineMatrix< _Scalar, _Options >::coeffRefLower ( Index  row,
Index  col 
) [inline]

Definition at line 306 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar& SkylineMatrix< _Scalar, _Options >::coeffRefUpper ( Index  row,
Index  col 
) [inline]

Definition at line 342 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar SkylineMatrix< _Scalar, _Options >::coeffUpper ( Index  row,
Index  col 
) const [inline]

Definition at line 277 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 91 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::finalize ( ) [inline]

Must be called after inserting a set of non zero entries.

Definition at line 547 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::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 SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 95 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
EIGEN_DONT_INLINE Scalar& SkylineMatrix< _Scalar, _Options >::insert ( Index  row,
Index  col 
) [inline]
Returns:
a reference to a novel non zero coefficient with coordinates row x col.
Warning:
This function can be extremely slow if the non zero coefficients are not inserted in a coherent order.

After an insertion session, you should call the finalize() function.

Definition at line 413 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( ) const [inline]

Definition at line 107 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::lowerNonZeros ( Index  j) const [inline]

Definition at line 115 of file SkylineMatrix.h.

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

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 396 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
SkylineMatrix& SkylineMatrix< _Scalar, _Options >::operator= ( const SkylineMatrix< _Scalar, _Options > &  other) [inline]

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 673 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
template<typename OtherDerived >
SkylineMatrix& SkylineMatrix< _Scalar, _Options >::operator= ( const SkylineMatrixBase< OtherDerived > &  other) [inline]

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 687 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::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 SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 99 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::prune ( Scalar  reference,
RealScalar  epsilon = dummy_precision<RealScalar > () 
) [inline]

Definition at line 595 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::reserve ( Index  reserveSize,
Index  reserveUpperSize,
Index  reserveLowerSize 
) [inline]

Preallocates reserveSize non zeros

Definition at line 401 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::resize ( size_t  rows,
size_t  cols 
) [inline]

Resizes the matrix to a rows x cols matrix and initializes it to zero

See also:
resizeNonZeros(Index), reserve(), setZero()

Definition at line 602 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::resizeNonZeros ( Index  size) [inline]

Definition at line 639 of file SkylineMatrix.h.

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

Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 87 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::setZero ( ) [inline]

Removes all non zeros

Definition at line 389 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::squeeze ( ) [inline]

Definition at line 590 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Scalar SkylineMatrix< _Scalar, _Options >::sum ( ) const

Overloaded for performance

template<typename _Scalar , int _Options>
void SkylineMatrix< _Scalar, _Options >::swap ( SkylineMatrix< _Scalar, _Options > &  other) [inline]

Definition at line 664 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::upperNonZeros ( ) const [inline]

Definition at line 103 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::upperNonZeros ( Index  j) const [inline]

Definition at line 111 of file SkylineMatrix.h.


Friends And Related Function Documentation

template<typename _Scalar , int _Options>
std::ostream& operator<< ( std::ostream &  s,
const SkylineMatrix< _Scalar, _Options > &  m 
) [friend]

Definition at line 698 of file SkylineMatrix.h.


Member Data Documentation

template<typename _Scalar , int _Options>
Index* SkylineMatrix< _Scalar, _Options >::m_colStartIndex

Definition at line 81 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
SkylineStorage<Scalar> SkylineMatrix< _Scalar, _Options >::m_data

Definition at line 83 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::m_innerSize [protected]

Definition at line 78 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index SkylineMatrix< _Scalar, _Options >::m_outerSize [protected]

Definition at line 77 of file SkylineMatrix.h.

template<typename _Scalar , int _Options>
Index* SkylineMatrix< _Scalar, _Options >::m_rowStartIndex

Definition at line 82 of file SkylineMatrix.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:28