W3cubDocs
/Eigen3Eigen::SkylineMatrixBase
template<typename Derived>
class Eigen::SkylineMatrixBase< Derived >
Base class of any skyline matrices or skyline expressions.
- Parameters
-
Derived
| enum | { RowsAtCompileTime , ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime , Flags , CoeffReadCost , IsRowMajor } |
| EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
| const internal::eval< Derived, IsSkyline >::type | eval () const |
| Index | innerSize () const |
| Index | nonZeros () const |
| Index | outerSize () const |
| EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
| EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| RowsAtCompileTime |
The number of rows at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. |
| ColsAtCompileTime |
The number of columns at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. |
| SizeAtCompileTime |
This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time.
|
| IsVectorAtCompileTime |
This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row). |
| Flags |
This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags. |
| CoeffReadCost |
This is a rough measure of how expensive it is to read one coefficient from this expression. |
cols()
| inline |
- Returns
- the number of columns.
- See also
- rows(), ColsAtCompileTime
eval()
| inline |
- Returns
- the matrix or vector obtained by evaluating this expression.
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.
innerSize()
| 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
nonZeros()
| inline |
- Returns
- the number of nonzero coefficients which is in practice the number of stored coefficients.
outerSize()
| 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
rows()
| inline |
- Returns
- the number of rows.
- See also
- cols(), RowsAtCompileTime
size()
| inline |
- Returns
- the number of coefficients, which is rows()*cols().
- See also
- rows(), cols(), SizeAtCompileTime.
The documentation for this class was generated from the following files:
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/unsupported/classEigen_1_1SkylineMatrixBase.html