Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > Class Template Reference

The matrix class, also used for vectors and row-vectors. More...

#include <Matrix.h>

Inheritance diagram for Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:

Public Types
enum	{ Options = _Options }
typedef PlainObjectBase< Matrix >	Base
	Base class typedef. More...
typedef Base::PlainObject	PlainObject
Public Types inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
enum
enum
typedef Eigen::Map< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	AlignedMapType
typedef internal::dense_xpr_base< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::type	Base
typedef Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >	DenseType
typedef Eigen::Map< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	MapType
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar	Scalar
typedef internal::traits< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::StorageKind	StorageKind
enum

Public Member Functions
EIGEN_DEVICE_FUNC Base &	base ()
const EIGEN_DEVICE_FUNC Base &	base () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix ()
	Default constructor. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const EigenBase< OtherDerived > &other)
	Copy constructor for generic expressions. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const Matrix &other)
	Copy constructor. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC	Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
	Constructs a Dim x Dim rotation matrix from the rotation r. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const Scalar &x, const Scalar &y, const Scalar &z)
	Constructs an initialized 3D vector with given coefficients. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w)
	Constructs an initialized 4D vector with given coefficients. More...
template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const T &x)
template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (const T0 &x, const T1 &y)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Matrix (internal::constructor_without_unaligned_array_assert)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix &	operator= (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix &	operator= (const Matrix &other)
	Assigns matrices to each other. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix &	operator= (const ReturnByValue< OtherDerived > &func)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC 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...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Matrix &	operator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC Base &	base ()
const EIGEN_DEVICE_FUNC Base &	base () const
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index index) const
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, Index cols)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, NoChange_t)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index size)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (NoChange_t, Index cols)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResizeLike (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar *	data ()
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar *	data () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	lazyAssign (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const PlainObjectBase &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_STRONG_INLINE PacketScalar	packet (Index index) const
EIGEN_STRONG_INLINE PacketScalar	packet (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resize (Index rows, Index cols)
EIGEN_DEVICE_FUNC void	resize (Index rows, NoChange_t)
EIGEN_DEVICE_FUNC void	resize (Index size)
EIGEN_DEVICE_FUNC void	resize (NoChange_t, Index cols)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resizeLike (const EigenBase< OtherDerived > &_other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_STRONG_INLINE void	writePacket (Index index, const PacketScalar &val)
EIGEN_STRONG_INLINE void	writePacket (Index rowId, Index colId, const PacketScalar &val)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index size, const Scalar &val)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index rows, Index cols, const Scalar &val)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (NoChange_t, Index cols, const Scalar &val)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index rows, NoChange_t, const Scalar &val)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index size)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index rows, Index cols)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (NoChange_t, Index cols)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index rows, NoChange_t)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index size)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index rows, Index cols)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (NoChange_t, Index cols)
EIGEN_DEVICE_FUNC Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index rows, NoChange_t)
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 > &	setRandom (NoChange_t, Index cols)
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index rows, NoChange_t)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (DenseBase< OtherDerived > const &other)

Protected Attributes
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage
Protected Attributes inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage

Friends
template<typename Derived , typename OtherDerived , bool IsVector>
struct	internal::conservative_resize_like_impl

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 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_check_template_params ()
Public Attributes inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
const typedef Eigen::Map< const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	ConstAlignedMapType
const typedef Eigen::Map< const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	ConstMapType
Protected Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const PlainObjectBase &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (Index size, Index rows, Index cols)
EIGEN_DEVICE_FUNC	PlainObjectBase (internal::constructor_without_unaligned_array_assert)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_resize_to_match (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	_set_noalias (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const T0 &val0, const T1 &val1, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const Index &val0, const Index &val1, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (Index size, typename internal::enable_if<(Base::SizeAtCompileTime!=1||!internal::is_convertible< T, Scalar >::value) &&((!internal::is_same< typename internal::traits< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value||Base::SizeAtCompileTime==Dynamic)), T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar *data)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const ReturnByValue< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value, T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value, T * >::type *=0)

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

_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.

Template Parameters

_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:

Eigen::VectorXd v(10);
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 Extending MatrixBase (and other classes) 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 type	Equivalent 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 Eigen::Index size; };
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, TopicStorageOrders

Definition at line 178 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Member Typedef Documentation

Base

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

Definition at line 186 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

PlainObject

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

typedef Base::PlainObject Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::PlainObject

Definition at line 192 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Member Enumeration Documentation

anonymous enum

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

anonymous enum

Enumerator
Options

Definition at line 188 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Constructor & Destructor Documentation

Matrix() [1/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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)

Definition at line 259 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [2/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( internal::constructor_without_unaligned_array_assert  )

inlineexplicit

Definition at line 267 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [3/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename T >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const T &  x )

inlineexplicit

Definition at line 329 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [4/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename T0 , typename T1 >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const T0 &  x, const T1 &  y  )

inline

Definition at line 337 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [5/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Scalar &  x, const Scalar &  y, const Scalar &  z  )

inline

Constructs an initialized 3D vector with given coefficients.

See also

Matrix(const Scalar&, const Scalar&, const Scalar&, const Scalar&, const ArgTypes&...)

Definition at line 389 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [6/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Scalar &  x, const Scalar &  y, const Scalar &  z, const Scalar &  w  )

inline

Constructs an initialized 4D vector with given coefficients.

See also

Matrix(const Scalar&, const Scalar&, const Scalar&, const Scalar&, const ArgTypes&...)

Definition at line 401 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [7/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &  other )

inline

Copy constructor.

Definition at line 414 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [8/9]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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>&)

Definition at line 422 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Matrix() [9/9]

template<typename _Scalar , int _Rows, int _Cols, int _Storage, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC 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.

\geometry_module

Definition at line 141 of file RotationBase.h.

Member Function Documentation

base() [1/2]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC Base& Eigen::PlainObjectBase< Derived >::base

inline

Definition at line 138 of file PlainObjectBase.h.

base() [2/2]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

const EIGEN_DEVICE_FUNC Base& Eigen::PlainObjectBase< Derived >::base

inline

Definition at line 140 of file PlainObjectBase.h.

coeffRef() [1/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const for details.

Definition at line 188 of file PlainObjectBase.h.

coeffRef() [2/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience.

Definition at line 207 of file PlainObjectBase.h.

coeffRef() [3/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const for details.

Definition at line 175 of file PlainObjectBase.h.

coeffRef() [4/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). It is provided for convenience.

Definition at line 196 of file PlainObjectBase.h.

innerStride()

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::innerStride ( ) const

inline

Definition at line 427 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

operator=() [1/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const DenseBase< OtherDerived > &  other )

inline

Definition at line 223 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

operator=() [2/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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.

Definition at line 236 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

operator=() [3/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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=.

Definition at line 206 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

operator=() [4/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const ReturnByValue< OtherDerived > &  func )

inline

Definition at line 243 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

operator=() [5/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC 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.

\geometry_module

Definition at line 155 of file RotationBase.h.

operator=() [6/6]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Matrix& Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator=

(

const RotationBase< OtherDerived, ColsAtCompileTime > &

r

)

outerStride()

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::outerStride ( ) const

inline

Definition at line 429 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Friends And Related Function Documentation

internal::conservative_resize_like_impl

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename Derived , typename OtherDerived , bool IsVector>

friend struct internal::conservative_resize_like_impl

friend

Definition at line 447 of file 3rdparty/Eigen/Eigen/src/Core/Matrix.h.

Member Data Documentation

m_storage

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

DenseStorage<Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options> Eigen::PlainObjectBase< Derived >::m_storage

protected

Definition at line 131 of file PlainObjectBase.h.

---

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

• 3rdparty/Eigen/Eigen/src/Core/Matrix.h
• RotationBase.h