Base class for all dense matrices, vectors, and arrays. More...
#include <DenseBase.h>
Classes | |
| struct | ConstFixedBlockXpr |
| struct | ConstFixedSegmentReturnType |
| struct | ConstNColsBlockXpr |
| struct | ConstNRowsBlockXpr |
| struct | FixedBlockXpr |
| struct | FixedSegmentReturnType |
| struct | NColsBlockXpr |
| struct | NRowsBlockXpr |
Public Member Functions | |
| EIGEN_DEVICE_FUNC bool | all () const |
| bool | allFinite () const |
| EIGEN_DEVICE_FUNC bool | any () const |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
| EIGEN_DEVICE_FUNC const ConstBlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
| This is the const version of block(Index,Index,Index,Index). */. More... | |
| template<int NRows, int NCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol) |
| template<int NRows, int NCols> | |
| EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol) const |
| This is the const version of block<>(Index, Index). */. More... | |
| template<int NRows, int NCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
| template<int NRows, int NCols> | |
| const ConstFixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
| This is the const version of block<>(Index, Index, Index, Index). More... | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr | bottomLeftCorner (Index cRows, Index cCols) |
| EIGEN_DEVICE_FUNC const ConstBlockXpr | bottomLeftCorner (Index cRows, Index cCols) const |
| This is the const version of bottomLeftCorner(Index, Index). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner () |
| template<int CRows, int CCols> | |
| EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner () const |
| This is the const version of bottomLeftCorner<int, int>(). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner (Index cRows, Index cCols) |
| template<int CRows, int CCols> | |
| const ConstFixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner (Index cRows, Index cCols) const |
| This is the const version of bottomLeftCorner<int, int>(Index, Index). More... | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr | bottomRightCorner (Index cRows, Index cCols) |
| EIGEN_DEVICE_FUNC const ConstBlockXpr | bottomRightCorner (Index cRows, Index cCols) const |
| This is the const version of bottomRightCorner(Index, Index). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type | bottomRightCorner () |
| template<int CRows, int CCols> | |
| EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type | bottomRightCorner () const |
| This is the const version of bottomRightCorner<int, int>(). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type | bottomRightCorner (Index cRows, Index cCols) |
| template<int CRows, int CCols> | |
| const ConstFixedBlockXpr< CRows, CCols >::Type | bottomRightCorner (Index cRows, Index cCols) const |
| This is the const version of bottomRightCorner<int, int>(Index, Index). More... | |
| EIGEN_DEVICE_FUNC RowsBlockXpr | bottomRows (Index n) |
| EIGEN_DEVICE_FUNC ConstRowsBlockXpr | bottomRows (Index n) const |
| This is the const version of bottomRows(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type | bottomRows (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type | bottomRows (Index n=N) const |
| This is the const version of bottomRows<int>(). More... | |
| EIGEN_DEVICE_FUNC ColXpr | col (Index i) |
| EIGEN_DEVICE_FUNC ConstColXpr | col (Index i) const |
| This is the const version of col(). More... | |
| EIGEN_DEVICE_FUNC ConstColwiseReturnType | colwise () const |
| EIGEN_DEVICE_FUNC ColwiseReturnType | colwise () |
| EIGEN_DEVICE_FUNC Index | count () const |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType | eval () const |
| template<typename Dest > | |
| EIGEN_DEVICE_FUNC void | evalTo (Dest &) const |
| EIGEN_DEVICE_FUNC void | fill (const Scalar &value) |
| template<unsigned int Added, unsigned int Removed> | |
| EIGEN_DEPRECATED const Derived & | flagged () const |
| EIGEN_DEVICE_FUNC const ForceAlignedAccess< Derived > | forceAlignedAccess () const |
| EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived > | forceAlignedAccess () |
| template<bool Enable> | |
| EIGEN_DEVICE_FUNC const internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type | forceAlignedAccessIf () const |
| template<bool Enable> | |
| EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type | forceAlignedAccessIf () |
| const WithFormat< Derived > | format (const IOFormat &fmt) const |
| bool | hasNaN () const |
| EIGEN_DEVICE_FUNC SegmentReturnType | head (Index n) |
| EIGEN_DEVICE_FUNC ConstSegmentReturnType | head (Index n) const |
| This is the const version of head(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type | head (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type | head (Index n=N) const |
| This is the const version of head<int>(). More... | |
| EIGEN_DEVICE_FUNC Index | innerSize () const |
| template<typename OtherDerived > | |
| bool | isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec) const |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC bool | isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| EIGEN_DEVICE_FUNC bool | isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| EIGEN_DEVICE_FUNC bool | isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| template<typename Derived > | |
| bool | isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const |
| template<typename OtherDerived > | |
| bool | isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec) const |
| EIGEN_DEVICE_FUNC bool | isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC bool | isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| EIGEN_DEVICE_FUNC bool | isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| EIGEN_DEVICE_FUNC bool | isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
| template<typename OtherDerived > | |
| EIGEN_STRONG_INLINE Derived & | lazyAssign (const DenseBase< OtherDerived > &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC Derived & | lazyAssign (const DenseBase< OtherDerived > &other) |
| EIGEN_DEVICE_FUNC ColsBlockXpr | leftCols (Index n) |
| EIGEN_DEVICE_FUNC ConstColsBlockXpr | leftCols (Index n) const |
| This is the const version of leftCols(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type | leftCols (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type | leftCols (Index n=N) const |
| This is the const version of leftCols<int>(). More... | |
| template<int p> | |
| RealScalar | lpNorm () const |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | maxCoeff () const |
| template<typename IndexType > | |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
| template<typename IndexType > | |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | maxCoeff (IndexType *index) const |
| EIGEN_DEVICE_FUNC Scalar | mean () const |
| EIGEN_DEVICE_FUNC ColsBlockXpr | middleCols (Index startCol, Index numCols) |
| EIGEN_DEVICE_FUNC ConstColsBlockXpr | middleCols (Index startCol, Index numCols) const |
| This is the const version of middleCols(Index,Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type | middleCols (Index startCol, Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type | middleCols (Index startCol, Index n=N) const |
| This is the const version of middleCols<int>(). More... | |
| EIGEN_DEVICE_FUNC RowsBlockXpr | middleRows (Index startRow, Index n) |
| EIGEN_DEVICE_FUNC ConstRowsBlockXpr | middleRows (Index startRow, Index n) const |
| This is the const version of middleRows(Index,Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type | middleRows (Index startRow, Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type | middleRows (Index startRow, Index n=N) const |
| This is the const version of middleRows<int>(). More... | |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | minCoeff () const |
| template<typename IndexType > | |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
| template<typename IndexType > | |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar | minCoeff (IndexType *index) const |
| EIGEN_DEVICE_FUNC const NestByValue< Derived > | nestByValue () const |
| EIGEN_DEVICE_FUNC Index | nonZeros () const |
| template<typename CustomNullaryOp > | |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
| template<typename CustomNullaryOp > | |
| EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (Index size, const CustomNullaryOp &func) |
| template<typename CustomNullaryOp > | |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (const CustomNullaryOp &func) |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & | operator*= (const Scalar &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC Derived & | operator+= (const EigenBase< OtherDerived > &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC Derived & | operator-= (const EigenBase< OtherDerived > &other) |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & | operator/= (const Scalar &other) |
| template<typename OtherDerived > | |
| CommaInitializer< Derived > | operator<< (const DenseBase< OtherDerived > &other) |
| EIGEN_DEVICE_FUNC CommaInitializer< Derived > | operator<< (const Scalar &s) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC CommaInitializer< Derived > | operator<< (const DenseBase< OtherDerived > &other) |
| template<typename OtherDerived > | |
| Derived & | operator= (const ReturnByValue< OtherDerived > &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & | operator= (const DenseBase< OtherDerived > &other) |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & | operator= (const DenseBase &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC Derived & | operator= (const EigenBase< OtherDerived > &other) |
| Copies the generic expression other into *this. More... | |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC Derived & | operator= (const ReturnByValue< OtherDerived > &func) |
| EIGEN_DEVICE_FUNC Index | outerSize () const |
| EIGEN_DEVICE_FUNC Scalar | prod () const |
| template<typename Func > | |
| internal::traits< Derived >::Scalar | redux (const Func &func) const |
| template<typename BinaryOp > | |
| EIGEN_DEVICE_FUNC Scalar | redux (const BinaryOp &func) const |
| template<int RowFactor, int ColFactor> | |
| const Replicate< Derived, RowFactor, ColFactor > | replicate () const |
| template<int RowFactor, int ColFactor> | |
| EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor > | replicate () const |
| EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic > | replicate (Index rowFactor, Index colFactor) const |
| EIGEN_DEVICE_FUNC void | resize (Index newSize) |
| EIGEN_DEVICE_FUNC void | resize (Index rows, Index cols) |
| EIGEN_DEVICE_FUNC ReverseReturnType | reverse () |
| EIGEN_DEVICE_FUNC ConstReverseReturnType | reverse () const |
| EIGEN_DEVICE_FUNC void | reverseInPlace () |
| EIGEN_DEVICE_FUNC ColsBlockXpr | rightCols (Index n) |
| EIGEN_DEVICE_FUNC ConstColsBlockXpr | rightCols (Index n) const |
| This is the const version of rightCols(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type | rightCols (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type | rightCols (Index n=N) const |
| This is the const version of rightCols<int>(). More... | |
| EIGEN_DEVICE_FUNC RowXpr | row (Index i) |
| EIGEN_DEVICE_FUNC ConstRowXpr | row (Index i) const |
| This is the const version of row(). */. More... | |
| EIGEN_DEVICE_FUNC ConstRowwiseReturnType | rowwise () const |
| EIGEN_DEVICE_FUNC RowwiseReturnType | rowwise () |
| EIGEN_DEVICE_FUNC SegmentReturnType | segment (Index start, Index n) |
| EIGEN_DEVICE_FUNC ConstSegmentReturnType | segment (Index start, Index n) const |
| This is the const version of segment(Index,Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type | segment (Index start, Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type | segment (Index start, Index n=N) const |
| This is the const version of segment<int>(Index). More... | |
| template<typename ThenDerived , typename ElseDerived > | |
| const Select< Derived, ThenDerived, ElseDerived > | select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const |
| template<typename ThenDerived > | |
| const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType > | select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const |
| template<typename ElseDerived > | |
| const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived > | select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const |
| EIGEN_DEVICE_FUNC Derived & | setConstant (const Scalar &value) |
| EIGEN_DEVICE_FUNC Derived & | setLinSpaced (Index size, const Scalar &low, const Scalar &high) |
| Sets a linearly spaced vector. More... | |
| EIGEN_DEVICE_FUNC Derived & | setLinSpaced (const Scalar &low, const Scalar &high) |
| Sets a linearly spaced vector. More... | |
| EIGEN_DEVICE_FUNC Derived & | setOnes () |
| EIGEN_DEVICE_FUNC Derived & | setRandom () |
| EIGEN_DEVICE_FUNC Derived & | setZero () |
| EIGEN_DEVICE_FUNC Scalar | sum () const |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC void | swap (const DenseBase< OtherDerived > &other) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC void | swap (PlainObjectBase< OtherDerived > &other) |
| EIGEN_DEVICE_FUNC SegmentReturnType | tail (Index n) |
| EIGEN_DEVICE_FUNC ConstSegmentReturnType | tail (Index n) const |
| This is the const version of tail(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC FixedSegmentReturnType< N >::Type | tail (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N >::Type | tail (Index n=N) const |
| This is the const version of tail<int>. More... | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr | topLeftCorner (Index cRows, Index cCols) |
| EIGEN_DEVICE_FUNC const ConstBlockXpr | topLeftCorner (Index cRows, Index cCols) const |
| This is the const version of topLeftCorner(Index, Index). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type | topLeftCorner () |
| template<int CRows, int CCols> | |
| EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type | topLeftCorner () const |
| This is the const version of topLeftCorner<int, int>(). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type | topLeftCorner (Index cRows, Index cCols) |
| template<int CRows, int CCols> | |
| const ConstFixedBlockXpr< CRows, CCols >::Type | topLeftCorner (Index cRows, Index cCols) const |
| This is the const version of topLeftCorner<int, int>(Index, Index). More... | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC BlockXpr | topRightCorner (Index cRows, Index cCols) |
| EIGEN_DEVICE_FUNC const ConstBlockXpr | topRightCorner (Index cRows, Index cCols) const |
| This is the const version of topRightCorner(Index, Index). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols >::Type | topRightCorner () |
| template<int CRows, int CCols> | |
| EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type | topRightCorner () const |
| This is the const version of topRightCorner<int, int>(). More... | |
| template<int CRows, int CCols> | |
| EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL FixedBlockXpr< CRows, CCols >::Type | topRightCorner (Index cRows, Index cCols) |
| template<int CRows, int CCols> | |
| const ConstFixedBlockXpr< CRows, CCols >::Type | topRightCorner (Index cRows, Index cCols) const |
| This is the const version of topRightCorner<int, int>(Index, Index). More... | |
| EIGEN_DEVICE_FUNC RowsBlockXpr | topRows (Index n) |
| EIGEN_DEVICE_FUNC ConstRowsBlockXpr | topRows (Index n) const |
| This is the const version of topRows(Index). More... | |
| template<int N> | |
| EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type | topRows (Index n=N) |
| template<int N> | |
| EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type | topRows (Index n=N) const |
| This is the const version of topRows<int>(). More... | |
| EIGEN_DEVICE_FUNC Scalar | trace () const |
| EIGEN_DEVICE_FUNC TransposeReturnType | transpose () |
| EIGEN_DEVICE_FUNC ConstTransposeReturnType | transpose () const |
| EIGEN_DEVICE_FUNC void | transposeInPlace () |
| EIGEN_DEVICE_FUNC CoeffReturnType | value () const |
| template<typename Visitor > | |
| EIGEN_DEVICE_FUNC void | visit (Visitor &func) const |
Static Public Member Functions | |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Constant (Index rows, Index cols, const Scalar &value) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Constant (Index size, const Scalar &value) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Constant (const Scalar &value) |
| static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high) |
| static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType | LinSpaced (Index size, const Scalar &low, const Scalar &high) |
| Sets a linearly spaced vector. More... | |
| static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, const Scalar &low, const Scalar &high) |
| static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType | LinSpaced (const Scalar &low, const Scalar &high) |
| Sets a linearly spaced vector. More... | |
| template<typename CustomNullaryOp > | |
| static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
| template<typename CustomNullaryOp > | |
| static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index size, const CustomNullaryOp &func) |
| template<typename CustomNullaryOp > | |
| static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (const CustomNullaryOp &func) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Ones (Index rows, Index cols) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Ones (Index size) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Ones () |
| static const RandomReturnType | Random (Index rows, Index cols) |
| static const RandomReturnType | Random (Index size) |
| static const RandomReturnType | Random () |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Zero (Index rows, Index cols) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Zero (Index size) |
| static EIGEN_DEVICE_FUNC const ConstantReturnType | Zero () |
Protected Member Functions | |
| EIGEN_DEVICE_FUNC | DenseBase () |
Private Member Functions | |
| EIGEN_DEVICE_FUNC | DenseBase (int) |
| EIGEN_DEVICE_FUNC | DenseBase (int, int) |
| template<typename OtherDerived > | |
| EIGEN_DEVICE_FUNC | DenseBase (const DenseBase< OtherDerived > &) |
Related Functions | |
(Note that these are not member functions.) | |
| template<typename Derived > | |
| std::ostream & | operator<< (std::ostream &s, const DenseBase< Derived > &m) |
Detailed Description
template<typename Derived>
class Eigen::DenseBase< Derived >
Base class for all dense matrices, vectors, and arrays.
This class is the base that is inherited by all dense objects (matrix, vector, arrays, and related expression types). The common Eigen API for dense objects is contained in this class.
- Template Parameters
-
Derived is the derived type, e.g., a matrix type or an expression.
This class can be extended with the help of the plugin mechanism described on the page TopicCustomizing_Plugins by defining the preprocessor symbol EIGEN_DENSEBASE_PLUGIN.
- See also
- TopicClassHierarchy
Definition at line 41 of file DenseBase.h.
Member Typedef Documentation
| typedef DenseCoeffsBase<Derived> Eigen::DenseBase< Derived >::Base |
Definition at line 74 of file DenseBase.h.
| typedef Block<Derived> Eigen::DenseBase< Derived >::BlockXpr |
Definition at line 33 of file DenseBase.h.
| typedef Base::CoeffReturnType Eigen::DenseBase< Derived >::CoeffReturnType |
Definition at line 96 of file DenseBase.h.
| typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::DenseBase< Derived >::ColsBlockXpr |
Definition at line 21 of file DenseBase.h.
| typedef VectorwiseOp<Derived, Vertical> Eigen::DenseBase< Derived >::ColwiseReturnType |
Definition at line 493 of file DenseBase.h.
| typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::DenseBase< Derived >::ColXpr |
Definition at line 15 of file DenseBase.h.
| typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,PlainObject> Eigen::DenseBase< Derived >::ConstantReturnType |
Definition at line 262 of file DenseBase.h.
| typedef const Block<const Derived> Eigen::DenseBase< Derived >::ConstBlockXpr |
Definition at line 34 of file DenseBase.h.
| typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::DenseBase< Derived >::ConstColsBlockXpr |
Definition at line 22 of file DenseBase.h.
| typedef const VectorwiseOp<const Derived, Vertical> Eigen::DenseBase< Derived >::ConstColwiseReturnType |
Definition at line 494 of file DenseBase.h.
| typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::DenseBase< Derived >::ConstColXpr |
Definition at line 16 of file DenseBase.h.
| typedef const Reverse<const Derived, BothDirections> Eigen::DenseBase< Derived >::ConstReverseReturnType |
Definition at line 560 of file DenseBase.h.
| typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::ConstRowsBlockXpr |
Definition at line 25 of file DenseBase.h.
| typedef const VectorwiseOp<const Derived, Horizontal> Eigen::DenseBase< Derived >::ConstRowwiseReturnType |
Definition at line 492 of file DenseBase.h.
| typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::ConstRowXpr |
Definition at line 19 of file DenseBase.h.
| typedef const VectorBlock<const Derived> Eigen::DenseBase< Derived >::ConstSegmentReturnType |
Definition at line 40 of file DenseBase.h.
| typedef internal::add_const<Transpose<const Derived> >::type Eigen::DenseBase< Derived >::ConstTransposeReturnType |
Definition at line 322 of file DenseBase.h.
| typedef Matrix<typename NumTraits<typename internal::traits<Derived>::Scalar>::Real, internal::traits<Derived>::ColsAtCompileTime, 1> Eigen::DenseBase< Derived >::EigenvaluesReturnType |
Definition at line 268 of file DenseBase.h.
| typedef internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type Eigen::DenseBase< Derived >::EvalReturnType |
Definition at line 392 of file DenseBase.h.
| typedef Eigen::InnerIterator<Derived> Eigen::DenseBase< Derived >::InnerIterator |
Inner iterator type to iterate over the coefficients of a row or column.
- See also
- class InnerIterator
Definition at line 53 of file DenseBase.h.
| typedef internal::find_best_packet<Scalar,SizeAtCompileTime>::type Eigen::DenseBase< Derived >::PacketScalar |
Definition at line 174 of file DenseBase.h.
| typedef Array<typename internal::traits<Derived>::Scalar, internal::traits<Derived>::RowsAtCompileTime, internal::traits<Derived>::ColsAtCompileTime, AutoAlign | (internal::traits<Derived>::Flags&RowMajorBit ? RowMajor : ColMajor), internal::traits<Derived>::MaxRowsAtCompileTime, internal::traits<Derived>::MaxColsAtCompileTime > Eigen::DenseBase< Derived >::PlainArray |
The plain array type corresponding to this expression.
- See also
- PlainObject
Definition at line 196 of file DenseBase.h.
| typedef Matrix<typename internal::traits<Derived>::Scalar, internal::traits<Derived>::RowsAtCompileTime, internal::traits<Derived>::ColsAtCompileTime, AutoAlign | (internal::traits<Derived>::Flags&RowMajorBit ? RowMajor : ColMajor), internal::traits<Derived>::MaxRowsAtCompileTime, internal::traits<Derived>::MaxColsAtCompileTime > Eigen::DenseBase< Derived >::PlainMatrix |
The plain matrix type corresponding to this expression.
- See also
- PlainObject
Definition at line 186 of file DenseBase.h.
| typedef internal::conditional<internal::is_same<typename internal::traits<Derived>::XprKind,MatrixXpr >::value, PlainMatrix, PlainArray>::type Eigen::DenseBase< Derived >::PlainObject |
The plain matrix or array type corresponding to this expression.
This is not necessarily exactly the return type of eval(). In the case of plain matrices, the return type of eval() is a const reference to a matrix, not a matrix! It is however guaranteed that the return type of eval() is either PlainObject or const PlainObject&.
Definition at line 205 of file DenseBase.h.
| typedef CwiseNullaryOp<internal::linspaced_op<Scalar,PacketScalar>,PlainObject> Eigen::DenseBase< Derived >::RandomAccessLinSpacedReturnType |
Definition at line 266 of file DenseBase.h.
| typedef CwiseNullaryOp<internal::scalar_random_op<Scalar>,PlainObject> Eigen::DenseBase< Derived >::RandomReturnType |
Definition at line 521 of file DenseBase.h.
| typedef NumTraits<Scalar>::Real Eigen::DenseBase< Derived >::RealScalar |
Definition at line 73 of file DenseBase.h.
| typedef Reverse<Derived, BothDirections> Eigen::DenseBase< Derived >::ReverseReturnType |
Definition at line 559 of file DenseBase.h.
| typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::RowsBlockXpr |
Definition at line 24 of file DenseBase.h.
| typedef VectorwiseOp<Derived, Horizontal> Eigen::DenseBase< Derived >::RowwiseReturnType |
Definition at line 491 of file DenseBase.h.
| typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::RowXpr |
Definition at line 18 of file DenseBase.h.
| typedef internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::Scalar |
The numeric type of the expression' coefficients, e.g. float, double, int or std::complex<float>, etc.
Definition at line 66 of file DenseBase.h.
| typedef VectorBlock<Derived> Eigen::DenseBase< Derived >::SegmentReturnType |
Definition at line 39 of file DenseBase.h.
| typedef CwiseNullaryOp<internal::linspaced_op<Scalar,PacketScalar>,PlainObject> Eigen::DenseBase< Derived >::SequentialLinSpacedReturnType |
Definition at line 264 of file DenseBase.h.
| typedef internal::traits<Derived>::StorageIndex Eigen::DenseBase< Derived >::StorageIndex |
The type used to store indices.
This typedef is relevant for types that store multiple indices such as PermutationMatrix or Transpositions, otherwise it defaults to Eigen::Index
- See also
- TopicPreprocessorDirectives, Eigen::Index, SparseMatrixBase.
Definition at line 63 of file DenseBase.h.
| typedef internal::traits<Derived>::StorageKind Eigen::DenseBase< Derived >::StorageKind |
Definition at line 55 of file DenseBase.h.
| typedef Transpose<Derived> Eigen::DenseBase< Derived >::TransposeReturnType |
Definition at line 319 of file DenseBase.h.
| typedef Scalar Eigen::DenseBase< Derived >::value_type |
The numeric type of the expression' coefficients, e.g. float, double, int or std::complex<float>, etc.
It is an alias for the Scalar type
Definition at line 71 of file DenseBase.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.
|
| 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.
|
| MaxRowsAtCompileTime |
This value is equal to the maximum possible number of rows that this expression might have. If this expression might have an arbitrarily high number of rows, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. |
| MaxColsAtCompileTime |
This value is equal to the maximum possible number of columns that this expression might have. If this expression might have an arbitrarily high number of columns, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. |
| MaxSizeAtCompileTime |
This value is equal to the maximum possible number of coefficients that this expression might have. If this expression might have an arbitrarily high number of coefficients, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. |
| 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. |
| IsRowMajor |
True if this expression has row-major storage order. |
| InnerSizeAtCompileTime | |
| InnerStrideAtCompileTime | |
| OuterStrideAtCompileTime | |
Definition at line 98 of file DenseBase.h.
| anonymous enum |
| Enumerator | |
|---|---|
| IsPlainObjectBase | |
Definition at line 176 of file DenseBase.h.
Constructor & Destructor Documentation
|
inlineprotected |
Default constructor. Do nothing.
Definition at line 591 of file DenseBase.h.
|
explicitprivate |
|
private |
|
explicitprivate |
Member Function Documentation
|
inline |
- Returns
- true if all coefficients are true
Example:
Output:
- See also
- any(), Cwise::operator<()
Definition at line 81 of file BooleanRedux.h.
|
inline |
- Returns
- true if
*thiscontains only finite numbers, i.e., no NaN and no +/-INF values.
- See also
- hasNaN()
Definition at line 153 of file BooleanRedux.h.
|
inline |
- Returns
- true if at least one coefficient is true
- See also
- all()
Definition at line 105 of file BooleanRedux.h.
|
inline |
- Returns
- a dynamic-size expression of a block in *this.
- Parameters
-
startRow the first row in the block startCol the first column in the block blockRows the number of rows in the block blockCols the number of columns in the block
Example:
Output:
- Note
- Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size matrix, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
- See also
- class Block, block(Index,Index)
Definition at line 65 of file DenseBase.h.
|
inline |
This is the const version of block(Index,Index,Index,Index). */.
Definition at line 72 of file DenseBase.h.
|
inline |
- Returns
- a fixed-size expression of a block in *this.
The template parameters NRows and NCols are the number of rows and columns in the block.
- Parameters
-
startRow the first row in the block startCol the first column in the block
Example:
Output:
- Note
- since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:m.template block<3,3>(1,1);
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 781 of file DenseBase.h.
|
inline |
This is the const version of block<>(Index, Index). */.
Definition at line 789 of file DenseBase.h.
|
inline |
- Returns
- an expression of a block in *this.
- Template Parameters
-
NRows number of rows in block as specified at compile-time NCols number of columns in block as specified at compile-time
- Parameters
-
startRow the first row in the block startCol the first column in the block blockRows number of rows in block as specified at run-time blockCols number of columns in block as specified at run-time
This function is mainly useful for blocks where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, blockRows should equal NRows unless NRows is Dynamic, and the same for the number of columns.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 816 of file DenseBase.h.
|
inline |
This is the const version of block<>(Index, Index, Index, Index).
Definition at line 824 of file DenseBase.h.
|
inline |
- Returns
- a dynamic-size expression of a bottom-left corner of *this.
- Parameters
-
cRows the number of rows in the corner cCols the number of columns in the corner
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 349 of file DenseBase.h.
|
inline |
This is the const version of bottomLeftCorner(Index, Index).
Definition at line 356 of file DenseBase.h.
|
inline |
- Returns
- an expression of a fixed-size bottom-left corner of *this.
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 374 of file DenseBase.h.
|
inline |
This is the const version of bottomLeftCorner<int, int>().
Definition at line 382 of file DenseBase.h.
|
inline |
- Returns
- an expression of a bottom-left corner of *this.
- Template Parameters
-
CRows number of rows in corner as specified at compile-time CCols number of columns in corner as specified at compile-time
- Parameters
-
cRows number of rows in corner as specified at run-time cCols number of columns in corner as specified at run-time
This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.
Example:
Output:
- See also
- class Block
Definition at line 407 of file DenseBase.h.
|
inline |
This is the const version of bottomLeftCorner<int, int>(Index, Index).
Definition at line 414 of file DenseBase.h.
|
inline |
- Returns
- a dynamic-size expression of a bottom-right corner of *this.
- Parameters
-
cRows the number of rows in the corner cCols the number of columns in the corner
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 264 of file DenseBase.h.
|
inline |
This is the const version of bottomRightCorner(Index, Index).
Definition at line 271 of file DenseBase.h.
|
inline |
- Returns
- an expression of a fixed-size bottom-right corner of *this.
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 289 of file DenseBase.h.
|
inline |
This is the const version of bottomRightCorner<int, int>().
Definition at line 297 of file DenseBase.h.
|
inline |
- Returns
- an expression of a bottom-right corner of *this.
- Template Parameters
-
CRows number of rows in corner as specified at compile-time CCols number of columns in corner as specified at compile-time
- Parameters
-
cRows number of rows in corner as specified at run-time cCols number of columns in corner as specified at run-time
This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.
Example:
Output:
- See also
- class Block
Definition at line 322 of file DenseBase.h.
|
inline |
This is the const version of bottomRightCorner<int, int>(Index, Index).
Definition at line 329 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the bottom rows of *this.
- Parameters
-
n the number of rows in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 489 of file DenseBase.h.
|
inline |
This is the const version of bottomRows(Index).
Definition at line 496 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the bottom rows of *this.
- Template Parameters
-
N the number of rows in the block as specified at compile-time
- Parameters
-
n the number of rows in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 518 of file DenseBase.h.
|
inline |
This is the const version of bottomRows<int>().
Definition at line 526 of file DenseBase.h.
|
inline |
- Returns
- an expression of the i-th column of *this. Note that the numbering starts at 0.
Example:
Output:
Definition at line 839 of file DenseBase.h.
|
inline |
This is the const version of col().
Definition at line 846 of file DenseBase.h.
|
inline |
- Returns
- a VectorwiseOp wrapper of *this providing additional partial reduction operations
Example:
Output:
- See also
- rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting
Definition at line 516 of file DenseBase.h.
|
inline |
- Returns
- a writable VectorwiseOp wrapper of *this providing additional partial reduction operations
- See also
- rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting
Definition at line 674 of file VectorwiseOp.h.
|
static |
- Returns
- an expression of a constant matrix of value value
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this DenseBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
- See also
- class CwiseNullaryOp
Definition at line 174 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a constant matrix of value value
The parameter size is the size of the returned vector. Must be compatible with this DenseBase type.
This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
- See also
- class CwiseNullaryOp
Definition at line 196 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a constant matrix of value value
This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.
The template parameter CustomNullaryOp is the type of the functor.
- See also
- class CwiseNullaryOp
Definition at line 212 of file CwiseNullaryOp.h.
|
inline |
- Returns
- the number of coefficients which evaluate to true
Definition at line 129 of file BooleanRedux.h.
|
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 401 of file DenseBase.h.
|
inline |
Definition at line 584 of file DenseBase.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::DenseBase< Derived >::fill | ( | const Scalar & | val | ) |
Alias for setConstant(): sets all coefficients in this expression to val.
- See also
- setConstant(), Constant(), class CwiseNullaryOp
Definition at line 315 of file CwiseNullaryOp.h.
|
inline |
- Deprecated:
- it now returns
*this
Definition at line 312 of file DenseBase.h.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
- Returns
- a WithFormat proxy object allowing to print a matrix the with given format fmt.
See class IOFormat for some examples.
- See also
- class IOFormat, class WithFormat
Definition at line 473 of file DenseBase.h.
|
inline |
- Returns
- true is
*thiscontains at least one Not A Number (NaN).
- See also
- allFinite()
Definition at line 139 of file BooleanRedux.h.
|
inline |
- Returns
- a dynamic-size expression of the first coefficients of *this.
- Parameters
-
n the number of coefficients in the segment
Example:
Output:
- Note
- Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
- See also
- class Block, block(Index,Index)
Definition at line 920 of file DenseBase.h.
|
inline |
This is the const version of head(Index).
Definition at line 928 of file DenseBase.h.
|
inline |
- Returns
- a fixed-size expression of the first coefficients of *this.
- Template Parameters
-
N the number of coefficients in the segment as specified at compile-time
- Parameters
-
n the number of coefficients in the segment as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block
Definition at line 1014 of file DenseBase.h.
|
inline |
This is the const version of head<int>().
Definition at line 1023 of file DenseBase.h.
|
inline |
- Returns
- the inner size.
- Note
- For a vector, this is just the size. For a matrix (non-vector), this is the minor dimension with respect to the storage order, i.e., the number of rows for a column-major matrix, and the number of columns for a row-major matrix.
Definition at line 230 of file DenseBase.h.
| bool Eigen::DenseBase< Derived >::isApprox | ( | const DenseBase< OtherDerived > & | other, |
| const RealScalar & | prec | ||
| ) | const |
- Returns
trueif*thisis approximately equal to other, within the precision determined by prec.
- Note
- The fuzzy compares are done multiplicatively. Two vectors
and 
are considered to be approximately equal within precision 
if
For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm L2 norm).![\[ \Vert v - w \Vert \leqslant p\,\min(\Vert v\Vert, \Vert w\Vert). \]](form_16.png)
-
Because of the multiplicativeness of this comparison, one can't use this function to check whether
*thisis approximately equal to the zero matrix or vector. Indeed,isApprox(zero)returns false unless*thisitself is exactly the zero matrix or vector. If you want to test whether*thisis zero, use internal::isMuchSmallerThan(const RealScalar&, RealScalar) instead.
- See also
- internal::isMuchSmallerThan(const RealScalar&, RealScalar) const
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isApprox | ( | const DenseBase< OtherDerived > & | other, |
| const RealScalar & | prec = NumTraits< Scalar >::dummy_precision() |
||
| ) | const |
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isApproxToConstant | ( | const Scalar & | val, |
| const RealScalar & | prec = NumTraits<Scalar>::dummy_precision() |
||
| ) | const |
- Returns
- true if all coefficients in this matrix are approximately equal to val, to within precision prec
Definition at line 290 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isConstant | ( | const Scalar & | val, |
| const RealScalar & | prec = NumTraits<Scalar>::dummy_precision() |
||
| ) | const |
This is just an alias for isApproxToConstant().
- Returns
- true if all coefficients in this matrix are approximately equal to value, to within precision prec
Definition at line 305 of file CwiseNullaryOp.h.
| bool Eigen::DenseBase< Derived >::isMuchSmallerThan | ( | const typename NumTraits< Scalar >::Real & | other, |
| const RealScalar & | prec | ||
| ) | const |
- Returns
trueif the norm of*thisis much smaller than other, within the precision determined by prec.
- Note
- The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than
within precision if ![\[ \Vert v \Vert \leqslant p\,\vert x\vert. \]](form_18.png)
For matrices, the comparison is done using the Hilbert-Schmidt norm. For this reason, the value of the reference scalar other should come from the Hilbert-Schmidt norm of a reference matrix of same dimensions.
- See also
- isApprox(), isMuchSmallerThan(const DenseBase<OtherDerived>&, RealScalar) const
| bool Eigen::DenseBase< Derived >::isMuchSmallerThan | ( | const DenseBase< OtherDerived > & | other, |
| const RealScalar & | prec | ||
| ) | const |
- Returns
trueif the norm of*thisis much smaller than the norm of other, within the precision determined by prec.
- Note
- The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than a vector within precision if
For matrices, the comparison is done using the Hilbert-Schmidt norm.![\[ \Vert v \Vert \leqslant p\,\Vert w\Vert. \]](form_19.png)
- See also
- isApprox(), isMuchSmallerThan(const RealScalar&, RealScalar) const
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isMuchSmallerThan | ( | const RealScalar & | other, |
| const RealScalar & | prec = NumTraits< Scalar >::dummy_precision() |
||
| ) | const |
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isMuchSmallerThan | ( | const DenseBase< OtherDerived > & | other, |
| const RealScalar & | prec = NumTraits< Scalar >::dummy_precision() |
||
| ) | const |
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isOnes | ( | const RealScalar & | prec = NumTraits<Scalar>::dummy_precision() | ) | const |
- Returns
- true if *this is approximately equal to the matrix where all coefficients are equal to 1, within the precision given by prec.
Example:
Output:
- See also
- class CwiseNullaryOp, Ones()
Definition at line 612 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isZero | ( | const RealScalar & | prec = NumTraits<Scalar>::dummy_precision() | ) | const |
- Returns
- true if *this is approximately equal to the zero matrix, within the precision given by prec.
Example:
Output:
- See also
- class CwiseNullaryOp, Zero()
Definition at line 481 of file CwiseNullaryOp.h.
| EIGEN_STRONG_INLINE Derived& Eigen::DenseBase< Derived >::lazyAssign | ( | const DenseBase< OtherDerived > & | other | ) |
| EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::lazyAssign | ( | const DenseBase< OtherDerived > & | other | ) |
|
inline |
- Returns
- a block consisting of the left columns of *this.
- Parameters
-
n the number of columns in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 603 of file DenseBase.h.
|
inline |
This is the const version of leftCols(Index).
Definition at line 610 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the left columns of *this.
- Template Parameters
-
N the number of columns in the block as specified at compile-time
- Parameters
-
n the number of columns in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 632 of file DenseBase.h.
|
inline |
This is the const version of leftCols<int>().
Definition at line 640 of file DenseBase.h.
|
static |
- Deprecated:
- because of accuracy loss. In Eigen 3.3, it is an alias for LinSpaced(Index,const Scalar&,const Scalar&)
- See also
- LinSpaced(Index,Scalar,Scalar), setLinSpaced(Index,const Scalar&,const Scalar&)
Definition at line 224 of file CwiseNullaryOp.h.
|
static |
Sets a linearly spaced vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
Example:
Output:
For integer scalar types, an even spacing is possible if and only if the length of the range, i.e., high-low is a scalar multiple of size-1, or if size is a scalar multiple of the number of values high-low+1 (meaning each value can be repeated the same number of time). If one of these two considions is not satisfied, then high is lowered to the largest value satisfying one of this constraint. Here are some examples:
Example:
Output:
Definition at line 268 of file CwiseNullaryOp.h.
|
static |
- Deprecated:
- because of accuracy loss. In Eigen 3.3, it is an alias for LinSpaced(const Scalar&,const Scalar&)
- See also
- LinSpaced(Scalar,Scalar)
Definition at line 236 of file CwiseNullaryOp.h.
|
static |
Sets a linearly spaced vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
Example:
Output:
For integer scalar types, an even spacing is possible if and only if the length of the range, i.e., high-low is a scalar multiple of size-1, or if size is a scalar multiple of the number of values high-low+1 (meaning each value can be repeated the same number of time). If one of these two considions is not satisfied, then high is lowered to the largest value satisfying one of this constraint. Here are some examples:
Example:
Output:
- See also
- setLinSpaced(Index,const Scalar&,const Scalar&), CwiseNullaryOp Special version for fixed size types which does not require the size parameter.
Definition at line 280 of file CwiseNullaryOp.h.
| EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff | ( | ) | const |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff | ( | IndexType * | rowId, |
| IndexType * | colId | ||
| ) | const |
- Returns
- the maximum of all coefficients of *this and puts in *row and *col its location.
- Warning
- the result is undefined if
*thiscontains NaN.
- See also
- DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visit(), DenseBase::maxCoeff()
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff | ( | IndexType * | index | ) | const |
- Returns
- the maximum of all coefficients of *this and puts in *index its location.
- Warning
- the result is undefined if
*thiscontains NaN.
- See also
- DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visitor(), DenseBase::maxCoeff()
| EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::mean | ( | ) | const |
|
inline |
- Returns
- a block consisting of a range of columns of *this.
- Parameters
-
startCol the index of the first column in the block numCols the number of columns in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 716 of file DenseBase.h.
|
inline |
This is the const version of middleCols(Index,Index).
Definition at line 723 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of a range of columns of *this.
- Template Parameters
-
N the number of columns in the block as specified at compile-time
- Parameters
-
startCol the index of the first column in the block n the number of columns in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 746 of file DenseBase.h.
|
inline |
This is the const version of middleCols<int>().
Definition at line 754 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of a range of rows of *this.
- Parameters
-
startRow the index of the first row in the block n the number of rows in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 546 of file DenseBase.h.
|
inline |
This is the const version of middleRows(Index,Index).
Definition at line 553 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of a range of rows of *this.
- Template Parameters
-
N the number of rows in the block as specified at compile-time
- Parameters
-
startRow the index of the first row in the block n the number of rows in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 576 of file DenseBase.h.
|
inline |
This is the const version of middleRows<int>().
Definition at line 584 of file DenseBase.h.
| EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff | ( | ) | const |
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff | ( | IndexType * | rowId, |
| IndexType * | colId | ||
| ) | const |
- Returns
- the minimum of all coefficients of *this and puts in *row and *col its location.
- Warning
- the result is undefined if
*thiscontains NaN.
- See also
- DenseBase::minCoeff(Index*), DenseBase::maxCoeff(Index*,Index*), DenseBase::visit(), DenseBase::minCoeff()
| EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff | ( | IndexType * | index | ) | const |
- Returns
- the minimum of all coefficients of *this and puts in *index its location.
- Warning
- the result is undefined if
*thiscontains NaN.
- See also
- DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::visit(), DenseBase::minCoeff()
|
inline |
- Returns
- an expression of the temporary version of *this.
Definition at line 103 of file NestByValue.h.
|
inline |
- Returns
- the number of nonzero coefficients which is in practice the number of stored coefficients.
Definition at line 210 of file DenseBase.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, typename DenseBase<Derived>::PlainObject> Eigen::DenseBase< Derived >::NullaryExpr | ( | Index | rows, |
| Index | cols, | ||
| const CustomNullaryOp & | func | ||
| ) |
- Returns
- an expression of a matrix defined by a custom functor func
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
- See also
- class CwiseNullaryOp
Definition at line 109 of file CwiseNullaryOp.h.
| EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, typename DenseBase<Derived>::PlainObject> Eigen::DenseBase< Derived >::NullaryExpr | ( | Index | size, |
| const CustomNullaryOp & | func | ||
| ) |
- Returns
- an expression of a matrix defined by a custom functor func
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
The template parameter CustomNullaryOp is the type of the functor.
Here is an example with C++11 random generators:
Output:
- See also
- class CwiseNullaryOp
Definition at line 135 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, typename DenseBase<Derived>::PlainObject> Eigen::DenseBase< Derived >::NullaryExpr | ( | const CustomNullaryOp & | func | ) |
- Returns
- an expression of a matrix defined by a custom functor func
This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.
The template parameter CustomNullaryOp is the type of the functor.
- See also
- class CwiseNullaryOp
Definition at line 154 of file CwiseNullaryOp.h.
|
static |
|
static |
|
static |
|
static |
- Returns
- an expression of a matrix where all coefficients equal one.
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Ones() should be used instead.
Example:
Output:
- See also
- Ones(), Ones(Index), isOnes(), class Ones
Definition at line 557 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a vector where all coefficients equal one.
The parameter newSize is the size of the returned vector. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Ones() should be used instead.
Example:
Output:
- See also
- Ones(), Ones(Index,Index), isOnes(), class Ones
Definition at line 580 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a fixed-size matrix or vector where all coefficients equal one.
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
Output:
- See also
- Ones(Index), Ones(Index,Index), isOnes(), class Ones
Definition at line 597 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator*= | ( | const Scalar & | other | ) |
Definition at line 18 of file SelfCwiseBinaryOp.h.
| EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator+= | ( | const EigenBase< OtherDerived > & | other | ) |
Definition at line 142 of file EigenBase.h.
| EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator-= | ( | const EigenBase< OtherDerived > & | other | ) |
Definition at line 151 of file EigenBase.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator/= | ( | const Scalar & | other | ) |
Definition at line 42 of file SelfCwiseBinaryOp.h.
|
inline |
- See also
- operator<<(const Scalar&)
Definition at line 153 of file CommaInitializer.h.
|
inline |
Convenient operator to set the coefficients of a matrix.
The coefficients must be provided in a row major order and exactly match the size of the matrix. Otherwise an assertion is raised.
Example:
Output:
- Note
- According the c++ standard, the argument expressions of this comma initializer are evaluated in arbitrary order.
- See also
- CommaInitializer::finished(), class CommaInitializer
Definition at line 144 of file CommaInitializer.h.
| EIGEN_DEVICE_FUNC CommaInitializer<Derived> Eigen::DenseBase< Derived >::operator<< | ( | const DenseBase< OtherDerived > & | other | ) |
| Derived& Eigen::DenseBase< Derived >::operator= | ( | const ReturnByValue< OtherDerived > & | other | ) |
Definition at line 82 of file ReturnByValue.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator= | ( | const DenseBase< OtherDerived > & | other | ) |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator= | ( | const DenseBase< Derived > & | other | ) |
| EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator= | ( | const EigenBase< OtherDerived > & | other | ) |
Copies the generic expression other into *this.
The expression must provide a (templated) evalTo(Derived& dst) const function which does the actual job. In practice, this allows any user to write its own special matrix without having to modify MatrixBase
- Returns
- a reference to *this.
Definition at line 133 of file EigenBase.h.
| EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::operator= | ( | const ReturnByValue< OtherDerived > & | func | ) |
|
inline |
- Returns
- the outer size.
- Note
- For a vector, this returns just 1. For a matrix (non-vector), this is the major dimension with respect to the storage order, i.e., the number of columns for a column-major matrix, and the number of rows for a row-major matrix.
Definition at line 218 of file DenseBase.h.
| EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::prod | ( | ) | const |
|
inlinestatic |
- Returns
- a random matrix expression
Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Random() should be used instead.
Example:
Output:
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
See DenseBase::NullaryExpr(Index, const CustomNullaryOp&) for an example using C++11 random generators.
|
inlinestatic |
- Returns
- a random vector expression
Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Random() should be used instead.
Example:
Output:
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary vector whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
|
inlinestatic |
- Returns
- a fixed-size random matrix or vector expression
Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
Output:
This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.
| internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::redux | ( | const Func & | func | ) | const |
- Returns
- the result of a full redux operation on the whole matrix or vector using func
The template parameter BinaryOp is the type of the functor func which must be an associative operator. Both current C++98 and C++11 functor styles are handled.
| EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::redux | ( | const BinaryOp & | func | ) | const |
| const Replicate<Derived,RowFactor,ColFactor> Eigen::DenseBase< Derived >::replicate | ( | ) | const |
- Returns
- an expression of the replication of
*this
Example:
Output:
- See also
- VectorwiseOp::replicate(), DenseBase::replicate(Index,Index), class Replicate
Definition at line 119 of file Replicate.h.
| EIGEN_DEVICE_FUNC const Replicate<Derived,RowFactor,ColFactor> Eigen::DenseBase< Derived >::replicate | ( | ) | const |
|
inline |
- Returns
- an expression of the replication of
*this
Example:
Output:
- See also
- VectorwiseOp::replicate(), DenseBase::replicate<int,int>(), class Replicate
Definition at line 554 of file DenseBase.h.
|
inline |
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.
Definition at line 241 of file DenseBase.h.
|
inline |
Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.
Definition at line 252 of file DenseBase.h.
|
inline |
|
inline |
This is the const version of reverse().
Definition at line 564 of file DenseBase.h.
|
inline |
This is the "in place" version of reverse: it reverses *this.
In most cases it is probably better to simply use the reversed expression of a matrix. However, when reversing the matrix data itself is really needed, then this "in-place" version is probably the right choice because it provides the following additional benefits:
- less error prone: doing the same operation with .reverse() requires special care: m = m.reverse().eval();
- this API enables reverse operations without the need for a temporary
- it allows future optimizations (cache friendliness, etc.)
- See also
- VectorwiseOp::reverseInPlace(), reverse()
|
inline |
- Returns
- a block consisting of the right columns of *this.
- Parameters
-
n the number of columns in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 659 of file DenseBase.h.
|
inline |
This is the const version of rightCols(Index).
Definition at line 666 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the right columns of *this.
- Template Parameters
-
N the number of columns in the block as specified at compile-time
- Parameters
-
n the number of columns in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 688 of file DenseBase.h.
|
inline |
This is the const version of rightCols<int>().
Definition at line 696 of file DenseBase.h.
|
inline |
- Returns
- an expression of the i-th row of *this. Note that the numbering starts at 0.
Example:
Output:
Definition at line 860 of file DenseBase.h.
|
inline |
This is the const version of row(). */.
Definition at line 867 of file DenseBase.h.
|
inline |
- Returns
- a VectorwiseOp wrapper of *this providing additional partial reduction operations
Example:
Output:
- See also
- colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting
Definition at line 504 of file DenseBase.h.
|
inline |
- Returns
- a writable VectorwiseOp wrapper of *this providing additional partial reduction operations
- See also
- colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting
Definition at line 688 of file VectorwiseOp.h.
|
inline |
- Returns
- a dynamic-size expression of a segment (i.e. a vector block) in *this.
- Parameters
-
start the first coefficient in the segment n the number of coefficients in the segment
Example:
Output:
- Note
- Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
- See also
- class Block, segment(Index)
Definition at line 889 of file DenseBase.h.
|
inline |
This is the const version of segment(Index,Index).
Definition at line 898 of file DenseBase.h.
|
inline |
- Returns
- a fixed-size expression of a segment (i.e. a vector block) in
*this
- Template Parameters
-
N the number of coefficients in the segment as specified at compile-time
- Parameters
-
start the index of the first element in the segment n the number of coefficients in the segment as specified at compile-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block
Definition at line 982 of file DenseBase.h.
|
inline |
This is the const version of segment<int>(Index).
Definition at line 991 of file DenseBase.h.
|
inline |
|
inline |
Version of DenseBase::select(const DenseBase&, const DenseBase&) with the else expression being a scalar value.
|
inline |
Version of DenseBase::select(const DenseBase&, const DenseBase&) with the then expression being a scalar value.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setConstant | ( | const Scalar & | val | ) |
Sets all coefficients in this expression to value val.
- See also
- fill(), setConstant(Index,const Scalar&), setConstant(Index,Index,const Scalar&), setZero(), setOnes(), Constant(), class CwiseNullaryOp, setZero(), setOnes()
Definition at line 325 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setLinSpaced | ( | Index | newSize, |
| const Scalar & | low, | ||
| const Scalar & | high | ||
| ) |
Sets a linearly spaced vector.
The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
Example:
Output:
For integer scalar types, do not miss the explanations on the definition of even spacing .
Definition at line 383 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setLinSpaced | ( | const Scalar & | low, |
| const Scalar & | high | ||
| ) |
Sets a linearly spaced vector.
The function fills *this with equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.
For integer scalar types, do not miss the explanations on the definition of even spacing .
- See also
- LinSpaced(Index,const Scalar&,const Scalar&), setLinSpaced(Index, const Scalar&, const Scalar&), CwiseNullaryOp
Definition at line 403 of file CwiseNullaryOp.h.
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setOnes | ( | ) |
Sets all coefficients in this expression to one.
Example:
Output:
- See also
- class CwiseNullaryOp, Ones()
Definition at line 625 of file CwiseNullaryOp.h.
|
inline |
Sets all coefficients in this expression to random values.
Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.
Example:
Output:
- See also
- class CwiseNullaryOp, setRandom(Index), setRandom(Index,Index)
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setZero | ( | ) |
Sets all coefficients in this expression to zero.
Example:
Output:
- See also
- class CwiseNullaryOp, Zero()
Definition at line 499 of file CwiseNullaryOp.h.
| EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::sum | ( | ) | const |
|
inline |
swaps *this with the expression other.
Definition at line 414 of file DenseBase.h.
|
inline |
swaps *this with the matrix or array other.
Definition at line 426 of file DenseBase.h.
|
inline |
- Returns
- a dynamic-size expression of the last coefficients of *this.
- Parameters
-
n the number of coefficients in the segment
Example:
Output:
- Note
- Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
- See also
- class Block, block(Index,Index)
Definition at line 950 of file DenseBase.h.
|
inline |
This is the const version of tail(Index).
Definition at line 958 of file DenseBase.h.
|
inline |
- Returns
- a fixed-size expression of the last coefficients of *this.
- Template Parameters
-
N the number of coefficients in the segment as specified at compile-time
- Parameters
-
n the number of coefficients in the segment as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block
Definition at line 1046 of file DenseBase.h.
|
inline |
This is the const version of tail<int>.
Definition at line 1055 of file DenseBase.h.
|
inline |
- Returns
- a dynamic-size expression of a top-left corner of *this.
- Parameters
-
cRows the number of rows in the corner cCols the number of columns in the corner
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 179 of file DenseBase.h.
|
inline |
This is the const version of topLeftCorner(Index, Index).
Definition at line 186 of file DenseBase.h.
|
inline |
- Returns
- an expression of a fixed-size top-left corner of *this.
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 204 of file DenseBase.h.
|
inline |
This is the const version of topLeftCorner<int, int>().
Definition at line 212 of file DenseBase.h.
|
inline |
- Returns
- an expression of a top-left corner of *this.
- Template Parameters
-
CRows number of rows in corner as specified at compile-time CCols number of columns in corner as specified at compile-time
- Parameters
-
cRows number of rows in corner as specified at run-time cCols number of columns in corner as specified at run-time
This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.
Example:
Output:
- See also
- class Block
Definition at line 237 of file DenseBase.h.
|
inline |
This is the const version of topLeftCorner<int, int>(Index, Index).
Definition at line 244 of file DenseBase.h.
|
inline |
- Returns
- a dynamic-size expression of a top-right corner of *this.
- Parameters
-
cRows the number of rows in the corner cCols the number of columns in the corner
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 93 of file DenseBase.h.
|
inline |
This is the const version of topRightCorner(Index, Index).
Definition at line 100 of file DenseBase.h.
|
inline |
- Returns
- an expression of a fixed-size top-right corner of *this.
- Template Parameters
-
CRows the number of rows in the corner CCols the number of columns in the corner
Example:
Output:
- See also
- class Block, block<int,int>(Index,Index)
Definition at line 119 of file DenseBase.h.
|
inline |
This is the const version of topRightCorner<int, int>().
Definition at line 127 of file DenseBase.h.
|
inline |
- Returns
- an expression of a top-right corner of *this.
- Template Parameters
-
CRows number of rows in corner as specified at compile-time CCols number of columns in corner as specified at compile-time
- Parameters
-
cRows number of rows in corner as specified at run-time cCols number of columns in corner as specified at run-time
This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.
Example:
Output:
- See also
- class Block
Definition at line 152 of file DenseBase.h.
|
inline |
This is the const version of topRightCorner<int, int>(Index, Index).
Definition at line 159 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the top rows of *this.
- Parameters
-
n the number of rows in the block
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 433 of file DenseBase.h.
|
inline |
This is the const version of topRows(Index).
Definition at line 440 of file DenseBase.h.
|
inline |
- Returns
- a block consisting of the top rows of *this.
- Template Parameters
-
N the number of rows in the block as specified at compile-time
- Parameters
-
n the number of rows in the block as specified at run-time
The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.
Example:
Output:
- See also
- class Block, block(Index,Index,Index,Index)
Definition at line 462 of file DenseBase.h.
|
inline |
This is the const version of topRows<int>().
Definition at line 470 of file DenseBase.h.
| EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::trace | ( | ) | const |
|
inline |
- Returns
- an expression of the transpose of *this.
Example:
Output:
- Warning
- If you want to replace a matrix by its own transpose, do NOT do this: Instead, use the transposeInPlace() method:m = m.transpose(); // bug!!! caused by aliasing effectwhich gives Eigen good opportunities for optimization, or alternatively you can also do:m.transposeInPlace();m = m.transpose().eval();
- See also
- transposeInPlace(), adjoint()
Definition at line 172 of file Transpose.h.
|
inline |
This is the const version of transpose().
Make sure you read the warning for transpose() !
- See also
- transposeInPlace(), adjoint()
Definition at line 184 of file Transpose.h.
|
inline |
This is the "in place" version of transpose(): it replaces *this by its own transpose. Thus, doing
has the same effect on m as doing
and is faster and also safer because in the latter line of code, forgetting the eval() results in a bug caused by aliasing.
Notice however that this method is only useful if you want to replace a matrix by its own transpose. If you just need the transpose of a matrix, use transpose().
- Note
- if the matrix is not square, then
*thismust be a resizable matrix. This excludes (non-square) fixed-size matrices, block-expressions and maps.
- See also
- transpose(), adjoint(), adjointInPlace()
Definition at line 284 of file Transpose.h.
|
inline |
- Returns
- the unique coefficient of a 1x1 expression
Definition at line 480 of file DenseBase.h.
| EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::visit | ( | Visitor & | visitor | ) | const |
Applies the visitor visitor to the whole coefficients of the matrix or vector.
The template parameter Visitor is the type of the visitor and provides the following interface:
- Note
- compared to one or two for loops, visitors offer automatic unrolling for small fixed size matrix.
- See also
- minCoeff(Index*,Index*), maxCoeff(Index*,Index*), DenseBase::redux()
|
static |
- Returns
- an expression of a zero matrix.
The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.
Example:
Output:
- See also
- Zero(), Zero(Index)
Definition at line 427 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a zero vector.
The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.
This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.
Example:
Output:
- See also
- Zero(), Zero(Index,Index)
Definition at line 450 of file CwiseNullaryOp.h.
|
static |
- Returns
- an expression of a fixed-size zero matrix or vector.
This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.
Example:
Output:
- See also
- Zero(Index), Zero(Index,Index)
Definition at line 467 of file CwiseNullaryOp.h.
Friends And Related Function Documentation
|
related |
Outputs the matrix, to the given stream.
If you wish to print the matrix with a format different than the default, use DenseBase::format().
It is also possible to change the default format by defining EIGEN_DEFAULT_IO_FORMAT before including Eigen headers. If not defined, this will automatically be defined to Eigen::IOFormat(), that is the Eigen::IOFormat with default parameters.
- See also
- DenseBase::format()
The documentation for this class was generated from the following files: