Logo Search packages:      
Sourcecode: eigen3 version File versions  Download package

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends

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 Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:
Inheritance graph
[legend]
Collaboration diagram for Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { Options = _Options }
enum  { NeedsToAlign }
enum  
enum  
typedef Eigen::Map< Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, Aligned > 
AlignedMapType
typedef PlainObjectBase< MatrixBase
 Base class typedef.
typedef const Eigen::Map
< const Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols >, Aligned > 
ConstAlignedMapType
typedef const Eigen::Map
< const Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols >, Unaligned > 
ConstMapType
typedef Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols > 
DenseType
typedef internal::traits
< Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols > >::Index 
Index
typedef Eigen::Map< Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols >
, Unaligned > 
MapType
typedef
internal::packet_traits
< Scalar >::type 
PacketScalar
typedef Base::PlainObject PlainObject
typedef NumTraits< Scalar >::Real RealScalar
typedef internal::traits
< Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols > >::Scalar 
Scalar
typedef internal::traits
< Matrix< _Scalar, _Rows,
_Cols, _Options, _MaxRows,
_MaxCols > >::StorageKind 
StorageKind

Public Member Functions

Basebase ()
const Basebase () 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 Index cols () const
EIGEN_STRONG_INLINE void conservativeResize (Index rows, Index cols)
EIGEN_STRONG_INLINE void conservativeResize (Index rows, NoChange_t)
EIGEN_STRONG_INLINE void conservativeResize (NoChange_t, Index cols)
EIGEN_STRONG_INLINE void conservativeResize (Index size)
EIGEN_STRONG_INLINE void conservativeResizeLike (const DenseBase< OtherDerived > &other)
EIGEN_STRONG_INLINE const Scalar * data () const
EIGEN_STRONG_INLINE Scalar * data ()
Index innerStride () const
EIGEN_STRONG_INLINE Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
lazyAssign (const DenseBase< OtherDerived > &other)
template<typename T0 , typename T1 >
EIGEN_STRONG_INLINE Matrix (const T0 &x, const T1 &y)
EIGEN_STRONG_INLINE Matrix (const Scalar &x, const Scalar &y, const Scalar &z)
 Constructs an initialized 3D vector with given coefficients.
template<typename OtherDerived >
 Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 Constructs a Dim x Dim rotation matrix from the rotation r.
 Matrix (const Scalar *data)
EIGEN_STRONG_INLINE Matrix (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w)
 Constructs an initialized 4D vector with given coefficients.
EIGEN_STRONG_INLINE Matrix ()
 Default constructor.
 Matrix (internal::constructor_without_unaligned_array_assert)
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.
EIGEN_STRONG_INLINE Matrix (Index dim)
 Constructs a vector or row-vector with given dimension. .
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrix (const EigenBase< OtherDerived > &other)
 Copy constructor for generic expressions.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrixoperator= (const MatrixBase< OtherDerived > &other)
 Copies the value of the expression other into *this with automatic resizing.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrixoperator= (const ReturnByValue< OtherDerived > &func)
EIGEN_STRONG_INLINE Matrixoperator= (const Matrix &other)
 Assigns matrices to each other.
template<typename OtherDerived >
Matrixoperator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
 Set a Dim x Dim rotation matrix from the rotation r.
template<typename OtherDerived >
EIGEN_STRONG_INLINE Matrixoperator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this.
Index outerStride () const
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const
EIGEN_STRONG_INLINE PacketScalar packet (Index row, Index col) const
EIGEN_STRONG_INLINE void resize (Index rows, Index cols)
void resize (Index size)
void resize (Index rows, NoChange_t)
void resize (NoChange_t, Index cols)
EIGEN_STRONG_INLINE void resizeLike (const EigenBase< OtherDerived > &_other)
EIGEN_STRONG_INLINE Index rows () const
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setConstant (Index rows, Index cols, const Scalar &value)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setConstant (Index size, const Scalar &value)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setOnes (Index rows, Index cols)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setOnes (Index size)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setRandom (Index rows, Index cols)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setRandom (Index size)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setZero (Index rows, Index cols)
Matrix< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
setZero (Index size)
template<typename OtherDerived >
void swap (MatrixBase< OtherDerived > const &other)
 Override MatrixBase::swap() since for dynamic-sized matrices of same type it is enough to swap the data pointers.
EIGEN_STRONG_INLINE void writePacket (Index index, const PacketScalar &x)
EIGEN_STRONG_INLINE void writePacket (Index row, Index col, const PacketScalar &x)

Static Public Member Functions

static EIGEN_STRONG_INLINE void _check_template_params ()
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.

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 _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)
EIGEN_STRONG_INLINE void _resize_to_match (const EigenBase< OtherDerived > &other)
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.
EIGEN_STRONG_INLINE Matrix
< _Scalar, _Rows, _Cols,
_Options, _MaxRows, _MaxCols > & 
_set_noalias (const DenseBase< OtherDerived > &other)
EIGEN_STRONG_INLINE void _set_selector (const OtherDerived &other, const internal::false_type &)
EIGEN_STRONG_INLINE void _set_selector (const OtherDerived &other, const internal::true_type &)
void _swap (DenseBase< OtherDerived > const &other)

Protected Attributes

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

Friends

class Eigen::Map
class Eigen::Map< const Derived, Aligned >
class Eigen::Map< const Derived, Unaligned >
class Eigen::Map< Derived, Aligned >
class Eigen::Map< Derived, Unaligned >
struct internal::conservative_resize_like_impl
struct internal::matrix_swap_impl

Detailed Description

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
class 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 sclar 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:
_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.
_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:

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 Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_MATRIX_PLUGIN.

Some notes:

Dense versus sparse:

This Matrix class handles dense, not sparse matrices and vectors. For sparse matrices and vectors, see the Sparse module.

Dense matrices and vectors are plain usual arrays of coefficients. All the coefficients are stored, in an ordinary contiguous array. This is unlike Sparse matrices and vectors where the coefficients are stored as a list of nonzero coefficients.

Fixed-size versus dynamic-size:

Fixed-size means that the numbers of rows and columns are known are compile-time. In this case, Eigen allocates the array of coefficients as a fixed-size array, as a class member. This makes sense for very small matrices, typically up to 4x4, sometimes up to 16x16. Larger matrices should be declared as dynamic-size even if one happens to know their size at compile-time.

Dynamic-size means that the numbers of rows or columns are not necessarily known at compile-time. In this case they are runtime variables, and the array of coefficients is allocated dynamically on the heap.

Note that dense matrices, be they Fixed-size or Dynamic-size, do not expand dynamically in the sense of a std::map. If you want this behavior, see the Sparse module.

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

Definition at line 140 of file Matrix.h.


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

Generated by  Doxygen 1.6.0   Back to index