![]() |
Eigen
3.3.4
|
The matrix class, also used for vectors and row-vectors.
The Matrix class is the work-horse for all dense (note) matrices and vectors within Eigen. Vectors are matrices with one column, and row-vectors are matrices with one row.
The Matrix class encompasses both fixed-size and dynamic-size objects (note).
The first three template parameters are required:
_Scalar | Numeric type, e.g. float, double, int or std::complex<float>. User defined scalar types are supported as well (see here). |
_Rows | Number of rows, or Dynamic |
_Cols | Number of columns, or Dynamic |
The remaining template parameters are optional – in most cases you don't have to worry about them.
_Options | A combination of either RowMajor or ColMajor, and of either AutoAlign or DontAlign. The former controls storage order, and defaults to column-major. The latter controls alignment, which is required for vectorization. It defaults to aligning matrices except for fixed sizes that aren't a multiple of the packet size. |
_MaxRows | Maximum number of rows. Defaults to _Rows (note). |
_MaxCols | Maximum number of columns. Defaults to _Cols (note). |
Eigen provides a number of typedefs covering the usual cases. Here are some examples:
Matrix2d
is a 2x2 square matrix of doubles (Matrix<double, 2, 2>
) Vector4f
is a vector of 4 floats (Matrix<float, 4, 1>
) RowVector3i
is a row-vector of 3 ints (Matrix<int, 1, 3>
)MatrixXf
is a dynamic-size matrix of floats (Matrix<float, Dynamic, Dynamic>
) VectorXf
is a dynamic-size vector of floats (Matrix<float, Dynamic, 1>
)Matrix2Xf
is a partially fixed-size (dynamic-size) matrix of floats (Matrix<float, 2, Dynamic>
) MatrixX3d
is a partially dynamic-size (fixed-size) matrix of double (Matrix<double, Dynamic, 3>
)See this page for a complete list of predefined Matrix and Vector typedefs.
You can access elements of vectors and matrices using normal subscripting:
This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_MATRIX_PLUGIN
.
Some notes:
This Matrix class handles dense, not sparse matrices and vectors. For sparse matrices and vectors, see the Sparse module.
Dense matrices and vectors are plain usual arrays of coefficients. All the coefficients are stored, in an ordinary contiguous array. This is unlike Sparse matrices and vectors where the coefficients are stored as a list of nonzero coefficients.
Fixed-size means that the numbers of rows and columns are known are compile-time. In this case, Eigen allocates the array of coefficients as a fixed-size array, as a class member. This makes sense for very small matrices, typically up to 4x4, sometimes up to 16x16. Larger matrices should be declared as dynamic-size even if one happens to know their size at compile-time.
Dynamic-size means that the numbers of rows or columns are not necessarily known at compile-time. In this case they are runtime variables, and the array of coefficients is allocated dynamically on the heap.
Note that dense matrices, be they Fixed-size or Dynamic-size, do not expand dynamically in the sense of a std::map. If you want this behavior, see the Sparse module.
ABI and storage layout
The table below summarizes the ABI of some possible Matrix instances which is fixed thorough the lifetime of Eigen 3.
Matrix type | Equivalent C structure |
---|---|
Matrix<T,Dynamic,Dynamic> | |
Matrix<T,Dynamic,1> Matrix<T,1,Dynamic> | |
Matrix<T,Rows,Cols> | struct { T data[Rows*Cols]; // with (size_t(data)%A(Rows*Cols*sizeof(T)))==0 }; |
Matrix<T,Dynamic,Dynamic,0,MaxRows,MaxCols> | struct { T data[MaxRows*MaxCols]; // with (size_t(data)%A(MaxRows*MaxCols*sizeof(T)))==0 Eigen::Index rows, cols; }; |
Note that in this table Rows, Cols, MaxRows and MaxCols are all positive integers. A(S) is defined to the largest possible power-of-two smaller to EIGEN_MAX_STATIC_ALIGN_BYTES.
Public Types | |
typedef PlainObjectBase< Matrix > | Base |
Base class typedef. More... | |
![]() | |
enum | { RowsAtCompileTime, ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime, MaxColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime, Flags, IsRowMajor } |
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 > | PlainArray |
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 > | PlainMatrix |
typedef internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type | PlainObject |
The plain matrix or array type corresponding to this expression. More... | |
typedef internal::traits< Derived >::Scalar | Scalar |
typedef internal::traits< Derived >::StorageIndex | StorageIndex |
The type used to store indices. More... | |
typedef Scalar | value_type |
![]() | |
typedef Eigen::Index | Index |
The interface type of indices. More... | |
Public Member Functions | |
Matrix () | |
Default constructor. More... | |
Matrix (const Scalar *data) | |
Constructs a fixed-sized matrix initialized with coefficients starting at data. | |
Matrix (Index dim) | |
Constructs a vector or row-vector with given dimension. This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column. More... | |
Matrix (const Scalar &x) | |
Constructs an initialized 1x1 matrix with the given coefficient. | |
Matrix (Index rows, Index cols) | |
Constructs an uninitialized matrix with rows rows and cols columns. More... | |
Matrix (const Scalar &x, const Scalar &y) | |
Constructs an initialized 2D vector with given coefficients. | |
Matrix (const Scalar &x, const Scalar &y, const Scalar &z) | |
Constructs an initialized 3D vector with given coefficients. | |
Matrix (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w) | |
Constructs an initialized 4D vector with given coefficients. | |
Matrix (const Matrix &other) | |
Copy constructor. | |
template<typename OtherDerived > | |
Matrix (const EigenBase< OtherDerived > &other) | |
Copy constructor for generic expressions. More... | |
template<typename OtherDerived > | |
Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r) | |
Constructs a Dim x Dim rotation matrix from the rotation r. More... | |
template<typename OtherDerived > | |
Matrix< _Scalar, _Rows, _Cols, _Storage, _MaxRows, _MaxCols > & | operator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r) |
Set a Dim x Dim rotation matrix from the rotation r. More... | |
Matrix & | operator= (const Matrix &other) |
Assigns matrices to each other. More... | |
template<typename OtherDerived > | |
Matrix & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
![]() | |
const Scalar & | coeff (Index rowId, Index colId) const |
const Scalar & | coeff (Index index) const |
Scalar & | coeffRef (Index rowId, Index colId) |
Scalar & | coeffRef (Index index) |
const Scalar & | coeffRef (Index rowId, Index colId) const |
const Scalar & | coeffRef (Index index) const |
void | conservativeResize (Index rows, Index cols) |
void | conservativeResize (Index rows, NoChange_t) |
void | conservativeResize (NoChange_t, Index cols) |
void | conservativeResize (Index size) |
void | conservativeResizeLike (const DenseBase< OtherDerived > &other) |
const Scalar * | data () const |
Scalar * | data () |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | lazyAssign (const DenseBase< OtherDerived > &other) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | operator= (const PlainObjectBase &other) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
void | resize (Index rows, Index cols) |
void | resize (Index size) |
void | resize (NoChange_t, Index cols) |
void | resize (Index rows, NoChange_t) |
void | resizeLike (const EigenBase< OtherDerived > &_other) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (Index size, const Scalar &val) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setConstant (Index rows, Index cols, const Scalar &val) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (Index size) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setOnes (Index rows, Index cols) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (Index size) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setRandom (Index rows, Index cols) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (Index size) |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | setZero (Index rows, Index cols) |
![]() | |
const AdjointReturnType | adjoint () const |
void | adjointInPlace () |
template<typename EssentialPart > | |
void | applyHouseholderOnTheLeft (const EssentialPart &essential, const Scalar &tau, Scalar *workspace) |
template<typename EssentialPart > | |
void | applyHouseholderOnTheRight (const EssentialPart &essential, const Scalar &tau, Scalar *workspace) |
template<typename OtherDerived > | |
void | applyOnTheLeft (const EigenBase< OtherDerived > &other) |
template<typename OtherScalar > | |
void | applyOnTheLeft (Index p, Index q, const JacobiRotation< OtherScalar > &j) |
template<typename OtherDerived > | |
void | applyOnTheRight (const EigenBase< OtherDerived > &other) |
template<typename OtherScalar > | |
void | applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j) |
ArrayWrapper< Derived > | array () |
const ArrayWrapper< const Derived > | array () const |
const DiagonalWrapper< const Derived > | asDiagonal () const |
BDCSVD< PlainObject > | bdcSvd (unsigned int computationOptions=0) const |
template<typename CustomBinaryOp , typename OtherDerived > | |
const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived > | binaryExpr (const Eigen::MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const |
RealScalar | blueNorm () const |
template<typename NewType > | |
CastXpr< NewType >::Type | cast () const |
const ColPivHouseholderQR< PlainObject > | colPivHouseholderQr () const |
const CompleteOrthogonalDecomposition< PlainObject > | completeOrthogonalDecomposition () const |
template<typename ResultType > | |
void | computeInverseAndDetWithCheck (ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const |
template<typename ResultType > | |
void | computeInverseWithCheck (ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const |
ConjugateReturnType | conjugate () const |
template<typename OtherDerived > | |
PlainObject | cross (const MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
PlainObject | cross3 (const MatrixBase< OtherDerived > &other) const |
const CwiseAbsReturnType | cwiseAbs () const |
const CwiseAbs2ReturnType | cwiseAbs2 () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived > | cwiseEqual (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseScalarEqualReturnType | cwiseEqual (const Scalar &s) const |
const CwiseInverseReturnType | cwiseInverse () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const OtherDerived > | cwiseMax (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const ConstantReturnType > | cwiseMax (const Scalar &other) const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const OtherDerived > | cwiseMin (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const ConstantReturnType > | cwiseMin (const Scalar &other) const |
template<typename OtherDerived > | |
const CwiseBinaryOp< std::not_equal_to< Scalar >, const Derived, const OtherDerived > | cwiseNotEqual (const Eigen::MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived > | cwiseProduct (const Eigen::MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived > | cwiseQuotient (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseSignReturnType | cwiseSign () const |
const CwiseSqrtReturnType | cwiseSqrt () const |
Scalar | determinant () const |
DiagonalReturnType | diagonal () |
ConstDiagonalReturnType | diagonal () const |
DiagonalDynamicIndexReturnType | diagonal (Index index) |
ConstDiagonalDynamicIndexReturnType | diagonal (Index index) const |
Index | diagonalSize () const |
template<typename OtherDerived > | |
ScalarBinaryOpTraits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType | dot (const MatrixBase< OtherDerived > &other) const |
EigenvaluesReturnType | eigenvalues () const |
Computes the eigenvalues of a matrix. More... | |
Matrix< Scalar, 3, 1 > | eulerAngles (Index a0, Index a1, Index a2) const |
const Derived & | forceAlignedAccess () const |
Derived & | forceAlignedAccess () |
template<bool Enable> | |
internal::add_const_on_value_type< typename internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type >::type | forceAlignedAccessIf () const |
template<bool Enable> | |
internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type | forceAlignedAccessIf () |
const FullPivHouseholderQR< PlainObject > | fullPivHouseholderQr () const |
const FullPivLU< PlainObject > | fullPivLu () const |
const HNormalizedReturnType | hnormalized () const |
homogeneous normalization More... | |
HomogeneousReturnType | homogeneous () const |
const HouseholderQR< PlainObject > | householderQr () const |
RealScalar | hypotNorm () const |
const ImagReturnType | imag () const |
NonConstImagReturnType | imag () |
const Inverse< Derived > | inverse () const |
bool | isDiagonal (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isIdentity (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isLowerTriangular (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<typename OtherDerived > | |
bool | isOrthogonal (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isUnitary (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isUpperTriangular (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
JacobiSVD< PlainObject > | jacobiSvd (unsigned int computationOptions=0) const |
template<typename OtherDerived > | |
const Product< Derived, OtherDerived, LazyProduct > | lazyProduct (const MatrixBase< OtherDerived > &other) const |
const LDLT< PlainObject > | ldlt () const |
const LLT< PlainObject > | llt () const |
template<int p> | |
RealScalar | lpNorm () const |
const PartialPivLU< PlainObject > | lu () const |
template<typename EssentialPart > | |
void | makeHouseholder (EssentialPart &essential, Scalar &tau, RealScalar &beta) const |
void | makeHouseholderInPlace (Scalar &tau, RealScalar &beta) |
NoAlias< Derived, Eigen::MatrixBase > | noalias () |
RealScalar | norm () const |
void | normalize () |
const PlainObject | normalized () const |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_boolean_and_op, const Derived, const OtherDerived > | operator && (const Eigen::MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
bool | operator!= (const MatrixBase< OtherDerived > &other) const |
template<typename T > | |
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, Derived, Constant< T > > | operator* (const T &scalar) const |
template<typename OtherDerived > | |
const Product< Derived, OtherDerived > | operator* (const MatrixBase< OtherDerived > &other) const |
template<typename DiagonalDerived > | |
const Product< Derived, DiagonalDerived, LazyProduct > | operator* (const DiagonalBase< DiagonalDerived > &diagonal) const |
template<typename OtherDerived > | |
Derived & | operator*= (const EigenBase< OtherDerived > &other) |
template<typename OtherDerived > | |
const CwiseBinaryOp< sum< Scalar >, const Derived, const OtherDerived > | operator+ (const Eigen::MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
Derived & | operator+= (const MatrixBase< OtherDerived > &other) |
template<typename OtherDerived > | |
const CwiseBinaryOp< difference< Scalar >, const Derived, const OtherDerived > | operator- (const Eigen::MatrixBase< OtherDerived > &other) const |
const NegativeReturnType | operator- () const |
template<typename OtherDerived > | |
Derived & | operator-= (const MatrixBase< OtherDerived > &other) |
template<typename T > | |
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, T >, Derived, Constant< T > > | operator/ (const T &scalar) const |
Derived & | operator= (const MatrixBase &other) |
template<typename OtherDerived > | |
bool | operator== (const MatrixBase< OtherDerived > &other) const |
RealScalar | operatorNorm () const |
Computes the L2 operator norm. More... | |
template<typename OtherDerived > | |
const CwiseBinaryOp< internal::scalar_boolean_or_op, const Derived, const OtherDerived > | operator|| (const Eigen::MatrixBase< OtherDerived > &other) const |
const PartialPivLU< PlainObject > | partialPivLu () const |
RealReturnType | real () const |
NonConstRealReturnType | real () |
template<unsigned int UpLo> | |
MatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type | selfadjointView () const |
template<unsigned int UpLo> | |
MatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type | selfadjointView () |
Derived & | setIdentity () |
Derived & | setIdentity (Index rows, Index cols) |
Resizes to the given size, and writes the identity expression (not necessarily square) into *this. More... | |
const SparseView< Derived > | sparseView (const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const |
RealScalar | squaredNorm () const |
RealScalar | stableNorm () const |
void | stableNormalize () |
const PlainObject | stableNormalized () const |
Scalar | trace () const |
template<unsigned int Mode> | |
MatrixBase< Derived >::template TriangularViewReturnType< Mode >::Type | triangularView () |
template<unsigned int Mode> | |
MatrixBase< Derived >::template ConstTriangularViewReturnType< Mode >::Type | triangularView () const |
template<typename CustomUnaryOp > | |
const CwiseUnaryOp< CustomUnaryOp, const Derived > | unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const |
Apply a unary operator coefficient-wise. More... | |
template<typename CustomViewOp > | |
const CwiseUnaryView< CustomViewOp, const Derived > | unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const |
PlainObject | unitOrthogonal (void) const |
![]() | |
bool | all () const |
bool | allFinite () const |
bool | any () const |
BlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
const ConstBlockXpr | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
This is the const version of block(Index,Index,Index,Index). */. | |
template<int NRows, int NCols> | |
FixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol) |
template<int NRows, int NCols> | |
const ConstFixedBlockXpr< NRows, NCols >::Type | block (Index startRow, Index startCol) const |
This is the const version of block<>(Index, Index). */. | |
template<int NRows, int NCols> | |
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). | |
BlockXpr | bottomLeftCorner (Index cRows, Index cCols) |
const ConstBlockXpr | bottomLeftCorner (Index cRows, Index cCols) const |
This is the const version of bottomLeftCorner(Index, Index). | |
template<int CRows, int CCols> | |
FixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner () |
template<int CRows, int CCols> | |
const ConstFixedBlockXpr< CRows, CCols >::Type | bottomLeftCorner () const |
This is the const version of bottomLeftCorner<int, int>(). | |
template<int CRows, int CCols> | |
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). | |
BlockXpr | bottomRightCorner (Index cRows, Index cCols) |
const ConstBlockXpr | bottomRightCorner (Index cRows, Index cCols) const |
This is the const version of bottomRightCorner(Index, Index). | |
template<int CRows, int CCols> | |
FixedBlockXpr< CRows, CCols >::Type | bottomRightCorner () |
template<int CRows, int CCols> | |
const ConstFixedBlockXpr< CRows, CCols >::Type | bottomRightCorner () const |
This is the const version of bottomRightCorner<int, int>(). | |
template<int CRows, int CCols> | |
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). | |
RowsBlockXpr | bottomRows (Index n) |
ConstRowsBlockXpr | bottomRows (Index n) const |
This is the const version of bottomRows(Index). | |
template<int N> | |
NRowsBlockXpr< N >::Type | bottomRows (Index n=N) |
template<int N> | |
ConstNRowsBlockXpr< N >::Type | bottomRows (Index n=N) const |
This is the const version of bottomRows<int>(). | |
ColXpr | col (Index i) |
ConstColXpr | col (Index i) const |
This is the const version of col(). | |
ConstColwiseReturnType | colwise () const |
ColwiseReturnType | colwise () |
Index | count () const |
EvalReturnType | eval () const |
void | fill (const Scalar &value) |
template<unsigned int Added, unsigned int Removed> | |
EIGEN_DEPRECATED const Derived & | flagged () const |
const WithFormat< Derived > | format (const IOFormat &fmt) const |
bool | hasNaN () const |
SegmentReturnType | head (Index n) |
ConstSegmentReturnType | head (Index n) const |
This is the const version of head(Index). | |
template<int N> | |
FixedSegmentReturnType< N >::Type | head (Index n=N) |
template<int N> | |
ConstFixedSegmentReturnType< N >::Type | head (Index n=N) const |
This is the const version of head<int>(). | |
Index | innerSize () const |
template<typename OtherDerived > | |
bool | isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
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=NumTraits< Scalar >::dummy_precision()) const |
bool | isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
ColsBlockXpr | leftCols (Index n) |
ConstColsBlockXpr | leftCols (Index n) const |
This is the const version of leftCols(Index). | |
template<int N> | |
NColsBlockXpr< N >::Type | leftCols (Index n=N) |
template<int N> | |
ConstNColsBlockXpr< N >::Type | leftCols (Index n=N) const |
This is the const version of leftCols<int>(). | |
internal::traits< Derived >::Scalar | maxCoeff () const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *index) const |
Scalar | mean () const |
ColsBlockXpr | middleCols (Index startCol, Index numCols) |
ConstColsBlockXpr | middleCols (Index startCol, Index numCols) const |
This is the const version of middleCols(Index,Index). | |
template<int N> | |
NColsBlockXpr< N >::Type | middleCols (Index startCol, Index n=N) |
template<int N> | |
ConstNColsBlockXpr< N >::Type | middleCols (Index startCol, Index n=N) const |
This is the const version of middleCols<int>(). | |
RowsBlockXpr | middleRows (Index startRow, Index n) |
ConstRowsBlockXpr | middleRows (Index startRow, Index n) const |
This is the const version of middleRows(Index,Index). | |
template<int N> | |
NRowsBlockXpr< N >::Type | middleRows (Index startRow, Index n=N) |
template<int N> | |
ConstNRowsBlockXpr< N >::Type | middleRows (Index startRow, Index n=N) const |
This is the const version of middleRows<int>(). | |
internal::traits< Derived >::Scalar | minCoeff () const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *index) const |
const NestByValue< Derived > | nestByValue () const |
Index | nonZeros () const |
template<typename CustomNullaryOp > | |
const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (Index size, const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > | NullaryExpr (const CustomNullaryOp &func) |
CommaInitializer< Derived > | operator<< (const Scalar &s) |
template<typename OtherDerived > | |
CommaInitializer< Derived > | operator<< (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator= (const DenseBase< OtherDerived > &other) |
Derived & | operator= (const DenseBase &other) |
template<typename OtherDerived > | |
Derived & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
Index | outerSize () const |
Scalar | prod () const |
template<typename Func > | |
internal::traits< Derived >::Scalar | redux (const Func &func) const |
template<int RowFactor, int ColFactor> | |
const Replicate< Derived, RowFactor, ColFactor > | replicate () const |
const Replicate< Derived, Dynamic, Dynamic > | replicate (Index rowFactor, Index colFactor) const |
void | resize (Index newSize) |
void | resize (Index rows, Index cols) |
ReverseReturnType | reverse () |
ConstReverseReturnType | reverse () const |
void | reverseInPlace () |
ColsBlockXpr | rightCols (Index n) |
ConstColsBlockXpr | rightCols (Index n) const |
This is the const version of rightCols(Index). | |
template<int N> | |
NColsBlockXpr< N >::Type | rightCols (Index n=N) |
template<int N> | |
ConstNColsBlockXpr< N >::Type | rightCols (Index n=N) const |
This is the const version of rightCols<int>(). | |
RowXpr | row (Index i) |
ConstRowXpr | row (Index i) const |
This is the const version of row(). */. | |
ConstRowwiseReturnType | rowwise () const |
RowwiseReturnType | rowwise () |
SegmentReturnType | segment (Index start, Index n) |
ConstSegmentReturnType | segment (Index start, Index n) const |
This is the const version of segment(Index,Index). | |
template<int N> | |
FixedSegmentReturnType< N >::Type | segment (Index start, Index n=N) |
template<int N> | |
ConstFixedSegmentReturnType< N >::Type | segment (Index start, Index n=N) const |
This is the const version of segment<int>(Index). | |
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 |
Derived & | setConstant (const Scalar &value) |
Derived & | setLinSpaced (Index size, const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
Derived & | setLinSpaced (const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
Derived & | setOnes () |
Derived & | setRandom () |
Derived & | setZero () |
Scalar | sum () const |
template<typename OtherDerived > | |
void | swap (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
void | swap (PlainObjectBase< OtherDerived > &other) |
SegmentReturnType | tail (Index n) |
ConstSegmentReturnType | tail (Index n) const |
This is the const version of tail(Index). | |
template<int N> | |
FixedSegmentReturnType< N >::Type | tail (Index n=N) |
template<int N> | |
ConstFixedSegmentReturnType< N >::Type | tail (Index n=N) const |
This is the const version of tail<int>. | |
BlockXpr | topLeftCorner (Index cRows, Index cCols) |
const ConstBlockXpr | topLeftCorner (Index cRows, Index cCols) const |
This is the const version of topLeftCorner(Index, Index). | |
template<int CRows, int CCols> | |
FixedBlockXpr< CRows, CCols >::Type | topLeftCorner () |
template<int CRows, int CCols> | |
const ConstFixedBlockXpr< CRows, CCols >::Type | topLeftCorner () const |
This is the const version of topLeftCorner<int, int>(). | |
template<int CRows, int CCols> | |
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). | |
BlockXpr | topRightCorner (Index cRows, Index cCols) |
const ConstBlockXpr | topRightCorner (Index cRows, Index cCols) const |
This is the const version of topRightCorner(Index, Index). | |
template<int CRows, int CCols> | |
FixedBlockXpr< CRows, CCols >::Type | topRightCorner () |
template<int CRows, int CCols> | |
const ConstFixedBlockXpr< CRows, CCols >::Type | topRightCorner () const |
This is the const version of topRightCorner<int, int>(). | |
template<int CRows, int CCols> | |
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). | |
RowsBlockXpr | topRows (Index n) |
ConstRowsBlockXpr | topRows (Index n) const |
This is the const version of topRows(Index). | |
template<int N> | |
NRowsBlockXpr< N >::Type | topRows (Index n=N) |
template<int N> | |
ConstNRowsBlockXpr< N >::Type | topRows (Index n=N) const |
This is the const version of topRows<int>(). | |
TransposeReturnType | transpose () |
ConstTransposeReturnType | transpose () const |
void | transposeInPlace () |
CoeffReturnType | value () const |
template<typename Visitor > | |
void | visit (Visitor &func) const |
![]() | |
Index | colStride () const |
Index | innerStride () const |
Index | outerStride () const |
Index | rowStride () const |
![]() | |
Scalar & | coeffRef (Index row, Index col) |
Scalar & | coeffRef (Index index) |
Scalar & | operator() (Index row, Index col) |
Scalar & | operator() (Index index) |
Scalar & | operator[] (Index index) |
Scalar & | w () |
Scalar & | x () |
Scalar & | y () |
Scalar & | z () |
![]() | |
CoeffReturnType | coeff (Index row, Index col) const |
CoeffReturnType | coeff (Index index) const |
CoeffReturnType | operator() (Index row, Index col) const |
CoeffReturnType | operator() (Index index) const |
CoeffReturnType | operator[] (Index index) const |
CoeffReturnType | w () const |
CoeffReturnType | x () const |
CoeffReturnType | y () const |
CoeffReturnType | z () const |
![]() | |
Index | cols () const |
Derived & | derived () |
const Derived & | derived () const |
Index | rows () const |
Index | size () const |
Additional Inherited Members | |
![]() | |
static ConstMapType | Map (const Scalar *data) |
static MapType | Map (Scalar *data) |
static ConstMapType | Map (const Scalar *data, Index size) |
static MapType | Map (Scalar *data, Index size) |
static ConstMapType | Map (const Scalar *data, Index rows, Index cols) |
static MapType | Map (Scalar *data, Index rows, Index cols) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedConstMapType< Stride< Outer, Inner > >::type | Map (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static StridedMapType< Stride< Outer, Inner > >::type | Map (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static ConstAlignedMapType | MapAligned (const Scalar *data) |
static AlignedMapType | MapAligned (Scalar *data) |
static ConstAlignedMapType | MapAligned (const Scalar *data, Index size) |
static AlignedMapType | MapAligned (Scalar *data, Index size) |
static ConstAlignedMapType | MapAligned (const Scalar *data, Index rows, Index cols) |
static AlignedMapType | MapAligned (Scalar *data, Index rows, Index cols) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, const Stride< Outer, Inner > &stride) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, Index size, const Stride< Outer, Inner > &stride) |
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
static StridedAlignedMapType< Stride< Outer, Inner > >::type | MapAligned (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride) |
![]() | |
static const IdentityReturnType | Identity () |
static const IdentityReturnType | Identity (Index rows, Index cols) |
static const BasisReturnType | Unit (Index size, Index i) |
static const BasisReturnType | Unit (Index i) |
static const BasisReturnType | UnitW () |
static const BasisReturnType | UnitX () |
static const BasisReturnType | UnitY () |
static const BasisReturnType | UnitZ () |
![]() | |
static const ConstantReturnType | Constant (Index rows, Index cols, const Scalar &value) |
static const ConstantReturnType | Constant (Index size, const Scalar &value) |
static const ConstantReturnType | Constant (const Scalar &value) |
static const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high) |
static const RandomAccessLinSpacedReturnType | LinSpaced (Index size, const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
static const SequentialLinSpacedReturnType | LinSpaced (Sequential_t, const Scalar &low, const Scalar &high) |
static const RandomAccessLinSpacedReturnType | LinSpaced (const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
static const ConstantReturnType | Ones (Index rows, Index cols) |
static const ConstantReturnType | Ones (Index size) |
static const ConstantReturnType | Ones () |
static const RandomReturnType | Random (Index rows, Index cols) |
static const RandomReturnType | Random (Index size) |
static const RandomReturnType | Random () |
static const ConstantReturnType | Zero (Index rows, Index cols) |
static const ConstantReturnType | Zero (Index size) |
static const ConstantReturnType | Zero () |
![]() | |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | _set (const DenseBase< OtherDerived > &other) |
Copies the value of the expression other into *this with automatic resizing. More... | |
PlainObjectBase (const PlainObjectBase &other) | |
PlainObjectBase (const DenseBase< OtherDerived > &other) | |
PlainObjectBase (const EigenBase< OtherDerived > &other) | |
PlainObjectBase (const ReturnByValue< OtherDerived > &other) | |
Copy constructor with in-place evaluation. | |
![]() | |
DenseBase () | |
![]() | |
template<typename Derived > | |
std::ostream & | operator<< (std::ostream &s, const DenseBase< Derived > &m) |
typedef PlainObjectBase<Matrix> Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Base |
Base class typedef.
|
inline |
Default constructor.
For fixed-size matrices, does nothing.
For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix is called a null matrix. This constructor is the unique way to create null matrices: resizing a matrix to 0 is not supported.
|
inlineexplicit |
Constructs a vector or row-vector with given dimension. This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.
This is useful for dynamic-size vectors. For fixed-size vectors, it is redundant to pass these parameters, so one should use the default constructor Matrix() instead.
1x1
matrices. For instance, calling Matrix<double,1,1>(1) will call the initialization constructor: Matrix(const Scalar&). For fixed-size 1x1
matrices it is therefore recommended to use the default constructor Matrix() instead, especially when using one of the non standard EIGEN_INITIALIZE_MATRICES_BY_{ZERO
,NAN}
macros (see Preprocessor directives). Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix | ( | Index | rows, |
Index | cols | ||
) |
Constructs an uninitialized matrix with rows rows and cols columns.
This is useful for dynamic-size matrices. For fixed-size matrices, it is redundant to pass these parameters, so one should use the default constructor Matrix() instead.
1x2
and 2x1
vectors. For instance, calling Matrix2f(2,1) will call the initialization constructor: Matrix(const Scalar& x, const Scalar& y). For fixed-size 1x2
or 2x1
vectors it is therefore recommended to use the default constructor Matrix() instead, especially when using one of the non standard EIGEN_INITIALIZE_MATRICES_BY_{ZERO
,NAN}
macros (see Preprocessor directives).
|
inline |
Copy constructor for generic expressions.
|
explicit |
Constructs a Dim x Dim rotation matrix from the rotation r.
This is defined in the Geometry module.
Matrix<_Scalar, _Rows, _Cols, _Storage, _MaxRows, _MaxCols>& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= | ( | const RotationBase< OtherDerived, ColsAtCompileTime > & | r | ) |
Set a Dim x Dim rotation matrix from the rotation r.
This is defined in the Geometry module.
|
inline |
Assigns matrices to each other.
|
inline |
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