Eigen  3.2.93 (mercurial changeset ab755b9907bc)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > Class Template Reference

Detailed Description

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
class Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >

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:

Template Parameters
_ScalarNumeric type, e.g. float, double, int or std::complex<float>. User defined scalar types are supported as well (see here).
_RowsNumber of rows, or Dynamic
_ColsNumber of columns, or Dynamic

The remaining template parameters are optional – in most cases you don't have to worry about them.

Template Parameters
_OptionsA 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.
_MaxRowsMaximum number of rows. Defaults to _Rows (note).
_MaxColsMaximum 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:

* v[0] = 0.1;
* v[1] = 0.2;
* v(0) = 0.3;
* v(1) = 0.4;
*
* Eigen::MatrixXi m(10, 10);
* m(0, 1) = 1;
* m(0, 2) = 2;
* m(0, 3) = 3;
*

This class can be extended with the help of the plugin mechanism described on the page Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_MATRIX_PLUGIN.

Some notes:

Dense versus sparse:

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 versus dynamic-size:

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.

_MaxRows and _MaxCols:
In most cases, one just leaves these parameters to the default values. These parameters mean the maximum size of rows and columns that the matrix may have. They are useful in cases when the exact numbers of rows and columns are not known are compile-time, but it is known at compile-time that they cannot exceed a certain value. This happens when taking dynamic-size blocks inside fixed-size matrices: in this case _MaxRows and _MaxCols are the dimensions of the original matrix, while _Rows and _Cols are Dynamic.

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 typeEquivalent C structure
Matrix<T,Dynamic,Dynamic>
* struct {
* T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
* Eigen::Index rows, cols;
* };
*
* Matrix<T,Dynamic,1>
* Matrix<T,1,Dynamic>
* struct {
* T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
* };
*
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.

See Also
MatrixBase for the majority of the API methods for matrices, The class hierarchy, Storage orders
+ Inheritance diagram for Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:

Public Types

typedef PlainObjectBase< MatrixBase
 Base class typedef. More...
 
- Public Types inherited from Eigen::DenseBase< Derived >
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
 
- Public Types inherited from Eigen::EigenBase< Derived >
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...
 
Matrixoperator= (const Matrix &other)
 Assigns matrices to each other. More...
 
template<typename OtherDerived >
Matrixoperator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
- Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
const Scalarcoeff (Index rowId, Index colId) const
 
const Scalarcoeff (Index index) const
 
ScalarcoeffRef (Index rowId, Index colId)
 
ScalarcoeffRef (Index index)
 
const ScalarcoeffRef (Index rowId, Index colId) const
 
const ScalarcoeffRef (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 Scalardata () const
 
Scalardata ()
 
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)
 
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)
 
- Public Member Functions inherited from Eigen::MatrixBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
ArrayWrapper< Matrix< _Scalar,
_Rows, _Cols, _Options,
_MaxRows, _MaxCols > > 
array ()
 
const ArrayWrapper< const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > > 
array () const
 
const CwiseBinaryOp
< CustomBinaryOp, const Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
binaryExpr (const Eigen::MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
CastXpr< NewType >::Type cast () const
 
ConjugateReturnType conjugate () const
 
const CwiseAbsReturnType cwiseAbs () const
 
const CwiseAbs2ReturnType cwiseAbs2 () const
 
const CwiseScalarEqualReturnType cwiseEqual (const Scalar &s) const
 
const CwiseInverseReturnType cwiseInverse () const
 
const CwiseBinaryOp
< internal::scalar_max_op
< Scalar, Scalar >, const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
cwiseMax (const Eigen::MatrixBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_max_op
< Scalar, Scalar >, const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const ConstantReturnType > 
cwiseMax (const Scalar &other) const
 
const CwiseBinaryOp
< internal::scalar_min_op
< Scalar, Scalar >, const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
cwiseMin (const Eigen::MatrixBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_min_op
< Scalar, Scalar >, const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const ConstantReturnType > 
cwiseMin (const Scalar &other) const
 
const CwiseBinaryOp
< std::not_equal_to< Scalar >
, const Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols >, const OtherDerived > 
cwiseNotEqual (const Eigen::MatrixBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
cwiseQuotient (const Eigen::MatrixBase< OtherDerived > &other) const
 
const CwiseSignReturnType cwiseSign () const
 
const CwiseSqrtReturnType cwiseSqrt () const
 
Index diagonalSize () const
 
const ImagReturnType imag () const
 
NonConstImagReturnType imag ()
 
bool operator!= (const MatrixBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< internal::scalar_product_op
< Scalar, T >, Matrix< _Scalar,
_Rows, _Cols, _Options,
_MaxRows, _MaxCols >, Constant
< T > > 
operator* (const T &scalar) const
 
const CwiseBinaryOp< sum
< Scalar >, const Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
operator+ (const Eigen::MatrixBase< OtherDerived > &other) const
 
const CwiseBinaryOp
< difference< Scalar >, const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, const OtherDerived > 
operator- (const Eigen::MatrixBase< OtherDerived > &other) const
 
const NegativeReturnType operator- () const
 
const CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar, T >, Matrix< _Scalar,
_Rows, _Cols, _Options,
_MaxRows, _MaxCols >, Constant
< T > > 
operator/ (const T &scalar) const
 
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
operator= (const MatrixBase &other)
 
bool operator== (const MatrixBase< OtherDerived > &other) const
 
RealReturnType real () const
 
NonConstRealReturnType real ()
 
const CwiseUnaryOp
< CustomUnaryOp, const Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > > 
unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
const CwiseUnaryView
< CustomViewOp, const Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > > 
unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
 
- Public Member Functions inherited from Eigen::DenseBase< Derived >
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
 
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
 
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
 
BlockXpr bottomLeftCorner (Index cRows, Index cCols)
 
const ConstBlockXpr bottomLeftCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomLeftCorner () const
 
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
 
BlockXpr bottomRightCorner (Index cRows, Index cCols)
 
const ConstBlockXpr bottomRightCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type bottomRightCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
bottomRightCorner () const
 
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
 
RowsBlockXpr bottomRows (Index n)
 
ConstRowsBlockXpr bottomRows (Index n) const
 
template<int N>
NRowsBlockXpr< N >::Type bottomRows (Index n=N)
 
template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows (Index n=N) const
 
ColXpr col (Index i)
 
ConstColXpr col (Index i) const
 
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
 
template<int N>
FixedSegmentReturnType< N >::Type head (Index n=N)
 
template<int N>
ConstFixedSegmentReturnType< N >
::Type 
head (Index n=N) const
 
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
 
template<typename OtherDerived >
Derived & lazyAssign (const DenseBase< OtherDerived > &other)
 
ColsBlockXpr leftCols (Index n)
 
ConstColsBlockXpr leftCols (Index n) const
 
template<int N>
NColsBlockXpr< N >::Type leftCols (Index n=N)
 
template<int N>
ConstNColsBlockXpr< N >::Type leftCols (Index n=N) const
 
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
 
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
 
RowsBlockXpr middleRows (Index startRow, Index n)
 
ConstRowsBlockXpr middleRows (Index startRow, Index n) const
 
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
 
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
 
template<int N>
NColsBlockXpr< N >::Type rightCols (Index n=N)
 
template<int N>
ConstNColsBlockXpr< N >::Type rightCols (Index n=N) const
 
RowXpr row (Index i)
 
ConstRowXpr row (Index i) const
 
ConstRowwiseReturnType rowwise () const
 
RowwiseReturnType rowwise ()
 
SegmentReturnType segment (Index start, Index n)
 
ConstSegmentReturnType segment (Index start, Index n) const
 
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
 
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
 
template<int N>
FixedSegmentReturnType< N >::Type tail (Index n=N)
 
template<int N>
ConstFixedSegmentReturnType< N >
::Type 
tail (Index n=N) const
 
BlockXpr topLeftCorner (Index cRows, Index cCols)
 
const ConstBlockXpr topLeftCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topLeftCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topLeftCorner () const
 
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
 
BlockXpr topRightCorner (Index cRows, Index cCols)
 
const ConstBlockXpr topRightCorner (Index cRows, Index cCols) const
 
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type topRightCorner ()
 
template<int CRows, int CCols>
const ConstFixedBlockXpr
< CRows, CCols >::Type 
topRightCorner () const
 
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
 
RowsBlockXpr topRows (Index n)
 
ConstRowsBlockXpr topRows (Index n) const
 
template<int N>
NRowsBlockXpr< N >::Type topRows (Index n=N)
 
template<int N>
ConstNRowsBlockXpr< N >::Type topRows (Index n=N) const
 
TransposeReturnType transpose ()
 
ConstTransposeReturnType transpose () const
 
void transposeInPlace ()
 
CoeffReturnType value () const
 
template<typename Visitor >
void visit (Visitor &func) const
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >
Index colStride () const
 
Index innerStride () const
 
Index outerStride () const
 
Index rowStride () const
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
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 ()
 
- Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
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
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
Index cols () const
 
Derived & derived ()
 
const Derived & derived () const
 
Index rows () const
 
Index size () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
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 Public Member Functions inherited from Eigen::DenseBase< Derived >
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)
 Sets a linearly spaced vector. More...
 
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)
 Sets a linearly spaced vector. More...
 
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 ()
 
- Protected Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
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.
 
- Protected Member Functions inherited from Eigen::DenseBase< Derived >
 DenseBase ()
 

Member Typedef Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
typedef PlainObjectBase<Matrix> Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Base

Base class typedef.

See Also
PlainObjectBase

Constructor & Destructor Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( )
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.

See Also
resize(Index,Index)
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( Index  dim)
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.

Warning
This constructor is disabled for fixed-size 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).
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
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.

Warning
This constructor is disabled for fixed-size 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).
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const EigenBase< OtherDerived > &  other)
inline

Copy constructor for generic expressions.

See Also
MatrixBase::operator=(const EigenBase<OtherDerived>&)
template<typename _Scalar , int _Rows, int _Cols, int _Storage, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
Eigen::Matrix< _Scalar, _Rows, _Cols, _Storage, _MaxRows, _MaxCols >::Matrix ( const RotationBase< OtherDerived, ColsAtCompileTime > &  r)
explicit

Constructs a Dim x Dim rotation matrix from the rotation r.

This is defined in the Geometry module.

#include <Eigen/Geometry>

Member Function Documentation

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
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.

#include <Eigen/Geometry>
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Matrix& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &  other)
inline

Assigns matrices to each other.

Note
This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename OtherDerived >
Matrix& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const EigenBase< OtherDerived > &  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

Returns
a reference to *this.

The documentation for this class was generated from the following files: