Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
 
Loading...
Searching...
No Matches
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;
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180

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 typeEquivalent C structure
struct {
T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
Eigen::Index rows, cols;
};
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
struct {
T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
};
struct {
T data[Rows*Cols]; // with (size_t(data)%A(Rows*Cols*sizeof(T)))==0
};
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.
 

Public Member Functions

Scalar & coeffRef (Index index)
 
const Scalar & coeffRef (Index index) const
 
Scalar & coeffRef (Index rowId, Index colId)
 
const Scalar & coeffRef (Index rowId, Index colId) const
 
 Matrix ()
 Default constructor.
 
template<typename OtherDerived >
 Matrix (const EigenBase< OtherDerived > &other)
 Copy constructor for generic expressions.
 
 Matrix (const Matrix &other)
 Copy constructor.
 
template<typename OtherDerived >
 Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 Constructs a Dim x Dim rotation matrix from the rotation r.
 
template<typename... ArgTypes>
 Matrix (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
 
 Matrix (const Scalar &x)
 Constructs an initialized 1x1 matrix with the given coefficient.
 
 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 Scalar *data)
 Constructs a fixed-sized matrix initialized with coefficients starting at data.
 
 Matrix (const std::initializer_list< std::initializer_list< Scalar > > &list)
 Constructs a Matrix and initializes it from the coefficients given as initializer-lists grouped by row. [c++11]
 
 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.
 
 Matrix (Index rows, Index cols)
 Constructs an uninitialized matrix with rows rows and cols columns.
 
template<typename OtherDerived >
Matrixoperator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this.
 
Matrixoperator= (const Matrix &other)
 Assigns matrices to each other.
 
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.
 
- Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
const Scalar & coeff (Index index) const
 
const Scalar & coeff (Index rowId, Index colId) const
 
Scalar & coeffRef (Index index)
 
const Scalar & coeffRef (Index index) const
 
Scalar & coeffRef (Index rowId, Index colId)
 
const Scalar & coeffRef (Index rowId, Index colId) const
 
void conservativeResize (Index rows, Index cols)
 
void conservativeResize (Index rows, NoChange_t)
 
void conservativeResize (Index size)
 
void conservativeResize (NoChange_t, Index cols)
 
void conservativeResizeLike (const DenseBase< OtherDerived > &other)
 
Scalar * data ()
 
const Scalar * data () const
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & lazyAssign (const DenseBase< OtherDerived > &other)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & operator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this.
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & operator= (const PlainObjectBase &other)
 
void resize (Index rows, Index cols)
 
void resize (Index rows, NoChange_t)
 
void resize (Index size)
 
void resize (NoChange_t, Index cols)
 
void resizeLike (const EigenBase< OtherDerived > &_other)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setConstant (Index size, const Scalar &val)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setConstant (Index rows, Index cols, const Scalar &val)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setConstant (NoChange_t, Index cols, const Scalar &val)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setConstant (Index rows, NoChange_t, const Scalar &val)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setZero (Index size)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setZero (Index rows, Index cols)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setZero (NoChange_t, Index cols)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setZero (Index rows, NoChange_t)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setOnes (Index size)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setOnes (Index rows, Index cols)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & setOnes (NoChange_t, Index cols)
 
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)
 

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)
 
- Protected Member Functions inherited from Eigen::PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
 PlainObjectBase (const DenseBase< OtherDerived > &other)
 
 PlainObjectBase (const EigenBase< OtherDerived > &other)
 
 PlainObjectBase (const PlainObjectBase &other)
 
 PlainObjectBase (const ReturnByValue< OtherDerived > &other)
 Copy constructor with in-place evaluation.
 
 PlainObjectBase (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
 Construct a row of column vector with fixed size from an arbitrary number of coefficients. [c++11]
 
 PlainObjectBase (const std::initializer_list< std::initializer_list< Scalar > > &list)
 Constructs a Matrix or Array and initializes it by elements given by an initializer list of initializer lists [c++11]
 
void _resize_to_match (const EigenBase< OtherDerived > &other)
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & _set (const DenseBase< OtherDerived > &other)
 Copies the value of the expression other into *this with automatic resizing.
 
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & _set_noalias (const DenseBase< OtherDerived > &other)
 
void _init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)
 
void _init2 (const T0 &val0, const T1 &val1, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)
 
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)
 
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)
 
void _init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type *=0)
 
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)
 
void _init1 (const Scalar *data)
 
void _init1 (const DenseBase< OtherDerived > &other)
 
void _init1 (const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &other)
 
void _init1 (const EigenBase< OtherDerived > &other)
 
void _init1 (const ReturnByValue< OtherDerived > &other)
 
void _init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 
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)
 
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)
 

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

Constructor & Destructor Documentation

◆ Matrix() [1/11]

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)

◆ Matrix() [2/11]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
template<typename... ArgTypes>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Scalar &  a0,
const Scalar &  a1,
const Scalar &  a2,
const Scalar &  a3,
const ArgTypes &...  args 
)
inline

Example:

Matrix<int, 1, 6> a(1, 2, 3, 4, 5, 6);
Matrix<int, 3, 1> b {1, 2, 3};
cout << a << "\n\n" << b << endl;

Output:

1 2 3 4 5 6

1
2
3
See also
Matrix(const std::initializer_list<std::initializer_list<Scalar>>&)

◆ Matrix() [3/11]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const std::initializer_list< std::initializer_list< Scalar > > &  list)
inlineexplicit

Constructs a Matrix and initializes it from the coefficients given as initializer-lists grouped by row. [c++11]

In the general case, the constructor takes a list of rows, each row being represented as a list of coefficients:

Example:

{1, 2, 3},
{4, 5, 6}
};
cout << m << endl;

Output:

1 2 3
4 5 6

Each of the inner initializer lists must contain the exact same number of elements, otherwise an assertion is triggered.

In the case of a compile-time column vector, implicit transposition from a single row is allowed. Therefore VectorXd{{1,2,3,4,5}} is legal and the more verbose syntax RowVectorXd{{1},{2},{3},{4},{5}} can be avoided:

Example:

VectorXi v {{1, 2}};
cout << v << endl;

Output:

1
2

In the case of fixed-sized matrices, the initializer list sizes must exactly match the matrix sizes, and implicit transposition is allowed for compile-time vectors only.

See also
Matrix(const Scalar& a0, const Scalar& a1, const Scalar& a2, const Scalar& a3, const ArgTypes&... args)

◆ Matrix() [4/11]

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

◆ Matrix() [5/11]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Scalar &  x)

Constructs an initialized 1x1 matrix with the given coefficient.

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

◆ Matrix() [6/11]

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

◆ Matrix() [7/11]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Matrix ( const Scalar &  x,
const Scalar &  y 
)

Constructs an initialized 2D vector with given coefficients.

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

◆ Matrix() [8/11]

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

◆ Matrix() [9/11]

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

◆ Matrix() [10/11]

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

◆ Matrix() [11/11]

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

◆ coeffRef() [1/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Scalar & Eigen::PlainObjectBase< Derived >::coeffRef ( Index  index)
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.

◆ coeffRef() [2/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
const Scalar & Eigen::PlainObjectBase< Derived >::coeffRef ( Index  index) const
inline

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

◆ coeffRef() [3/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
Scalar & Eigen::PlainObjectBase< Derived >::coeffRef ( Index  rowId,
Index  colId 
)
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.

◆ coeffRef() [4/4]

template<typename _Scalar , int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
const Scalar & Eigen::PlainObjectBase< Derived >::coeffRef ( Index  rowId,
Index  colId 
) const
inline

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

◆ operator=() [1/3]

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.

◆ operator=() [2/3]

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=.
+ Here is the call graph for this function:

◆ operator=() [3/3]

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>

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