The matrix class, also used for vectors and row-vectors. More...
#include <Matrix.h>
Public Types | |
typedef PlainObjectBase< Matrix > | Base |
Base class typedef. |
Public Member Functions | |
ArrayWrapper< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | array () |
const CwiseBinaryOp < CustomBinaryOp, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const OtherDerived > | binaryExpr (const Eigen::MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | block (Index startRow, Index startCol, Index blockRows, Index blockCols) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | block (Index startRow, Index startCol, Index blockRows, Index blockCols) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, BlockRows, BlockCols > | block (Index startRow, Index startCol) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , BlockRows, BlockCols > | block (Index startRow, Index startCol) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | bottomLeftCorner (Index cRows, Index cCols) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | bottomLeftCorner (Index cRows, Index cCols) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, CRows, CCols > | bottomLeftCorner () |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , CRows, CCols > | bottomLeftCorner () const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | bottomRightCorner (Index cRows, Index cCols) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | bottomRightCorner (Index cRows, Index cCols) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, CRows, CCols > | bottomRightCorner () |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , CRows, CCols > | bottomRightCorner () const |
RowsBlockXpr | bottomRows (Index n) |
ConstRowsBlockXpr | bottomRows (Index n) const |
NRowsBlockXpr< N >::Type | bottomRows () |
ConstNRowsBlockXpr< N >::Type | bottomRows () const |
internal::cast_return_type < Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, const CwiseUnaryOp < internal::scalar_cast_op < typename internal::traits < Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar, NewType > , const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > >::type | cast () const |
ColXpr | col (Index i) |
ConstColXpr | col (Index i) const |
ConjugateReturnType | conjugate () const |
void | conservativeResize (Index rows, Index cols) |
void | conservativeResize (Index rows, NoChange_t) |
void | conservativeResize (NoChange_t, Index cols) |
void | conservativeResize (Index size) |
void | conservativeResizeLike (const DenseBase< OtherDerived > &other) |
const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | cwiseAbs () const |
const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | cwiseAbs2 () const |
const CwiseBinaryOp < std::equal_to< Scalar > , const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, const OtherDerived > | cwiseEqual (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseUnaryOp < std::binder1st < std::equal_to< Scalar > >, const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | cwiseEqual (const Scalar &s) const |
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | cwiseInverse () const |
const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const OtherDerived > | cwiseMax (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const ConstantReturnType > | cwiseMax (const Scalar &other) const |
const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const OtherDerived > | cwiseMin (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const ConstantReturnType > | cwiseMin (const Scalar &other) const |
const CwiseBinaryOp < std::not_equal_to< Scalar > , const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, const OtherDerived > | cwiseNotEqual (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , const OtherDerived > | cwiseQuotient (const Eigen::MatrixBase< OtherDerived > &other) const |
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | cwiseSqrt () const |
const Scalar * | data () const |
Scalar * | data () |
Index | diagonalSize () const |
const | EIGEN_CWISE_PRODUCT_RETURN_TYPE (Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, OtherDerived) cwiseProduct(const Eigen |
EvalReturnType | eval () const |
const ImagReturnType | imag () const |
NonConstImagReturnType | imag () |
Index | innerSize () const |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | lazyAssign (const DenseBase< OtherDerived > &other) |
ColsBlockXpr | leftCols (Index n) |
ConstColsBlockXpr | leftCols (Index n) const |
NColsBlockXpr< N >::Type | leftCols () |
ConstNColsBlockXpr< N >::Type | leftCols () const |
Matrix () | |
Default constructor. | |
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. | |
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. | |
template<typename OtherDerived > | |
Matrix (const MatrixBase< OtherDerived > &other) | |
Constructor copying the value of the expression other. | |
Matrix (const Matrix &other) | |
Copy constructor. | |
template<typename OtherDerived > | |
Matrix (const ReturnByValue< OtherDerived > &other) | |
Copy constructor with in-place evaluation. | |
template<typename OtherDerived > | |
Matrix (const EigenBase< OtherDerived > &other) | |
Copy constructor for generic expressions. | |
template<typename OtherDerived > | |
Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r) | |
Constructs a Dim x Dim rotation matrix from the rotation r. | |
ColsBlockXpr | middleCols (Index startCol, Index numCols) |
ConstColsBlockXpr | middleCols (Index startCol, Index numCols) const |
NColsBlockXpr< N >::Type | middleCols (Index startCol) |
ConstNColsBlockXpr< N >::Type | middleCols (Index startCol) const |
RowsBlockXpr | middleRows (Index startRow, Index numRows) |
ConstRowsBlockXpr | middleRows (Index startRow, Index numRows) const |
NRowsBlockXpr< N >::Type | middleRows (Index startRow) |
ConstNRowsBlockXpr< N >::Type | middleRows (Index startRow) const |
Index | nonZeros () const |
bool | operator!= (const MatrixBase< OtherDerived > &other) const |
const ScalarMultipleReturnType | operator* (const Scalar &scalar) const |
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | operator* (const std::complex< Scalar > &scalar) const |
const CwiseUnaryOp < internal::scalar_opposite_op < typename internal::traits < Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar >, const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | operator- () const |
const CwiseUnaryOp < internal::scalar_quotient1_op < typename internal::traits < Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar >, const Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | operator/ (const Scalar &scalar) const |
Matrix & | operator= (const Matrix &other) |
Assigns matrices to each other. | |
template<typename OtherDerived > | |
Matrix & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. | |
template<typename OtherDerived > | |
Matrix & | operator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r) |
Set a Dim x Dim rotation matrix from the rotation r. | |
bool | operator== (const MatrixBase< OtherDerived > &other) const |
Index | outerSize () const |
RealReturnType | real () const |
NonConstRealReturnType | real () |
void | resize (Index rows, Index cols) |
void | resize (Index size) |
void | resize (NoChange_t, Index cols) |
void | resize (Index rows, NoChange_t) |
void | resizeLike (const EigenBase< OtherDerived > &_other) |
ColsBlockXpr | rightCols (Index n) |
ConstColsBlockXpr | rightCols (Index n) const |
NColsBlockXpr< N >::Type | rightCols () |
ConstNColsBlockXpr< N >::Type | rightCols () const |
RowXpr | row (Index i) |
ConstRowXpr | row (Index i) const |
void | swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase) |
void | swap (PlainObjectBase< OtherDerived > &other) |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | topLeftCorner (Index cRows, Index cCols) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | topLeftCorner (Index cRows, Index cCols) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, CRows, CCols > | topLeftCorner () |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , CRows, CCols > | topLeftCorner () const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | topRightCorner (Index cRows, Index cCols) |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | topRightCorner (Index cRows, Index cCols) const |
Block< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, CRows, CCols > | topRightCorner () |
const Block< const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > , CRows, CCols > | topRightCorner () const |
RowsBlockXpr | topRows (Index n) |
ConstRowsBlockXpr | topRows (Index n) const |
NRowsBlockXpr< N >::Type | topRows () |
ConstNRowsBlockXpr< N >::Type | topRows () const |
const CwiseUnaryOp < CustomUnaryOp, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const |
Apply a unary operator coefficient-wise. | |
const CwiseUnaryView < CustomViewOp, const Matrix < _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > > | unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const |
CoeffReturnType | value () const |
Static Public Member Functions | |
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 | |
Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | _set (const DenseBase< OtherDerived > &other) |
Copies the value of the expression other into *this with automatic resizing. |
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:
_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.
_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:
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:
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 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.
typedef PlainObjectBase<Matrix> Base |
Base class typedef.
|
inlineexplicit |
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.
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.
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.
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.
Copy constructor for generic expressions.
|
explicit |
Constructs a Dim x Dim rotation matrix from the rotation r.
This is defined in the Geometry module.
References RotationBase< Derived, _Dim >::toRotationMatrix().
|
inlineprotectedinherited |
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.
|
inlineinherited |
|
inlineinherited |
*this
and other *this
and other The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)
Here is an example illustrating the use of custom functors:
Output:
(0.68,0.271) (0.823,-0.967) (-0.444,-0.687) (-0.27,0.998) (-0.211,0.435) (-0.605,-0.514) (0.108,-0.198) (0.0268,-0.563) (0.566,-0.717) (-0.33,-0.726) (-0.0452,-0.74) (0.904,0.0259) (0.597,0.214) (0.536,0.608) (0.258,-0.782) (0.832,0.678)
|
inlineinherited |
startRow | the first row in the block |
startCol | the first column in the block |
blockRows | the number of rows in the block |
blockCols | the number of columns in the block |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.block(1, 1, 2, 2): -6 1 -3 0 Now the matrix m is: 7 9 -5 -3 -2 0 0 0 6 0 0 9 6 6 3 9
|
inlineinherited |
This is the const version of block(Index,Index,Index,Index).
|
inlineinherited |
The template parameters BlockRows and BlockCols are the number of rows and columns in the block.
startRow | the first row in the block |
startCol | the first column in the block |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.block<2,2>(1,1): -6 1 -3 0 Now the matrix m is: 7 9 -5 -3 -2 0 0 0 6 0 0 9 6 6 3 9
|
inlineinherited |
This is the const version of block<>(Index, Index).
|
inlineinherited |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomLeftCorner(2, 2): 6 -3 6 6 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 0 0 0 9 0 0 3 9
|
inlineinherited |
This is the const version of bottomLeftCorner(Index, Index).
|
inlineinherited |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomLeftCorner<2,2>(): 6 -3 6 6 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 0 0 0 9 0 0 3 9
|
inlineinherited |
This is the const version of bottomLeftCorner<int, int>().
|
inlineinherited |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomRightCorner(2, 2): 0 9 3 9 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 6 -3 0 0 6 6 0 0
|
inlineinherited |
This is the const version of bottomRightCorner(Index, Index).
|
inlineinherited |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.bottomRightCorner<2,2>(): 0 9 3 9 Now the matrix m is: 7 9 -5 -3 -2 -6 1 0 6 -3 0 0 6 6 0 0
|
inlineinherited |
This is the const version of bottomRightCorner<int, int>().
|
inlineinherited |
n | the number of rows in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.bottomRows(2): 6 -3 0 9 6 6 3 9 Now the array a is: 7 9 -5 -3 -2 -6 1 0 0 0 0 0 0 0 0 0
|
inlineinherited |
This is the const version of bottomRows(Index).
|
inlineinherited |
N | the number of rows in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.bottomRows<2>(): 6 -3 0 9 6 6 3 9 Now the array a is: 7 9 -5 -3 -2 -6 1 0 0 0 0 0 0 0 0 0
|
inlineinherited |
This is the const version of bottomRows<int>().
|
inlineinherited |
The template parameter NewScalar is the type we are casting the scalars to.
|
inlineinherited |
|
inlineinherited |
This is the const version of col().
|
inlineinherited |
*this
.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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
Resizes the vector to size while retaining old values.
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 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.
|
inlineinherited |
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
.
|
inlineinherited |
*this
Example:
Output:
2 4 6 5 1 0
|
inlineinherited |
*this
Example:
Output:
4 16 36 25 1 0
|
inlineinherited |
Example:
Output:
Comparing m with identity matrix: 1 1 0 1 Number of coefficients that are equal: 3
|
inlineinherited |
*this
and a scalar s
|
inlineinherited |
Example:
Output:
0.5 2 1 0.333 4 1
|
inlineinherited |
Example:
Output:
4 3 4
|
inlineinherited |
|
inlineinherited |
Example:
Output:
2 2 3
|
inlineinherited |
|
inlineinherited |
Example:
Output:
Comparing m with identity matrix: 0 0 1 0 Number of coefficients that are not equal: 1
|
inlineinherited |
Example:
Output:
0.5 1.5 1.33
|
inlineinherited |
Example:
Output:
1 1.41 2
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Example:
Output:
a: 7 6 -3 -2 9 6 6 -6 -5 b: 1 -3 9 0 0 3 3 9 5 c: 7 -18 -27 0 0 18 18 -54 -25
|
inlineinherited |
Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.
|
inlineinherited |
*this
.
|
inlineinherited |
*this
.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
n | the number of columns in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.leftCols(2): 7 9 -2 -6 6 -3 6 6 Now the array a is: 0 0 -5 -3 0 0 1 0 0 0 0 9 0 0 3 9
|
inlineinherited |
This is the const version of leftCols(Index).
|
inlineinherited |
N | the number of columns in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.leftCols<2>(): 7 9 -2 -6 6 -3 6 6 Now the array a is: 0 0 -5 -3 0 0 1 0 0 0 0 9 0 0 3 9
|
inlineinherited |
This is the const version of leftCols<int>().
startCol | the index of the first column in the block |
numCols | the number of columns in the block |
Example:
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(1..3,:) = -6 0 9 -3 3 3 6 -3 5 -5 0 -8 1 9 2
This is the const version of middleCols(Index,Index).
|
inlineinherited |
N | the number of columns in the block |
startCol | the index of the first column in the block |
Example:
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(:,1..3) = -6 0 9 -3 3 3 6 -3 5 -5 0 -8 1 9 2
|
inlineinherited |
This is the const version of middleCols<int>().
startRow | the index of the first row in the block |
numRows | the number of rows in the block |
Example:
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(2..3,:) = 6 6 -3 5 -8 6 -5 0 -8 6
This is the const version of middleRows(Index,Index).
|
inlineinherited |
N | the number of rows in the block |
startRow | the index of the first row in the block |
Example:
Output:
A = 7 -6 0 9 -10 -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6 9 1 9 2 -7 A(1..3,:) = -2 -3 3 3 -5 6 6 -3 5 -8 6 -5 0 -8 6
|
inlineinherited |
This is the const version of middleRows<int>().
|
inlineinherited |
|
inlineinherited |
*this
and other are not exactly equal to each other.
|
inlineinherited |
*this
scaled by the scalar factor scalar
|
inlineinherited |
Overloaded for efficient real matrix times complex scalar value
|
inlineinherited |
*this
|
inlineinherited |
*this
divided by the scalar value scalar
|
inline |
Assigns matrices to each other.
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
Reimplemented from PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.
Matrix< _Scalar, _Rows, _Cols, _Storage, _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.
References RotationBase< Derived, _Dim >::toRotationMatrix().
|
inlineinherited |
*this
and other are all exactly equal.
|
inlineinherited |
|
inlineinherited |
*this
.
|
inlineinherited |
*this
.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:
here's the 2x3 matrix m: 1 2 3 4 5 6 let's resize m to 3x2. This is a conservative resizing because 2*3==3*2. here's the 3x2 matrix m: 1 5 4 3 2 6 now let's resize m to size 2x2. This is NOT a conservative resizing, so it becomes uninitialized: 2.32e-310 2.12e-314 4.94e-324 4.94e-323
Reimplemented from DenseBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.
|
inlineinherited |
Resizes *this
to a vector of length size
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 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:
v: 3 rows, 1 cols w: 1 rows, 3 cols
Reimplemented from DenseBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.
|
inlineinherited |
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:
m: 3 rows, 5 cols
|
inlineinherited |
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:
m: 5 rows, 4 cols
|
inlineinherited |
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.
|
inlineinherited |
n | the number of columns in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.rightCols(2): -5 -3 1 0 0 9 3 9 Now the array a is: 7 9 0 0 -2 -6 0 0 6 -3 0 0 6 6 0 0
|
inlineinherited |
This is the const version of rightCols(Index).
|
inlineinherited |
N | the number of columns in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.rightCols<2>(): -5 -3 1 0 0 9 3 9 Now the array a is: 7 9 0 0 -2 -6 0 0 6 -3 0 0 6 6 0 0
|
inlineinherited |
This is the const version of rightCols<int>().
|
inlineinherited |
|
inlineinherited |
This is the const version of row().
|
inlineinherited |
swaps *this with the expression other.
|
inlineinherited |
swaps *this with the matrix or array other.
|
inlineinherited |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topLeftCorner(2, 2): 7 9 -2 -6 Now the matrix m is: 0 0 -5 -3 0 0 1 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topLeftCorner(Index, Index).
|
inlineinherited |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topLeftCorner<2,2>(): 7 9 -2 -6 Now the matrix m is: 0 0 -5 -3 0 0 1 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topLeftCorner<int, int>().
|
inlineinherited |
cRows | the number of rows in the corner |
cCols | the number of columns in the corner |
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topRightCorner(2, 2): -5 -3 1 0 Now the matrix m is: 7 9 0 0 -2 -6 0 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topRightCorner(Index, Index).
|
inlineinherited |
The template parameters CRows and CCols are the number of rows and columns in the corner.
Example:
Output:
Here is the matrix m: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is m.topRightCorner<2,2>(): -5 -3 1 0 Now the matrix m is: 7 9 0 0 -2 -6 0 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topRightCorner<int, int>().
|
inlineinherited |
n | the number of rows in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.topRows(2): 7 9 -5 -3 -2 -6 1 0 Now the array a is: 0 0 0 0 0 0 0 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topRows(Index).
|
inlineinherited |
N | the number of rows in the block |
Example:
Output:
Here is the array a: 7 9 -5 -3 -2 -6 1 0 6 -3 0 9 6 6 3 9 Here is a.topRows<2>(): 7 9 -5 -3 -2 -6 1 0 Now the array a is: 0 0 0 0 0 0 0 0 6 -3 0 9 6 6 3 9
|
inlineinherited |
This is the const version of topRows<int>().
|
inlineinherited |
Apply a unary operator coefficient-wise.
[in] | func | Functor implementing the unary operator |
CustomUnaryOp | Type of func |
The function ptr_fun()
from the C++ standard library can be used to make functors out of normal functions.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.68 0.823 0 0 0 0 0.108 0.0268 0.566 0 0 0.904 0.597 0.536 0.258 0.832
Genuine functors allow for more possibilities, for instance it may contain a state.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.5 0.5 -0.444 -0.27 -0.211 -0.5 0.108 0.0268 0.5 -0.33 -0.0452 0.5 0.5 0.5 0.258 0.5
|
inlineinherited |
The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.
Example:
Output:
0.68 0.823 -0.444 -0.27 -0.211 -0.605 0.108 0.0268 0.566 -0.33 -0.0452 0.904 0.597 0.536 0.258 0.832 becomes: 0.5 0.5 -0.444 -0.27 -0.211 -0.5 0.108 0.0268 0.5 -0.33 -0.0452 0.5 0.5 0.5 0.258 0.5
|
inlineinherited |