$treeview $search $mathjax
Eigen-unsupported
3.2.5
$projectbrief
|
$projectbrief
|
$searchbox |
The main skyline matrix class. More...
Public Member Functions | |
Index | cols () const |
const internal::eval < SkylineMatrix< _Scalar, _Options >, IsSkyline >::type | eval () const |
void | finalize () |
Index | innerSize () const |
EIGEN_DONT_INLINE Scalar & | insert (Index row, Index col) |
Index | nonZeros () const |
Index | outerSize () const |
void | reserve (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize) |
void | resize (size_t rows, size_t cols) |
Index | rows () const |
void | setZero () |
Index | size () const |
Scalar | sum () const |
~SkylineMatrix () |
The main skyline matrix class.
This class implements a skyline matrix using the very uncommon storage scheme.
_Scalar | the scalar type, i.e. the type of the coefficients | |
_Options | Union of bit flags controlling the storage scheme. Currently the only possibility is RowMajor. The default is 0 which means column-major. |
~SkylineMatrix | ( | ) | [inline] |
Destructor
Index cols | ( | ) | const [inline] |
Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.
Referenced by SkylineMatrix< _Scalar, _Options >::finalize(), and SkylineMatrix< _Scalar, _Options >::insert().
const internal::eval<SkylineMatrix< _Scalar, _Options > , IsSkyline>::type eval | ( | ) | const [inline, inherited] |
Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.
void finalize | ( | ) | [inline] |
Must be called after inserting a set of non zero entries.
References SkylineMatrix< _Scalar, _Options >::cols(), and SkylineMatrix< _Scalar, _Options >::rows().
Index innerSize | ( | ) | const [inline] |
Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.
Referenced by SkylineMatrix< _Scalar, _Options >::insert().
EIGEN_DONT_INLINE Scalar& insert | ( | Index | row, | |
Index | col | |||
) | [inline] |
After an insertion session, you should call the finalize() function.
References SkylineMatrix< _Scalar, _Options >::cols(), SkylineMatrix< _Scalar, _Options >::innerSize(), SkylineMatrix< _Scalar, _Options >::outerSize(), and SkylineMatrix< _Scalar, _Options >::rows().
Index nonZeros | ( | ) | const [inline] |
Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.
Index outerSize | ( | ) | const [inline] |
Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.
Referenced by SkylineMatrix< _Scalar, _Options >::insert().
void reserve | ( | Index | reserveSize, | |
Index | reserveUpperSize, | |||
Index | reserveLowerSize | |||
) | [inline] |
Preallocates reserveSize non zeros
void resize | ( | size_t | rows, | |
size_t | cols | |||
) | [inline] |
Index rows | ( | ) | const [inline] |
Reimplemented from SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.
Referenced by SkylineMatrix< _Scalar, _Options >::finalize(), and SkylineMatrix< _Scalar, _Options >::insert().
void setZero | ( | ) | [inline] |
Removes all non zeros
Index size | ( | ) | const [inline, inherited] |
References SkylineMatrixBase< Derived >::cols(), and SkylineMatrixBase< Derived >::rows().
Scalar sum | ( | ) | const |
Overloaded for performance