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< MatrixBase
 Base class typedef. More...
 
typedef Base::PlainObject PlainObject
 
- Public Types inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
enum  
 
enum  
 
enum  
 
typedef internal::dense_xpr_base< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >::type Base
 
typedef internal::traits< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >::StorageKind StorageKind
 
typedef internal::traits< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >::Scalar Scalar
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > DenseType
 
typedef Eigen::Map< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, Unaligned > MapType
 
typedef const Eigen::Map< const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, Unaligned > ConstMapType
 
typedef Eigen::Map< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, AlignedMax > AlignedMapType
 
typedef const Eigen::Map< const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, AlignedMax > ConstAlignedMapType
 

Public Member Functions

EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrixoperator= (const Matrix &other)
 Assigns matrices to each other. More...
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrixoperator= (const DenseBase< OtherDerived > &other)
 Copies the value of the expression other into *this with automatic resizing. More...
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrixoperator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrixoperator= (const ReturnByValue< OtherDerived > &func)
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix ()=default
 Default constructor. More...
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix (Matrix &&)=default
 Move constructor. More...
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrixoperator= (Matrix &&other) EIGEN_NOEXCEPT_IF(std
 Moves the matrix into the other one. More...
 
template<typename... ArgTypes>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Matrix (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
 
constexpr EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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. \cpp11. 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 (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...
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix (const Matrix &)=default
 Copy 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_CONSTEXPR Index innerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride () const EIGEN_NOEXCEPT
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 Constructs a Dim x Dim rotation matrix from the rotation r. More...
 
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Matrixoperator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 
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...
 
EIGEN_DEVICE_FUNC const Basebase () const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE ScalarcoeffRef (Index rowId, Index colId)
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE ScalarcoeffRef (Index index)
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const ScalarcoeffRef (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const ScalarcoeffRef (Index index) const
 
- Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
 EIGEN_STATIC_ASSERT (internal::check_implication(MaxRowsAtCompileTime==1 &&MaxColsAtCompileTime !=1,(int(Options) &RowMajor)==RowMajor), INVALID_MATRIX_TEMPLATE_PARAMETERS) EIGEN_STATIC_ASSERT(internal
 
EIGEN_DEVICE_FUNC const Basebase () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const Scalarcoeff (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const Scalarcoeff (Index index) const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE ScalarcoeffRef (Index rowId, Index colId)
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE ScalarcoeffRef (Index index)
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const ScalarcoeffRef (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const ScalarcoeffRef (Index index) const
 
EIGEN_STRONG_INLINE PacketScalar packet (Index rowId, Index colId) const
 
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const
 
EIGEN_STRONG_INLINE void writePacket (Index rowId, Index colId, const PacketScalar &val)
 
EIGEN_STRONG_INLINE void writePacket (Index index, const PacketScalar &val)
 
constexpr EIGEN_DEVICE_FUNC const Scalardata () const
 
constexpr EIGEN_DEVICE_FUNC Scalardata ()
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE void resize (Index rows, Index cols)
 
constexpr EIGEN_DEVICE_FUNC void resize (Index size)
 
constexpr EIGEN_DEVICE_FUNC void resize (NoChange_t, Index cols)
 
constexpr EIGEN_DEVICE_FUNC void resize (Index rows, NoChange_t)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void resizeLike (const EigenBase< OtherDerived > &_other)
 
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 (NoChange_t, Index cols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResize (Index size)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC constexpr 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_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_ > & lazyAssign (const DenseBase< OtherDerived > &other)
 
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)
 Override DenseBase::swap() since for dynamic-sized matrices of same type it is enough to swap the data pointers. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap (DenseBase< OtherDerived > const &other)
 const version forwarded to DenseBase::swap More...
 

Protected Attributes

DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Optionsm_storage
 
- Protected Attributes inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Optionsm_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)
 
- Protected Member Functions inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
constexpr EIGEN_DEVICE_FUNC PlainObjectBaseoperator= (PlainObjectBase &&other) EIGEN_NOEXCEPT
 Move assignment operator. More...
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE PlainObjectBase ()=default
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE PlainObjectBase (PlainObjectBase &&)=default
 Move constructor. More...
 
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE PlainObjectBase (const PlainObjectBase &)=default
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PlainObjectBase (Index size, Index rows, Index cols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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. More...
 
constexpr EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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. More...
 
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 ReturnByValue< OtherDerived > &other)
 Copy constructor with in-place evaluation. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _resize_to_match (const EigenBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC constexpr 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 constexpr 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, std::enable_if_t< Base::SizeAtCompileTime !=2, T0 > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init2 (const T0 &val0, const T1 &val1, std::enable_if_t< Base::SizeAtCompileTime==2, T0 > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init2 (const Index &val0, const Index &val1, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (Index size, std::enable_if_t<(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 > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const Scalar &val0, std::enable_if_t< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const Index &val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * > *=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, std::enable_if_t< 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 > *=0)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _init1 (const Index &val0, std::enable_if_t<(!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 * > *=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;
Array< int, Dynamic, 1 > v
Definition: Array_initializer_list_vector_cxx11.cpp:1
int * m
Definition: level2_cplx_impl.h:294

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 at 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 at compile-time, but it is known at compile-time that they cannot exceed a certain value. This happens when taking dynamic-size blocks inside fixed-size matrices: in this case MaxRows_ and MaxCols_ are the dimensions of the original matrix, while Rows_ and Cols_ are Dynamic.

ABI and storage layout

The table below summarizes the ABI of some possible Matrix instances which is fixed thorough the lifetime of Eigen 3.

Matrix typeEquivalent C structure
Matrix<T,Dynamic,Dynamic>
struct {
T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
};
constexpr EIGEN_DEVICE_FUNC const Scalar * data() const
Definition: PlainObjectBase.h:273
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: PlainObjectBase.h:192
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: PlainObjectBase.h:191
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:83
Matrix<T,Dynamic,1>
Matrix<T,1,Dynamic>
struct {
T *data; // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
};
Scalar Scalar int size
Definition: benchVecAdd.cpp:17
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
};

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

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

◆ 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

Member Enumeration Documentation

◆ anonymous enum

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
anonymous enum
Enumerator
Options 
193 { Options = Options_ };
@ Options
Definition: Eigen/Eigen/src/Core/Matrix.h:193

Constructor & Destructor Documentation

◆ Matrix() [1/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix ( )
constexprdefault

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_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix ( Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &&  )
constexprdefault

Move constructor.

◆ Matrix() [3/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
template<typename... ArgTypes>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE 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;
Scalar * b
Definition: benchVecAdd.cpp:17
const Scalar * a
Definition: level2_cplx_impl.h:32

Output:

See also
Matrix(const std::initializer_list<std::initializer_list<Scalar>>&)
279  : Base(a0, a1, a2, a3, args...) {}
PlainObjectBase< Matrix > Base
Base class typedef.
Definition: Eigen/Eigen/src/Core/Matrix.h:191
args
Definition: compute_granudrum_aor.py:143

◆ Matrix() [4/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
constexpr EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix ( const std::initializer_list< std::initializer_list< Scalar >> &  list)
inlineexplicitconstexpr

Constructs a Matrix and initializes it from the coefficients given as initializer-lists grouped by row. \cpp11.

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

Example:

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

Output:

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:

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)
306  : Base(list) {}

◆ Matrix() [5/11]

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
312  {
313  Base::template _init1<T>(x);
314  }
list x
Definition: plotDoE.py:28

References plotDoE::x.

◆ Matrix() [6/11]

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
317  {
318  Base::template _init2<T0, T1>(x, y);
319  }
Scalar * y
Definition: level1_cplx_impl.h:128

References plotDoE::x, and y.

◆ Matrix() [7/11]

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&...)
363  {
365  m_storage.data()[0] = x;
366  m_storage.data()[1] = y;
367  m_storage.data()[2] = z;
368  }
#define EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(TYPE, SIZE)
Definition: StaticAssert.h:50
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options > m_storage
Definition: PlainObjectBase.h:164
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix()=default
Default constructor.

References Eigen::internal::DenseStorage_impl< T, Size, Rows, Cols, Options >::data(), EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE, Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::m_storage, plotDoE::x, and y.

◆ Matrix() [8/11]

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&...)
372  {
374  m_storage.data()[0] = x;
375  m_storage.data()[1] = y;
376  m_storage.data()[2] = z;
377  m_storage.data()[3] = w;
378  }
RowVector3d w
Definition: Matrix_resize_int.cpp:3

References Eigen::internal::DenseStorage_impl< T, Size, Rows, Cols, Options >::data(), EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE, Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::m_storage, w, plotDoE::x, and y.

◆ Matrix() [9/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix ( const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &  )
constexprdefault

Copy constructor.

◆ Matrix() [10/11]

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>&)
387 : Base(other.derived()) {}

◆ Matrix() [11/11]

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

149  {
151  *this = r.toRotationMatrix();
152 }
#define EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE(TYPE, ROWS, COLS)
Definition: StaticAssert.h:55
static const unsigned Dim
Problem dimension.
Definition: two_d_tilted_square.cc:62
r
Definition: UniformPSDSelfTest.py:20

References Global_Variables::Dim, EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE, and UniformPSDSelfTest::r.

Member Function Documentation

◆ base()

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC const Base& Eigen::PlainObjectBase< Derived >::base
inline
189 { return *static_cast<const Base*>(this); }

◆ coeffRef() [1/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef
inlineconstexpr

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.

228 { return m_storage.data()[index]; }
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE T * data()
Definition: DenseStorage.h:122

◆ coeffRef() [2/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase< Derived >::coeffRef
inlineconstexpr

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

241  {
242  return m_storage.data()[index];
243  }

◆ coeffRef() [3/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef
inlineconstexpr

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.

217  {
218  if (Flags & RowMajorBit)
219  return m_storage.data()[colId + rowId * m_storage.cols()];
220  else // column-major
221  return m_storage.data()[rowId + colId * m_storage.rows()];
222  }
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Index cols() const
Definition: DenseStorage.h:120
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Index rows() const
Definition: DenseStorage.h:119
const unsigned int RowMajorBit
Definition: Constants.h:70
Extend namespace for flags.
Definition: fsi_chan_precond_driver.cc:56

Referenced by Eigen::HessenbergDecomposition< MatrixType_ >::_compute(), Eigen::FullPivHouseholderQR< MatrixType_, PermutationIndex_ >::_solve_impl(), Eigen::FullPivHouseholderQR< MatrixType_, PermutationIndex_ >::_solve_impl_transposed(), Eigen::GeneralizedEigenSolver< MatrixType_ >::compute(), Eigen::FullPivHouseholderQR< MatrixType_, PermutationIndex_ >::computeInPlace(), Eigen::Transform< Scalar_, Dim_, Mode_, Options_ >::computeRotationScaling(), Eigen::Transform< Scalar_, Dim_, Mode_, Options_ >::computeScalingRotation(), Eigen::RealSchur< MatrixType_ >::computeShift(), Eigen::PermutationBase< Derived >::determinant(), DenseLM< Scalar >::df(), Eigen::ComplexEigenSolver< MatrixType_ >::doComputeEigenvectors(), Eigen::EigenSolver< MatrixType_ >::eigenvectors(), Eigen::internal::kernel_retval< FullPivLU< MatrixType_, PermutationIndex_ > >::evalTo(), Eigen::internal::image_retval< FullPivLU< MatrixType_, PermutationIndex_ > >::evalTo(), Eigen::internal::FullPivHouseholderQRMatrixQReturnType< MatrixType, PermutationIndex >::evalTo(), householder(), Eigen::internal::matrix_sqrt_quasi_triangular_solve_auxiliary_equation(), EulerAngles< Scalar_ >::operator=(), Eigen::ComplexSchur< MatrixType_ >::reduceToTriangularForm(), Eigen::internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Upper, RowMajor >::run(), Eigen::internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Lower, ColMajor >::run(), Eigen::internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Upper, ColMajor >::run(), Eigen::internal::compute_inverse_and_det_with_check< MatrixType, ResultType, 3 >::run(), Eigen::internal::compute_inverse< MatrixType, ResultType, 3 >::run(), Eigen::internal::permutation_matrix_product< ExpressionType, Side, Transposed, DenseShape >::run(), Eigen::internal::product_triangular_matrix_matrix< Scalar, Index, Mode, true, LhsStorageOrder, ConjugateLhs, RhsStorageOrder, ConjugateRhs, ColMajor, ResInnerStride, Version >::run(), Eigen::internal::product_triangular_matrix_matrix< Scalar, Index, Mode, false, LhsStorageOrder, ConjugateLhs, RhsStorageOrder, ConjugateRhs, ColMajor, ResInnerStride, Version >::run(), Eigen::internal::svd_precondition_2x2_block_to_be_real< MatrixType, Options, true >::run(), sparse_basic(), sparse_extra(), sparse_vector(), Eigen::RealQZ< MatrixType_ >::step(), Eigen::ComplexSchur< MatrixType_ >::subdiagonalEntryIsNeglegible(), Eigen::internal::tridiagonalization_inplace(), and Eigen::internal::upperbidiagonalization_blocked_helper().

◆ coeffRef() [4/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE const Scalar& Eigen::PlainObjectBase< Derived >::coeffRef
inlineconstexpr

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

232  {
233  if (Flags & RowMajorBit)
234  return m_storage.data()[colId + rowId * m_storage.cols()];
235  else // column-major
236  return m_storage.data()[rowId + colId * m_storage.rows()];
237  }

◆ 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
389 { return 1; }

◆ operator=() [1/7]

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

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.

223  {
224  return Base::_set(other);
225  }
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Derived & _set(const DenseBase< OtherDerived > &other)
Copies the value of the expression other into *this with automatic resizing.
Definition: PlainObjectBase.h:743

References Eigen::PlainObjectBase< Derived >::_set().

◆ operator=() [2/7]

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.
234  {
235  return Base::operator=(other);
236  }
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Derived & operator=(const PlainObjectBase &other)
Definition: PlainObjectBase.h:455

References Eigen::PlainObjectBase< Derived >::operator=().

◆ operator=() [3/7]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix& Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::operator= ( const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &  other)
inlineconstexpr

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=.
210 { return Base::_set(other); }

References Eigen::PlainObjectBase< Derived >::_set().

◆ operator=() [4/7]

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
239  {
240  return Base::operator=(func);
241  }
Definition: benchGeometry.cpp:21

References Eigen::PlainObjectBase< Derived >::operator=().

◆ operator=() [5/7]

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)

◆ operator=() [6/7]

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

162  {
164  return *this = r.toRotationMatrix();
165 }

References Global_Variables::Dim, EIGEN_STATIC_ASSERT_MATRIX_SPECIFIC_SIZE, and UniformPSDSelfTest::r.

◆ operator=() [7/7]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
EIGEN_DEVICE_FUNC constexpr EIGEN_STRONG_INLINE Matrix& Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::operator= ( Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &&  other)
inlineconstexpr

Moves the matrix into the other one.

264  {
265  Base::operator=(std::move(other));
266  return *this;
267  }

References Eigen::PlainObjectBase< Derived >::operator=().

◆ outerStride()

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

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

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