Detailed Description

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 sclar 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 TopicCustomizingEigen 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.

See also:: MatrixBase for the majority of the API methods for matrices, TopicClassHierarchy, TopicStorageOrders

Inheritance diagram for Eigen::Matrix:

[legend]

List of all members.

Public Types
enum	{ Options = _Options }
enum	{ NeedsToAlign }
typedef PlainObjectBase< Matrix >	Base
	Base class typedef.
typedef Base::PlainObject	PlainObject
enum
enum
typedef internal::traits < Derived >::StorageKind	StorageKind
typedef internal::traits < Derived >::Index	Index
typedef internal::traits < Derived >::Scalar	Scalar
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef Derived	DenseType
typedef Eigen::Map< Derived, Unaligned >	MapType
typedef const Eigen::Map < const Derived, Unaligned >	ConstMapType
typedef Eigen::Map< Derived, Aligned >	AlignedMapType
typedef const Eigen::Map < const Derived, Aligned >	ConstAlignedMapType
Public Member Functions
EIGEN_STRONG_INLINE Matrix &	operator= (const Matrix &other)
	Assigns matrices to each other.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrix &	operator= (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrix &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrix &	operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_STRONG_INLINE	Matrix ()
	Default constructor.
	Matrix (internal::constructor_without_unaligned_array_assert)
EIGEN_STRONG_INLINE	Matrix (Index dim)
	Constructs a vector or row-vector with given dimension.
	Matrix (Index rows, Index cols)
	Constructs an uninitialized matrix with rows rows and cols columns.
	Matrix (const Scalar &x, const Scalar &y)
	Constructs an initialized 2D vector with given coefficients.
EIGEN_STRONG_INLINE	Matrix (const Scalar &x, const Scalar &y, const Scalar &z)
	Constructs an initialized 3D vector with given coefficients.
EIGEN_STRONG_INLINE	Matrix (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w)
	Constructs an initialized 4D vector with given coefficients.
	Matrix (const Scalar *data)
template<typename OtherDerived >
EIGEN_STRONG_INLINE	Matrix (const MatrixBase< OtherDerived > &other)
	Constructor copying the value of the expression other.
EIGEN_STRONG_INLINE	Matrix (const Matrix &other)
	Copy constructor.
template<typename OtherDerived >
EIGEN_STRONG_INLINE	Matrix (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation.
template<typename OtherDerived >
EIGEN_STRONG_INLINE	Matrix (const EigenBase< OtherDerived > &other)
	Copy constructor for generic expressions.
template<typename OtherDerived >
void	swap (MatrixBase< OtherDerived > const &other)
Index	innerStride () const
Index	outerStride () const
template<typename OtherDerived >
	Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r)

template<typename OtherDerived >
Matrix &	operator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r)

Base &	base ()
const Base &	base () const
EIGEN_STRONG_INLINE Index	rows () const
EIGEN_STRONG_INLINE Index	cols () const
EIGEN_STRONG_INLINE const Scalar &	coeff (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalar &	coeff (Index index) const
EIGEN_STRONG_INLINE Scalar &	coeffRef (Index row, Index col)
EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index index) const
EIGEN_STRONG_INLINE PacketScalar	packet (Index row, Index col) const
EIGEN_STRONG_INLINE PacketScalar	packet (Index index) const
EIGEN_STRONG_INLINE void	writePacket (Index row, Index col, const PacketScalar &x)
EIGEN_STRONG_INLINE void	writePacket (Index index, const PacketScalar &x)
EIGEN_STRONG_INLINE const Scalar *	data () const
EIGEN_STRONG_INLINE Scalar *	data ()
EIGEN_STRONG_INLINE void	resize (Index rows, Index cols)
	Resizes `this` to a rows* x cols matrix.
void	resize (Index size)
	Resizes `this` to a vector of length size*.
void	resize (NoChange_t, Index cols)
	Resizes the matrix, changing only the number of columns.
void	resize (Index rows, NoChange_t)
	Resizes the matrix, changing only the number of rows.
EIGEN_STRONG_INLINE void	resizeLike (const EigenBase< OtherDerived > &_other)
	Resizes `this` to have the same dimensions as other*.
EIGEN_STRONG_INLINE void	conservativeResize (Index rows, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void	conservativeResize (Index rows, NoChange_t)
	Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void	conservativeResize (NoChange_t, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched.
EIGEN_STRONG_INLINE void	conservativeResize (Index size)
	Resizes the vector to size while retaining old values.
EIGEN_STRONG_INLINE void	conservativeResizeLike (const DenseBase< OtherDerived > &other)
	Resizes the matrix to rows x cols of `other`, while leaving old values untouched.
EIGEN_STRONG_INLINE Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
Derived &	setConstant (Index size, const Scalar &value)
Derived &	setConstant (Index rows, Index cols, const Scalar &value)
Derived &	setZero (Index size)
Derived &	setZero (Index rows, Index cols)
Derived &	setOnes (Index size)
Derived &	setOnes (Index rows, Index cols)
Derived &	setRandom (Index size)
Derived &	setRandom (Index rows, Index cols)
Static Public Member Functions
Map
These are convenience functions returning Map objects. The Map() static functions return unaligned Map objects, while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned data pointers. These methods do not allow to specify strides. If you need to specify strides, you have to use the Map class directly. See also: class Map
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)
Protected Member Functions
EIGEN_STRONG_INLINE void	_resize_to_match (const EigenBase< OtherDerived > &other)
EIGEN_STRONG_INLINE Derived &	_set (const DenseBase< OtherDerived > &other)
	Copies the value of the expression other into `*this` with automatic resizing.
EIGEN_STRONG_INLINE void	_set_selector (const OtherDerived &other, const internal::true_type &)
EIGEN_STRONG_INLINE void	_set_selector (const OtherDerived &other, const internal::false_type &)
EIGEN_STRONG_INLINE Derived &	_set_noalias (const DenseBase< OtherDerived > &other)
EIGEN_STRONG_INLINE void	_init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)
EIGEN_STRONG_INLINE void	_init2 (const Scalar &x, const Scalar &y, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)
void	_swap (DenseBase< OtherDerived > const &other)
Protected Attributes
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage
Friends
struct	internal::conservative_resize_like_impl
class	Eigen::Map
class	Eigen::Map< Derived, Unaligned >
class	Eigen::Map< const Derived, Unaligned >
class	Eigen::Map< Derived, Aligned >
class	Eigen::Map< const Derived, Aligned >
struct	internal::matrix_swap_impl

Member Typedef Documentation

typedef Eigen::Map<Derived, Aligned> Eigen::PlainObjectBase::AlignedMapType [inherited]

Definition at line 81 of file Core.

typedef PlainObjectBase<Matrix> Eigen::Matrix::Base

Base class typedef.

See also:: PlainObjectBase

Reimplemented from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Reimplemented in mrpt::math::CMatrixTemplateSize, mrpt::math::CArrayNumeric, Eigen::GeneralProduct< Lhs, Rhs, InnerProduct >, mrpt::dynamicsize_vector, mrpt::math::CMatrixTemplateNumeric, and mrpt::math::CMatrixFixedNumeric.

Definition at line 149 of file Core.

typedef const Eigen::Map<const Derived, Aligned> Eigen::PlainObjectBase::ConstAlignedMapType [inherited]

Definition at line 83 of file Core.

typedef const Eigen::Map<const Derived, Unaligned> Eigen::PlainObjectBase::ConstMapType [inherited]

Definition at line 79 of file Core.

typedef Derived Eigen::PlainObjectBase::DenseType [inherited]

Definition at line 64 of file Core.

typedef internal::traits<Derived>::Index Eigen::PlainObjectBase::Index [inherited]

Definition at line 60 of file Core.

typedef Eigen::Map<Derived, Unaligned> Eigen::PlainObjectBase::MapType [inherited]

Definition at line 77 of file Core.

typedef internal::packet_traits<Scalar>::type Eigen::PlainObjectBase::PacketScalar [inherited]

Definition at line 62 of file Core.

typedef Base::PlainObject Eigen::Matrix::PlainObject

Definition at line 155 of file Core.

typedef NumTraits<Scalar>::Real Eigen::PlainObjectBase::RealScalar [inherited]

Definition at line 63 of file Core.

typedef internal::traits<Derived>::Scalar Eigen::PlainObjectBase::Scalar [inherited]

Definition at line 61 of file Core.

typedef internal::traits<Derived>::StorageKind Eigen::PlainObjectBase::StorageKind [inherited]

Definition at line 59 of file Core.

Member Enumeration Documentation

anonymous enum [inherited]

Definition at line 56 of file Core.

anonymous enum [inherited]

Definition at line 94 of file Core.

anonymous enum

Enumerator:

Options

Definition at line 151 of file Core.

anonymous enum

Enumerator:

NeedsToAlign

Definition at line 157 of file Core.

Constructor & Destructor Documentation

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( ) [inline, explicit]

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 221 of file Core.

Eigen::Matrix::Matrix ( internal::constructor_without_unaligned_array_assert ) [inline]

Definition at line 228 of file Core.

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( Index dim ) [inline, explicit]

Constructs a vector or row-vector with given dimension.

Note that this is only useful for dynamic-size vectors. For fixed-size vectors, it is redundant to pass the dimension here, so it makes more sense to use the default constructor Matrix() instead.

Definition at line 238 of file Core.

Eigen::Matrix::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.

Eigen::Matrix::Matrix	(	const Scalar &	x,
		const Scalar &	y
	)

Constructs an initialized 2D vector with given coefficients.

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix	(	const Scalar &	x,
		const Scalar &	y,
		const Scalar &	z
	)		`[inline]`

Constructs an initialized 3D vector with given coefficients.

Definition at line 267 of file Core.

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix	(	const Scalar &	x,
		const Scalar &	y,
		const Scalar &	z,
		const Scalar &	w
	)		`[inline]`

Constructs an initialized 4D vector with given coefficients.

Definition at line 276 of file Core.

Eigen::Matrix::Matrix ( const Scalar * data ) [inline, explicit]

Definition at line 201 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( const MatrixBase< OtherDerived > & other ) [inline]

Constructor copying the value of the expression other.

Definition at line 290 of file Core.

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( const Matrix & other ) [inline]

Copy constructor.

Definition at line 302 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( const ReturnByValue< OtherDerived > & other ) [inline]

Copy constructor with in-place evaluation.

Definition at line 310 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Eigen::Matrix::Matrix ( const EigenBase< OtherDerived > & other ) [inline]

Copy constructor for generic expressions.

See also:: MatrixBase::operator=(const EigenBase<OtherDerived>&)

Definition at line 321 of file Core.

template<typename OtherDerived >

Eigen::Matrix::Matrix ( const RotationBase< OtherDerived, ColsAtCompileTime > & r ) [explicit]

Constructs a Dim x Dim rotation matrix from the rotation r

Definition at line 155 of file Geometry.

Member Function Documentation

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_init2	(	Index	rows,
		Index	cols,
		typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *	= `0`
	)		`[inline, protected, inherited]`

Definition at line 584 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_init2	(	const Scalar &	x,
		const Scalar &	y,
		typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *	= `0`
	)		`[inline, protected, inherited]`

Definition at line 592 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_resize_to_match ( const EigenBase< OtherDerived > & other ) [inline, protected, inherited]

Definition at line 529 of file Core.

EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::_set ( const DenseBase< OtherDerived > & other ) [inline, protected, inherited]

Copies the value of the expression other into *this with automatic resizing.

*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.

Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.

See also:: operator=(const MatrixBase<OtherDerived>&), _set_noalias()

Definition at line 555 of file Core.

EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::_set_noalias ( const DenseBase< OtherDerived > & other ) [inline, protected, inherited]

Definition at line 573 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_set_selector	(	const OtherDerived &	other,
		const internal::true_type &
	)		`[inline, protected, inherited]`

Definition at line 562 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::_set_selector	(	const OtherDerived &	other,
		const internal::false_type &
	)		`[inline, protected, inherited]`

Definition at line 565 of file Core.

void Eigen::PlainObjectBase::_swap ( DenseBase< OtherDerived > const & other ) [inline, protected, inherited]

Definition at line 606 of file Core.

Base& Eigen::PlainObjectBase::base ( ) [inline, inherited]

Definition at line 98 of file Core.

const Base& Eigen::PlainObjectBase::base ( ) const [inline, inherited]

Definition at line 99 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeff	(	Index	row,
		Index	col
	)		const `[inline, inherited]`

Definition at line 104 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeff ( Index index ) const [inline, inherited]

Definition at line 112 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase::coeffRef	(	Index	row,
		Index	col
	)		`[inline, inherited]`

Definition at line 117 of file Core.

EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase::coeffRef ( Index index ) [inline, inherited]

Definition at line 125 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeffRef	(	Index	row,
		Index	col
	)		const `[inline, inherited]`

Definition at line 130 of file Core.

EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase::coeffRef ( Index index ) const [inline, inherited]

Definition at line 138 of file Core.

EIGEN_STRONG_INLINE Index Eigen::PlainObjectBase::cols ( void ) const [inline, inherited]

Definition at line 102 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::conservativeResize	(	Index	rows,
		Index	cols
	)		`[inline, inherited]`

Resizes the matrix to rows x cols while leaving old values untouched.

The method is intended for matrices of dynamic size. If you only want to change the number of rows and/or of columns, you can use conservativeResize(NoChange_t, Index) or conservativeResize(Index, NoChange_t).

Matrices are resized relative to the top-left element. In case values need to be appended to the matrix they will be uninitialized.

Definition at line 300 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::conservativeResize	(	Index	rows,
		NoChange_t
	)		`[inline, inherited]`

Resizes the matrix to rows x cols while leaving old values untouched.

As opposed to conservativeResize(Index rows, Index cols), this version leaves the number of columns unchanged.

In case the matrix is growing, new rows will be uninitialized.

Definition at line 312 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::conservativeResize	(	NoChange_t	,
		Index	cols
	)		`[inline, inherited]`

Resizes the matrix to rows x cols while leaving old values untouched.

As opposed to conservativeResize(Index rows, Index cols), this version leaves the number of rows unchanged.

In case the matrix is growing, new columns will be uninitialized.

Definition at line 325 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::conservativeResize ( Index size ) [inline, inherited]

Resizes the vector to size while retaining old values.

. This method does not work for partially dynamic matrices when the static dimension is anything other than 1. For example it will not work with Matrix<double, 2, Dynamic>.

When values are appended, they will be uninitialized.

Definition at line 339 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::conservativeResizeLike ( const DenseBase< OtherDerived > & other ) [inline, inherited]

Resizes the matrix to rows x cols of other, while leaving old values untouched.

The method is intended for matrices of dynamic size. If you only want to change the number of rows and/or of columns, you can use conservativeResize(NoChange_t, Index) or conservativeResize(Index, NoChange_t).

Matrices are resized relative to the top-left element. In case values need to be appended to the matrix they will copied from other.

Definition at line 354 of file Core.

EIGEN_STRONG_INLINE const Scalar* Eigen::PlainObjectBase::data ( ) const [inline, inherited]

Returns:: a const pointer to the data array of this matrix

Definition at line 178 of file Core.

EIGEN_STRONG_INLINE Scalar* Eigen::PlainObjectBase::data ( ) [inline, inherited]

Returns:: a pointer to the data array of this matrix

Definition at line 182 of file Core.

Index Eigen::Matrix::innerStride ( ) const [inline]

Definition at line 339 of file Core.

EIGEN_STRONG_INLINE Derived& Eigen::PlainObjectBase::lazyAssign ( const DenseBase< OtherDerived > & other ) [inline, inherited]

See also:: MatrixBase::lazyAssign()

Definition at line 369 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map ( const Scalar * data ) [inline, static, inherited]

Definition at line 435 of file Core.

static MapType Eigen::PlainObjectBase::Map ( Scalar * data ) [inline, static, inherited]

Definition at line 437 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map	(	const Scalar *	data,
		Index	size
	)		`[inline, static, inherited]`

Definition at line 439 of file Core.

static MapType Eigen::PlainObjectBase::Map	(	Scalar *	data,
		Index	size
	)		`[inline, static, inherited]`

Definition at line 441 of file Core.

static ConstMapType Eigen::PlainObjectBase::Map	(	const Scalar *	data,
		Index	rows,
		Index	cols
	)		`[inline, static, inherited]`

Definition at line 443 of file Core.

static MapType Eigen::PlainObjectBase::Map	(	Scalar *	data,
		Index	rows,
		Index	cols
	)		`[inline, static, inherited]`

Definition at line 445 of file Core.

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	const Scalar *	data,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 462 of file Core.

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	Scalar *	data,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 465 of file Core.

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	const Scalar *	data,
		Index	size,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 468 of file Core.

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	Scalar *	data,
		Index	size,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 471 of file Core.

static StridedConstMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	const Scalar *	data,
		Index	rows,
		Index	cols,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 474 of file Core.

static StridedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::Map	(	Scalar *	data,
		Index	rows,
		Index	cols,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 477 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned ( const Scalar * data ) [inline, static, inherited]

Definition at line 448 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned ( Scalar * data ) [inline, static, inherited]

Definition at line 450 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned	(	const Scalar *	data,
		Index	size
	)		`[inline, static, inherited]`

Definition at line 452 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned	(	Scalar *	data,
		Index	size
	)		`[inline, static, inherited]`

Definition at line 454 of file Core.

static ConstAlignedMapType Eigen::PlainObjectBase::MapAligned	(	const Scalar *	data,
		Index	rows,
		Index	cols
	)		`[inline, static, inherited]`

Definition at line 456 of file Core.

static AlignedMapType Eigen::PlainObjectBase::MapAligned	(	Scalar *	data,
		Index	rows,
		Index	cols
	)		`[inline, static, inherited]`

Definition at line 458 of file Core.

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	const Scalar *	data,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 481 of file Core.

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	Scalar *	data,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 484 of file Core.

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	const Scalar *	data,
		Index	size,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 487 of file Core.

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	Scalar *	data,
		Index	size,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 490 of file Core.

static StridedConstAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	const Scalar *	data,
		Index	rows,
		Index	cols,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 493 of file Core.

static StridedAlignedMapType<Stride<Outer, Inner> >::type Eigen::PlainObjectBase::MapAligned	(	Scalar *	data,
		Index	rows,
		Index	cols,
		const Stride< Outer, Inner > &	stride
	)		`[inline, static, inherited]`

Definition at line 496 of file Core.

EIGEN_STRONG_INLINE Matrix& Eigen::Matrix::operator= ( const Matrix & 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 172 of file Core.

Referenced by mrpt::math::CMatrix::operator=(), and mrpt::math::CMatrixD::operator=().

template<typename OtherDerived >

EIGEN_STRONG_INLINE Matrix& Eigen::Matrix::operator= ( const MatrixBase< OtherDerived > & other ) [inline]

Reimplemented in mrpt::math::CArrayNumeric, and mrpt::math::CMatrix.

Definition at line 188 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Matrix& Eigen::Matrix::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.

Reimplemented from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Definition at line 200 of file Core.

template<typename OtherDerived >

EIGEN_STRONG_INLINE Matrix& Eigen::Matrix::operator= ( const ReturnByValue< OtherDerived > & func ) [inline]

Reimplemented from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.

Definition at line 206 of file Core.

template<typename OtherDerived >

Matrix< _Scalar, _Rows, _Cols, _Storage, _MaxRows, _MaxCols > & Eigen::Matrix::operator= ( const RotationBase< OtherDerived, ColsAtCompileTime > & r )

Set a Dim x Dim rotation matrix from the rotation r

Definition at line 169 of file Geometry.

Index Eigen::Matrix::outerStride ( ) const [inline]

Definition at line 340 of file Core.

EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase::packet	(	Index	row,
		Index	col
	)		const `[inline, inherited]`

Definition at line 145 of file Core.

EIGEN_STRONG_INLINE PacketScalar Eigen::PlainObjectBase::packet ( Index index ) const [inline, inherited]

Definition at line 155 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::resize	(	Index	rows,
		Index	cols
	)		`[inline, inherited]`

Resizes *this to a rows x cols matrix.

This method is intended for dynamic-size matrices, although it is legal to call it on any matrix as long as fixed dimensions are left unchanged. If you only want to change the number of rows and/or of columns, you can use resize(NoChange_t, Index), resize(Index, NoChange_t).

If the current number of coefficients of *this exactly matches the product rows * cols, then no memory allocation is performed and the current values are left unchanged. In all other cases, including shrinking, the data is reallocated and all previous values are lost.

Example:

Output:

See also:: resize(Index) for vectors, resize(NoChange_t, Index), resize(Index, NoChange_t)

Definition at line 201 of file Core.

void Eigen::PlainObjectBase::resize ( Index size ) [inline, inherited]

Resizes *this to a vector of length size.

. This method does not work for partially dynamic matrices when the static dimension is anything other than 1. For example it will not work with Matrix<double, 2, Dynamic>.

Example:

Output:

See also:: resize(Index,Index), resize(NoChange_t, Index), resize(Index, NoChange_t)

Definition at line 224 of file Core.

void Eigen::PlainObjectBase::resize	(	NoChange_t	,
		Index	cols
	)		`[inline, inherited]`

Resizes the matrix, changing only the number of columns.

For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.

Example:

Output:

See also:: resize(Index,Index)

Definition at line 248 of file Core.

void Eigen::PlainObjectBase::resize	(	Index	rows,
		NoChange_t
	)		`[inline, inherited]`

Resizes the matrix, changing only the number of rows.

For the parameter of type NoChange_t, just pass the special value NoChange as in the example below.

Example:

Output:

See also:: resize(Index,Index)

Definition at line 261 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::resizeLike ( const EigenBase< OtherDerived > & _other ) [inline, inherited]

Resizes *this to have the same dimensions as other.

Takes care of doing all the checking that's needed.

Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.

Definition at line 274 of file Core.

EIGEN_STRONG_INLINE Index Eigen::PlainObjectBase::rows ( void ) const [inline, inherited]

Definition at line 101 of file Core.

Derived& Eigen::PlainObjectBase::setConstant	(	Index	size,
		const Scalar &	value
	)		`[inherited]`

Resizes to the given size, and sets all coefficients in this expression to the given value.

Example:

Output:

See also:: MatrixBase::setConstant(const Scalar&), setConstant(Index,Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Derived& Eigen::PlainObjectBase::setConstant	(	Index	rows,
		Index	cols,
		const Scalar &	value
	)		`[inherited]`

Resizes to the given size, and sets all coefficients in this expression to the given value.

Parameters:

rows	the new number of rows
cols	the new number of columns
value	the value to which all coefficients are set

Example:

Output:

See also:: MatrixBase::setConstant(const Scalar&), setConstant(Index,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)

Derived& Eigen::PlainObjectBase::setOnes ( Index size ) [inherited]

Resizes to the given size, and sets all coefficients in this expression to one.

Example:

Output:

See also:: MatrixBase::setOnes(), setOnes(Index,Index), class CwiseNullaryOp, MatrixBase::Ones()

Derived& Eigen::PlainObjectBase::setOnes	(	Index	rows,
		Index	cols
	)		`[inherited]`

Resizes to the given size, and sets all coefficients in this expression to one.

Parameters:

rows	the new number of rows
cols	the new number of columns

Example:

Output:

See also:: MatrixBase::setOnes(), setOnes(Index), class CwiseNullaryOp, MatrixBase::Ones()

Derived& Eigen::PlainObjectBase::setRandom ( Index size ) [inherited]

Resizes to the given size, and sets all coefficients in this expression to random values.

Example:

Output:

See also:: MatrixBase::setRandom(), setRandom(Index,Index), class CwiseNullaryOp, MatrixBase::Random()

Derived& Eigen::PlainObjectBase::setRandom	(	Index	rows,
		Index	cols
	)		`[inherited]`

Resizes to the given size, and sets all coefficients in this expression to random values.

Parameters:

rows	the new number of rows
cols	the new number of columns

Example:

Output:

See also:: MatrixBase::setRandom(), setRandom(Index), class CwiseNullaryOp, MatrixBase::Random()

Derived& Eigen::PlainObjectBase::setZero ( Index size ) [inherited]

Resizes to the given size, and sets all coefficients in this expression to zero.

Example:

Output:

See also:: DenseBase::setZero(), setZero(Index,Index), class CwiseNullaryOp, DenseBase::Zero()

Derived& Eigen::PlainObjectBase::setZero	(	Index	rows,
		Index	cols
	)		`[inherited]`

Resizes to the given size, and sets all coefficients in this expression to zero.

Parameters:

rows	the new number of rows
cols	the new number of columns

Example:

Output:

See also:: DenseBase::setZero(), setZero(Index), class CwiseNullaryOp, DenseBase::Zero()

template<typename OtherDerived >

void Eigen::Matrix::swap ( MatrixBase< OtherDerived > const & other ) [inline]

Definition at line 336 of file Core.

Referenced by mrpt::graphslam::optimize_graph_spa_levmarq().

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	x
	)		`[inline, inherited]`

Definition at line 162 of file Core.

EIGEN_STRONG_INLINE void Eigen::PlainObjectBase::writePacket	(	Index	index,
		const PacketScalar &	x
	)		`[inline, inherited]`

Definition at line 172 of file Core.

Friends And Related Function Documentation

friend class Eigen::Map [friend, inherited]

Definition at line 75 of file Core.

friend class Eigen::Map< const Derived, Aligned > [friend, inherited]

Definition at line 82 of file Core.

friend class Eigen::Map< const Derived, Unaligned > [friend, inherited]

Definition at line 78 of file Core.

friend class Eigen::Map< Derived, Aligned > [friend, inherited]

Definition at line 80 of file Core.

friend class Eigen::Map< Derived, Unaligned > [friend, inherited]

Definition at line 76 of file Core.

friend struct internal::conservative_resize_like_impl [friend]

Definition at line 363 of file Core.

friend struct internal::matrix_swap_impl [friend, inherited]

Definition at line 600 of file Core.

Member Data Documentation

DenseStorage<Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options> Eigen::PlainObjectBase::m_storage [protected, inherited]

Definition at line 91 of file Core.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation