Base class of any skyline matrices or skyline expressions. More...
#include <SkylineMatrixBase.h>
Public Types | |
| enum | { RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime, MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = internal::traits<Derived>::Flags, CoeffReadCost = internal::traits<Derived>::CoeffReadCost, IsRowMajor = Flags & RowMajorBit ? 1 : 0 } |
| typedef internal::index < StorageKind >::type | Index |
| typedef NumTraits< Scalar >::Real | RealScalar |
| typedef internal::traits < Derived >::Scalar | Scalar |
| typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) > | SquareMatrixType |
| typedef internal::traits < Derived >::StorageKind | StorageKind |
Public Member Functions | |
| template<typename OtherDerived > | |
| void | assignGeneric (const OtherDerived &other) |
| Index | cols () const |
| Derived & | const_cast_derived () const |
| const Derived & | derived () const |
| Derived & | derived () |
| EIGEN_STRONG_INLINE const internal::eval< Derived, IsSkyline >::type | eval () const |
| template<typename DenseDerived > | |
| void | evalTo (MatrixBase< DenseDerived > &dst) const |
| Index | innerSize () const |
| bool | isRValue () const |
| Derived & | markAsRValue () |
| Index | nonZeros () const |
| template<typename OtherDerived > | |
| const SkylineProductReturnType < Derived, OtherDerived > ::Type | operator* (const MatrixBase< OtherDerived > &other) const |
| Derived & | operator= (const Derived &other) |
| template<typename OtherDerived > | |
| Derived & | operator= (const SkylineMatrixBase< OtherDerived > &other) |
| template<typename Lhs , typename Rhs > | |
| Derived & | operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product) |
| Index | outerSize () const |
| Index | rows () const |
| Index | size () const |
| SkylineMatrixBase () | |
| Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime > | toDense () const |
Protected Attributes | |
| bool | m_isRValue |
Friends | |
| std::ostream & | operator<< (std::ostream &s, const SkylineMatrixBase &m) |
Detailed Description
template<typename Derived>
class SkylineMatrixBase< Derived >
Base class of any skyline matrices or skyline expressions.
- Parameters:
-
Derived
Definition at line 39 of file SkylineMatrixBase.h.
Member Typedef Documentation
| typedef internal::index<StorageKind>::type SkylineMatrixBase< Derived >::Index |
Reimplemented from EigenBase< Derived >.
Definition at line 44 of file SkylineMatrixBase.h.
| typedef NumTraits<Scalar>::Real SkylineMatrixBase< Derived >::RealScalar |
This is the "real scalar" type; if the Scalar type is already real numbers (e.g. int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.
- See also:
- class NumTraits
Definition at line 98 of file SkylineMatrixBase.h.
| typedef internal::traits<Derived>::Scalar SkylineMatrixBase< Derived >::Scalar |
Definition at line 42 of file SkylineMatrixBase.h.
| typedef Matrix<Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) > SkylineMatrixBase< Derived >::SquareMatrixType |
type of the equivalent square matrix
Definition at line 102 of file SkylineMatrixBase.h.
| typedef internal::traits<Derived>::StorageKind SkylineMatrixBase< Derived >::StorageKind |
Reimplemented from EigenBase< Derived >.
Definition at line 43 of file SkylineMatrixBase.h.
Member Enumeration Documentation
| 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.
- See also:
- MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
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.
- See also:
- MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
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.
- See also:
- RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime MaxColsAtCompileTime MaxSizeAtCompileTime 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.
IsRowMajor
Definition at line 46 of file SkylineMatrixBase.h.
Constructor & Destructor Documentation
| SkylineMatrixBase< Derived >::SkylineMatrixBase | ( | ) | [inline] |
Definition at line 160 of file SkylineMatrixBase.h.
Member Function Documentation
| void SkylineMatrixBase< Derived >::assignGeneric | ( | const OtherDerived & | other | ) | [inline] |
Definition at line 170 of file SkylineMatrixBase.h.
| Index SkylineMatrixBase< Derived >::cols | ( | void | ) | const [inline] |
- Returns:
- the number of columns.
- See also:
- rows(), ColsAtCompileTime
Reimplemented from EigenBase< Derived >.
Reimplemented in SkylineMatrix< _Scalar, _Options >.
Definition at line 123 of file SkylineMatrixBase.h.
| Derived& SkylineMatrixBase< Derived >::const_cast_derived | ( | ) | const [inline] |
Reimplemented from EigenBase< Derived >.
Definition at line 112 of file SkylineMatrixBase.h.
| const Derived& SkylineMatrixBase< Derived >::derived | ( | ) | const [inline] |
- Returns:
- a const reference to the derived object
Reimplemented from EigenBase< Derived >.
Definition at line 104 of file SkylineMatrixBase.h.
| Derived& SkylineMatrixBase< Derived >::derived | ( | ) | [inline] |
- Returns:
- a reference to the derived object
Reimplemented from EigenBase< Derived >.
Definition at line 108 of file SkylineMatrixBase.h.
| EIGEN_STRONG_INLINE const internal::eval<Derived, IsSkyline>::type SkylineMatrixBase< Derived >::eval | ( | ) | const [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.
Definition at line 215 of file SkylineMatrixBase.h.
| void SkylineMatrixBase< Derived >::evalTo | ( | MatrixBase< DenseDerived > & | dst | ) | const [inline] |
Definition at line 199 of file SkylineMatrixBase.h.
| Index SkylineMatrixBase< Derived >::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 in SkylineMatrix< _Scalar, _Options >.
Definition at line 147 of file SkylineMatrixBase.h.
| bool SkylineMatrixBase< Derived >::isRValue | ( | ) | const [inline] |
Definition at line 151 of file SkylineMatrixBase.h.
| Derived& SkylineMatrixBase< Derived >::markAsRValue | ( | ) | [inline] |
Definition at line 155 of file SkylineMatrixBase.h.
| Index SkylineMatrixBase< Derived >::nonZeros | ( | ) | const [inline] |
- Returns:
- the number of nonzero coefficients which is in practice the number of stored coefficients.
Reimplemented in SkylineMatrix< _Scalar, _Options >.
Definition at line 135 of file SkylineMatrixBase.h.
| EIGEN_STRONG_INLINE const SkylineProductReturnType< Derived, OtherDerived >::Type SkylineMatrixBase< Derived >::operator* | ( | const MatrixBase< OtherDerived > & | other | ) | const |
Definition at line 301 of file SkylineProduct.h.
| Derived& SkylineMatrixBase< Derived >::operator= | ( | const Derived & | other | ) | [inline] |
Reimplemented in SkylineMatrix< _Scalar, _Options >.
Definition at line 164 of file SkylineMatrixBase.h.
| Derived& SkylineMatrixBase< Derived >::operator= | ( | const SkylineMatrixBase< OtherDerived > & | other | ) | [inline] |
Reimplemented in SkylineMatrix< _Scalar, _Options >.
Definition at line 181 of file SkylineMatrixBase.h.
| Derived& SkylineMatrixBase< Derived >::operator= | ( | const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > & | product | ) | [inline] |
| Index SkylineMatrixBase< Derived >::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 in SkylineMatrix< _Scalar, _Options >.
Definition at line 141 of file SkylineMatrixBase.h.
| Index SkylineMatrixBase< Derived >::rows | ( | void | ) | const [inline] |
- Returns:
- the number of rows.
- See also:
- cols(), RowsAtCompileTime
Reimplemented from EigenBase< Derived >.
Reimplemented in SkylineMatrix< _Scalar, _Options >.
Definition at line 118 of file SkylineMatrixBase.h.
| Index SkylineMatrixBase< Derived >::size | ( | ) | const [inline] |
- Returns:
- the number of coefficients, which is rows()*cols().
- See also:
- rows(), cols(), SizeAtCompileTime.
Reimplemented from EigenBase< Derived >.
Definition at line 129 of file SkylineMatrixBase.h.
| Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime> SkylineMatrixBase< Derived >::toDense | ( | ) | const [inline] |
Definition at line 206 of file SkylineMatrixBase.h.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | s, |
| const SkylineMatrixBase< Derived > & | m | ||
| ) | [friend] |
Definition at line 188 of file SkylineMatrixBase.h.
Member Data Documentation
bool SkylineMatrixBase< Derived >::m_isRValue [protected] |
Definition at line 220 of file SkylineMatrixBase.h.
The documentation for this class was generated from the following files: