The matrix class, also used for vectors and row-vectors. More...
Public Types | |
enum | { Options } |
typedef PlainObjectBase< Matrix > | Base |
Base class typedef. More... | |
typedef Base::PlainObject | PlainObject |
Public Types inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > > | |
enum | |
enum | |
typedef Eigen::Map< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, AlignedMax > | AlignedMapType |
typedef internal::dense_xpr_base< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >::type | Base |
typedef const Eigen::Map< const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, AlignedMax > | 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 Eigen::Map< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >, Unaligned > | MapType |
typedef internal::packet_traits< Scalar >::type | PacketScalar |
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 Types inherited from Eigen::MatrixBase< Derived > | |
enum | { HomogeneousReturnTypeDirection } |
enum | { SizeMinusOne } |
typedef Diagonal< const Derived > | ConstDiagonalReturnType |
typedef Block< const Derived, internal::traits< Derived >::ColsAtCompileTime==1 ? SizeMinusOne :1, internal::traits< Derived >::ColsAtCompileTime==1 ? 1 :SizeMinusOne > | ConstStartMinusOne |
typedef Diagonal< Derived > | DiagonalReturnType |
typedef Homogeneous< Derived, HomogeneousReturnTypeDirection > | HomogeneousReturnType |
typedef Base::PlainObject | PlainObject |
typedef internal::stem_function< Scalar >::type | StemFunction |
Public Types inherited from Eigen::DenseBase< Derived > | |
enum | { RowsAtCompileTime , ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime , NumDimensions , Flags , IsRowMajor , InnerSizeAtCompileTime , InnerStrideAtCompileTime , OuterStrideAtCompileTime } |
enum | { IsPlainObjectBase } |
typedef DenseCoeffsBase< Derived, internal::accessors_level< Derived >::value > | Base |
typedef Base::CoeffReturnType | CoeffReturnType |
typedef VectorwiseOp< Derived, Vertical > | ColwiseReturnType |
typedef random_access_iterator_type | const_iterator |
typedef const VectorwiseOp< const Derived, Vertical > | ConstColwiseReturnType |
typedef const Reverse< const Derived, BothDirections > | ConstReverseReturnType |
typedef const VectorwiseOp< const Derived, Horizontal > | ConstRowwiseReturnType |
typedef Transpose< const Derived > | ConstTransposeReturnType |
typedef internal::add_const_on_value_type_t< typename internal::eval< Derived >::type > | EvalReturnType |
typedef random_access_iterator_type | iterator |
typedef internal::find_best_packet< Scalar, SizeAtCompileTime >::type | PacketScalar |
typedef Array< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime > | PlainArray |
typedef Matrix< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime > | PlainMatrix |
typedef std::conditional_t< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray > | PlainObject |
The plain matrix or array type corresponding to this expression. More... | |
typedef CwiseNullaryOp< internal::scalar_random_op< Scalar >, PlainObject > | RandomReturnType |
typedef NumTraits< Scalar >::Real | RealScalar |
typedef Reverse< Derived, BothDirections > | ReverseReturnType |
typedef VectorwiseOp< Derived, Horizontal > | RowwiseReturnType |
typedef internal::traits< Derived >::Scalar | Scalar |
typedef internal::traits< Derived >::StorageIndex | StorageIndex |
The type used to store indices. More... | |
typedef internal::traits< Derived >::StorageKind | StorageKind |
typedef Transpose< Derived > | TransposeReturnType |
typedef Scalar | value_type |
Public Types inherited from Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors > | |
typedef DenseCoeffsBase< Derived, WriteAccessors > | Base |
typedef NumTraits< Scalar >::Real | RealScalar |
typedef internal::traits< Derived >::Scalar | Scalar |
Public Types inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors > | |
typedef DenseCoeffsBase< Derived, ReadOnlyAccessors > | Base |
typedef internal::packet_traits< Scalar >::type | PacketScalar |
typedef NumTraits< Scalar >::Real | RealScalar |
typedef internal::traits< Derived >::Scalar | Scalar |
typedef internal::traits< Derived >::StorageKind | StorageKind |
Public Types inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > | |
typedef EigenBase< Derived > | Base |
typedef std::conditional_t< bool(internal::traits< Derived >::Flags &LvalueBit), const Scalar &, std::conditional_t< internal::is_arithmetic< Scalar >::value, Scalar, const Scalar > > | CoeffReturnType |
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type | PacketReturnType |
typedef internal::packet_traits< Scalar >::type | PacketScalar |
typedef internal::traits< Derived >::Scalar | Scalar |
typedef internal::traits< Derived >::StorageKind | StorageKind |
Public Types inherited from Eigen::EigenBase< Derived > | |
typedef Eigen::Index | Index |
The interface type of indices. More... | |
typedef internal::traits< Derived >::StorageKind | StorageKind |
Public Member Functions | |
EIGEN_CONSTEXPR Index | innerStride () const EIGEN_NOEXCEPT |
Matrix () | |
Default constructor. More... | |
template<typename OtherDerived > | |
Matrix (const EigenBase< OtherDerived > &other) | |
Copy constructor for generic expressions. More... | |
Matrix (const Matrix &other) | |
Copy constructor. More... | |
template<typename OtherDerived > | |
Matrix (const RotationBase< OtherDerived, ColsAtCompileTime > &r) | |
Constructs a Dim x Dim rotation matrix from the rotation r. More... | |
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. More... | |
Matrix (const Scalar &x, const Scalar &y) | |
Constructs an initialized 2D vector with given coefficients. More... | |
Matrix (const Scalar &x, const Scalar &y, const Scalar &z) | |
Constructs an initialized 3D vector with given coefficients. More... | |
Matrix (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w) | |
Constructs an initialized 4D vector with given coefficients. More... | |
Matrix (const Scalar *data) | |
Constructs a fixed-sized matrix initialized with coefficients starting at data. More... | |
constexpr | 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] More... | |
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. More... | |
Matrix (Index rows, Index cols) | |
Constructs an uninitialized matrix with rows rows and cols columns. More... | |
Matrix (internal::constructor_without_unaligned_array_assert) | |
Matrix (Matrix &&other) EIGEN_NOEXCEPT_IF(std | |
template<typename OtherDerived > | |
Matrix & | operator= (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Matrix & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
Matrix & | operator= (const Matrix &other) |
Assigns matrices to each other. More... | |
template<typename OtherDerived > | |
Matrix & | operator= (const ReturnByValue< OtherDerived > &func) |
template<typename OtherDerived > | |
Matrix & | operator= (const RotationBase< OtherDerived, ColsAtCompileTime > &r) |
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. More... | |
Matrix & | operator= (Matrix &&other) EIGEN_NOEXCEPT_IF(std |
EIGEN_CONSTEXPR Index | outerStride () const EIGEN_NOEXCEPT |
Public Member Functions inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > > | |
const Base & | base () const |
const Scalar & | coeff (Index index) const |
constexpr const Scalar & | coeff (Index rowId, Index colId) const |
constexpr Scalar & | coeffRef (Index index) |
constexpr const Scalar & | coeffRef (Index index) const |
constexpr Scalar & | coeffRef (Index rowId, Index colId) |
constexpr const Scalar & | coeffRef (Index rowId, Index colId) const |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
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 |
EIGEN_STATIC_ASSERT (internal::check_implication(MaxRowsAtCompileTime==1 &&MaxColsAtCompileTime!=1,(int(Options)&RowMajor)==RowMajor), INVALID_MATRIX_TEMPLATE_PARAMETERS) EIGEN_STATIC_ASSERT(internal | |
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. More... | |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | operator= (const PlainObjectBase &other) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | operator= (const ReturnByValue< OtherDerived > &func) |
PacketScalar | packet (Index index) const |
PacketScalar | packet (Index rowId, Index colId) const |
constexpr void | resize (Index rows, Index cols) |
constexpr void | resize (Index rows, NoChange_t) |
constexpr void | resize (Index size) |
constexpr void | resize (NoChange_t, Index cols) |
void | resizeLike (const EigenBase< OtherDerived > &_other) |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setConstant (Index rows, 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_ > & | setConstant (Index size, 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_ > & | setOnes (Index rows, Index cols) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setOnes (Index rows, NoChange_t) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setOnes (Index size) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setOnes (NoChange_t, Index cols) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setRandom (Index rows, Index cols) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setRandom (Index rows, NoChange_t) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setRandom (Index size) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setRandom (NoChange_t, Index cols) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setZero (Index rows, Index cols) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setZero (Index rows, NoChange_t) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setZero (Index size) |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | setZero (NoChange_t, Index cols) |
void | writePacket (Index index, const PacketScalar &val) |
void | writePacket (Index rowId, Index colId, const PacketScalar &val) |
Public Member Functions inherited from Eigen::MatrixBase< Derived > | |
const MatrixFunctionReturnValue< Derived > | acosh () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise inverse hyperbolic cosine use ArrayBase::acosh . More... | |
const AdjointReturnType | adjoint () const |
void | adjointInPlace () |
template<typename EssentialPart > | |
void | applyHouseholderOnTheLeft (const EssentialPart &essential, const Scalar &tau, Scalar *workspace) |
template<typename EssentialPart > | |
void | applyHouseholderOnTheRight (const EssentialPart &essential, const Scalar &tau, Scalar *workspace) |
template<typename OtherDerived > | |
void | applyOnTheLeft (const EigenBase< OtherDerived > &other) |
template<typename OtherScalar > | |
void | applyOnTheLeft (Index p, Index q, const JacobiRotation< OtherScalar > &j) |
template<typename OtherDerived > | |
void | applyOnTheRight (const EigenBase< OtherDerived > &other) |
template<typename OtherScalar > | |
void | applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j) |
ArrayWrapper< Derived > | array () |
const ArrayWrapper< const Derived > | array () const |
const DiagonalWrapper< const Derived > | asDiagonal () const |
const MatrixFunctionReturnValue< Derived > | asinh () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise inverse hyperbolic sine use ArrayBase::asinh . More... | |
const PermutationWrapper< const Derived > | asPermutation () const |
const SkewSymmetricWrapper< const Derived > | asSkewSymmetric () const |
const MatrixFunctionReturnValue< Derived > | atanh () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise inverse hyperbolic cosine use ArrayBase::atanh . More... | |
template<int Options = 0> | |
BDCSVD< PlainObject, Options > | bdcSvd () const |
template<int Options> | |
BDCSVD< typename MatrixBase< Derived >::PlainObject, Options > | bdcSvd () const |
template<int Options = 0> | |
EIGEN_DEPRECATED BDCSVD< PlainObject, Options > | bdcSvd (unsigned int computationOptions) const |
template<int Options> | |
BDCSVD< typename MatrixBase< Derived >::PlainObject, Options > | bdcSvd (unsigned int computationOptions) const |
RealScalar | blueNorm () const |
Matrix< Scalar, 3, 1 > | canonicalEulerAngles (Index a0, Index a1, Index a2) const |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const ColPivHouseholderQR< PlainObject, PermutationIndex > | colPivHouseholderQr () const |
template<typename PermutationIndexType > | |
const ColPivHouseholderQR< typename MatrixBase< Derived >::PlainObject, PermutationIndexType > | colPivHouseholderQr () const |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const CompleteOrthogonalDecomposition< PlainObject, PermutationIndex > | completeOrthogonalDecomposition () const |
template<typename PermutationIndex > | |
const CompleteOrthogonalDecomposition< typename MatrixBase< Derived >::PlainObject, PermutationIndex > | completeOrthogonalDecomposition () const |
template<typename ResultType > | |
void | computeInverseAndDetWithCheck (ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const |
template<typename ResultType > | |
void | computeInverseWithCheck (ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const |
const MatrixFunctionReturnValue< Derived > | cos () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise cosine use ArrayBase::cos . More... | |
const MatrixFunctionReturnValue< Derived > | cosh () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic cosine use ArrayBase::cosh . More... | |
template<typename OtherDerived > | |
internal::cross_impl< Derived, OtherDerived >::return_type | cross (const MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
std::conditional_t< SizeAtCompileTime==2, Scalar, PlainObject > | cross (const MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
PlainObject | cross3 (const MatrixBase< OtherDerived > &other) const |
template<typename OtherDerived > | |
const SparseMatrixBase< OtherDerived >::template CwiseProductDenseReturnType< Derived >::Type | cwiseProduct (const SparseMatrixBase< OtherDerived > &other) const |
Scalar | determinant () const |
DiagonalReturnType | diagonal () |
template<int Index> | |
Diagonal< Derived, Index > | diagonal () |
const ConstDiagonalReturnType | diagonal () const |
template<int Index> | |
const Diagonal< const Derived, Index > | diagonal () const |
Diagonal< Derived, DynamicIndex > | diagonal (Index index) |
const Diagonal< const Derived, DynamicIndex > | diagonal (Index index) const |
Index | diagonalSize () const |
template<typename OtherDerived > | |
ScalarBinaryOpTraits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType | dot (const MatrixBase< OtherDerived > &other) const |
typedef | EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE (ConstStartMinusOne, Scalar, quotient) HNormalizedReturnType |
EigenvaluesReturnType | eigenvalues () const |
Computes the eigenvalues of a matrix. More... | |
EIGEN_DEPRECATED Matrix< Scalar, 3, 1 > | eulerAngles (Index a0, Index a1, Index a2) const |
const MatrixExponentialReturnValue< Derived > | exp () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise exponential use ArrayBase::exp . More... | |
Derived & | forceAlignedAccess () |
const Derived & | forceAlignedAccess () const |
template<bool Enable> | |
std::conditional_t< Enable, ForceAlignedAccess< Derived >, Derived & > | forceAlignedAccessIf () |
template<bool Enable> | |
Derived & | forceAlignedAccessIf () |
template<bool Enable> | |
add_const_on_value_type_t< std::conditional_t< Enable, ForceAlignedAccess< Derived >, Derived & > > | forceAlignedAccessIf () const |
template<bool Enable> | |
const Derived & | forceAlignedAccessIf () const |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const FullPivHouseholderQR< PlainObject, PermutationIndex > | fullPivHouseholderQr () const |
template<typename PermutationIndex > | |
const FullPivHouseholderQR< typename MatrixBase< Derived >::PlainObject, PermutationIndex > | fullPivHouseholderQr () const |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const FullPivLU< PlainObject, PermutationIndex > | fullPivLu () const |
template<typename PermutationIndex > | |
const FullPivLU< typename MatrixBase< Derived >::PlainObject, PermutationIndex > | fullPivLu () const |
const HNormalizedReturnType | hnormalized () const |
homogeneous normalization More... | |
HomogeneousReturnType | homogeneous () const |
const HouseholderQR< PlainObject > | householderQr () const |
RealScalar | hypotNorm () const |
const Inverse< Derived > | inverse () const |
bool | isDiagonal (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isIdentity (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isLowerTriangular (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<typename OtherDerived > | |
bool | isOrthogonal (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isSkewSymmetric (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isUnitary (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isUpperTriangular (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<int Options = 0> | |
JacobiSVD< PlainObject, Options > | jacobiSvd () const |
template<int Options> | |
JacobiSVD< typename MatrixBase< Derived >::PlainObject, Options > | jacobiSvd () const |
template<int Options = 0> | |
EIGEN_DEPRECATED JacobiSVD< PlainObject, Options > | jacobiSvd (unsigned int computationOptions) const |
template<int Options> | |
JacobiSVD< typename MatrixBase< Derived >::PlainObject, Options > | jacobiSvd (unsigned int computationOptions) const |
template<typename OtherDerived > | |
const Product< Derived, OtherDerived, LazyProduct > | lazyProduct (const MatrixBase< OtherDerived > &other) const |
const LDLT< PlainObject > | ldlt () const |
const LLT< PlainObject > | llt () const |
const MatrixLogarithmReturnValue< Derived > | log () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise logarithm use ArrayBase::log . More... | |
template<int p> | |
RealScalar | lpNorm () const |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const PartialPivLU< PlainObject, PermutationIndex > | lu () const |
template<typename PermutationIndex > | |
const PartialPivLU< typename MatrixBase< Derived >::PlainObject, PermutationIndex > | lu () const |
template<typename EssentialPart > | |
void | makeHouseholder (EssentialPart &essential, Scalar &tau, RealScalar &beta) const |
void | makeHouseholderInPlace (Scalar &tau, RealScalar &beta) |
MatrixBase< Derived > & | matrix () |
const MatrixBase< Derived > & | matrix () const |
const MatrixFunctionReturnValue< Derived > | matrixFunction (StemFunction f) const |
Helper function for the unsupported MatrixFunctions module. More... | |
NoAlias< Derived, Eigen::MatrixBase > | noalias () |
RealScalar | norm () const |
void | normalize () |
const PlainObject | normalized () const |
template<typename OtherDerived > | |
bool | operator!= (const MatrixBase< OtherDerived > &other) const |
template<typename DiagonalDerived > | |
const Product< Derived, DiagonalDerived, LazyProduct > | operator* (const DiagonalBase< DiagonalDerived > &diagonal) const |
template<typename OtherDerived > | |
const Product< Derived, OtherDerived > | operator* (const MatrixBase< OtherDerived > &other) const |
template<typename SkewDerived > | |
const Product< Derived, SkewDerived, LazyProduct > | operator* (const SkewSymmetricBase< SkewDerived > &skew) const |
template<typename OtherDerived > | |
Derived & | operator*= (const EigenBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator+= (const MatrixBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator-= (const MatrixBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator= (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator= (const EigenBase< OtherDerived > &other) |
Derived & | operator= (const MatrixBase &other) |
template<typename OtherDerived > | |
Derived & | operator= (const ReturnByValue< OtherDerived > &other) |
template<typename OtherDerived > | |
bool | operator== (const MatrixBase< OtherDerived > &other) const |
RealScalar | operatorNorm () const |
Computes the L2 operator norm. More... | |
template<typename PermutationIndex = DefaultPermutationIndex> | |
const PartialPivLU< PlainObject, PermutationIndex > | partialPivLu () const |
template<typename PermutationIndex > | |
const PartialPivLU< typename MatrixBase< Derived >::PlainObject, PermutationIndex > | partialPivLu () const |
const MatrixPowerReturnValue< Derived > | pow (const RealScalar &p) const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise power to p use ArrayBase::pow . More... | |
const MatrixComplexPowerReturnValue< Derived > | pow (const std::complex< RealScalar > &p) const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise power to p use ArrayBase::pow . More... | |
template<unsigned int UpLo> | |
SelfAdjointViewReturnType< UpLo >::Type | selfadjointView () |
template<unsigned int UpLo> | |
MatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type | selfadjointView () |
template<unsigned int UpLo> | |
ConstSelfAdjointViewReturnType< UpLo >::Type | selfadjointView () const |
template<unsigned int UpLo> | |
MatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type | selfadjointView () const |
Derived & | setIdentity () |
Derived & | setIdentity (Index rows, Index cols) |
Resizes to the given size, and writes the identity expression (not necessarily square) into *this. More... | |
Derived & | setUnit (Index i) |
Set the coefficients of *this to the i-th unit (basis) vector. More... | |
Derived & | setUnit (Index newSize, Index i) |
Resizes to the given newSize, and writes the i-th unit (basis) vector into *this. More... | |
const MatrixFunctionReturnValue< Derived > | sin () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise sine use ArrayBase::sin . More... | |
const MatrixFunctionReturnValue< Derived > | sinh () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic sine use ArrayBase::sinh . More... | |
const SparseView< Derived > | sparseView (const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const |
const MatrixSquareRootReturnValue< Derived > | sqrt () const |
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise square root use ArrayBase::sqrt . More... | |
RealScalar | squaredNorm () const |
RealScalar | stableNorm () const |
void | stableNormalize () |
const PlainObject | stableNormalized () const |
Scalar | trace () const |
template<unsigned int Mode> | |
TriangularViewReturnType< Mode >::Type | triangularView () |
template<unsigned int Mode> | |
MatrixBase< Derived >::template TriangularViewReturnType< Mode >::Type | triangularView () |
template<unsigned int Mode> | |
ConstTriangularViewReturnType< Mode >::Type | triangularView () const |
template<unsigned int Mode> | |
MatrixBase< Derived >::template ConstTriangularViewReturnType< Mode >::Type | triangularView () const |
PlainObject | unitOrthogonal (void) const |
Public Member Functions inherited from Eigen::DenseBase< Derived > | |
bool | all () const |
bool | allFinite () const |
bool | any () const |
iterator | begin () |
const_iterator | begin () const |
const_iterator | cbegin () const |
const_iterator | cend () const |
ColwiseReturnType | colwise () |
ConstColwiseReturnType | colwise () const |
Index | count () const |
iterator | end () |
const_iterator | end () const |
EvalReturnType | eval () const |
template<typename Dest > | |
void | evalTo (Dest &) const |
void | fill (const Scalar &value) |
template<unsigned int Added, unsigned int Removed> | |
EIGEN_DEPRECATED const Derived & | flagged () const |
ForceAlignedAccess< Derived > | forceAlignedAccess () |
const ForceAlignedAccess< Derived > | forceAlignedAccess () const |
template<bool Enable> | |
std::conditional_t< Enable, ForceAlignedAccess< Derived >, Derived & > | forceAlignedAccessIf () |
template<bool Enable> | |
const std::conditional_t< Enable, ForceAlignedAccess< Derived >, Derived & > | forceAlignedAccessIf () const |
const WithFormat< Derived > | format (const IOFormat &fmt) const |
bool | hasNaN () const |
EIGEN_CONSTEXPR Index | innerSize () const |
template<typename OtherDerived > | |
bool | isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<typename OtherDerived > | |
bool | isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<typename Derived > | |
bool | isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const |
bool | isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
bool | isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const |
template<typename OtherDerived > | |
Derived & | lazyAssign (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
EIGEN_DEPRECATED Derived & | lazyAssign (const DenseBase< OtherDerived > &other) |
template<int p> | |
RealScalar | lpNorm () const |
template<int NaNPropagation> | |
internal::traits< Derived >::Scalar | maxCoeff () const |
internal::traits< Derived >::Scalar | maxCoeff () const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *index) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *index) const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | maxCoeff (IndexType *row, IndexType *col) const |
Scalar | mean () const |
template<int NaNPropagation> | |
internal::traits< Derived >::Scalar | minCoeff () const |
internal::traits< Derived >::Scalar | minCoeff () const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *index) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *index) const |
template<int NaNPropagation, typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
template<typename IndexType > | |
internal::traits< Derived >::Scalar | minCoeff (IndexType *row, IndexType *col) const |
const NestByValue< Derived > | nestByValue () const |
Derived & | operator*= (const Scalar &other) |
template<typename OtherDerived > | |
Derived & | operator+= (const EigenBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator-= (const EigenBase< OtherDerived > &other) |
Derived & | operator/= (const Scalar &other) |
template<typename OtherDerived > | |
CommaInitializer< Derived > | operator<< (const DenseBase< OtherDerived > &other) |
CommaInitializer< Derived > | operator<< (const Scalar &s) |
Derived & | operator= (const DenseBase &other) |
template<typename OtherDerived > | |
Derived & | operator= (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Derived & | operator= (const EigenBase< OtherDerived > &other) |
Copies the generic expression other into *this. More... | |
template<typename OtherDerived > | |
Derived & | operator= (const ReturnByValue< OtherDerived > &func) |
EIGEN_CONSTEXPR Index | outerSize () const |
Scalar | prod () const |
template<typename BinaryOp > | |
Scalar | redux (const BinaryOp &func) const |
template<typename Func > | |
internal::traits< Derived >::Scalar | redux (const Func &func) const |
template<int RowFactor, int ColFactor> | |
const Replicate< Derived, RowFactor, ColFactor > | replicate () const |
const Replicate< Derived, Dynamic, Dynamic > | replicate (Index rowFactor, Index colFactor) const |
void | resize (Index newSize) |
void | resize (Index rows, Index cols) |
ReverseReturnType | reverse () |
ConstReverseReturnType | reverse () const |
void | reverseInPlace () |
RowwiseReturnType | rowwise () |
ConstRowwiseReturnType | rowwise () const |
template<typename ThenDerived , typename ElseDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ThenDerived >::Scalar, typename DenseBase< ElseDerived >::Scalar, Scalar >, ThenDerived, ElseDerived, Derived > | select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const |
template<typename ThenDerived , typename ElseDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ThenDerived >::Scalar, typename DenseBase< ElseDerived >::Scalar, typename DenseBase< Derived >::Scalar >, ThenDerived, ElseDerived, Derived > | select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const |
template<typename ThenDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ThenDerived >::Scalar, typename DenseBase< ThenDerived >::Scalar, Scalar >, ThenDerived, typename DenseBase< ThenDerived >::ConstantReturnType, Derived > | select (const DenseBase< ThenDerived > &thenMatrix, const typename DenseBase< ThenDerived >::Scalar &elseScalar) const |
template<typename ThenDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ThenDerived >::Scalar, typename DenseBase< ThenDerived >::Scalar, typename DenseBase< Derived >::Scalar >, ThenDerived, typename DenseBase< ThenDerived >::ConstantReturnType, Derived > | select (const DenseBase< ThenDerived > &thenMatrix, const typename DenseBase< ThenDerived >::Scalar &elseScalar) const |
template<typename ElseDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ElseDerived >::Scalar, typename DenseBase< ElseDerived >::Scalar, Scalar >, typename DenseBase< ElseDerived >::ConstantReturnType, ElseDerived, Derived > | select (const typename DenseBase< ElseDerived >::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const |
template<typename ElseDerived > | |
CwiseTernaryOp< internal::scalar_boolean_select_op< typename DenseBase< ElseDerived >::Scalar, typename DenseBase< ElseDerived >::Scalar, typename DenseBase< Derived >::Scalar >, typename DenseBase< ElseDerived >::ConstantReturnType, ElseDerived, Derived > | select (const typename DenseBase< ElseDerived >::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const |
Derived & | setConstant (const Scalar &value) |
Derived & | setEqualSpaced (const Scalar &low, const Scalar &step) |
Derived & | setEqualSpaced (Index size, const Scalar &low, const Scalar &step) |
Derived & | setLinSpaced (const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
Derived & | setLinSpaced (Index size, const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
Derived & | setOnes () |
Derived & | setRandom () |
Derived & | setZero () |
Scalar | sum () const |
template<typename OtherDerived > | |
void | swap (const DenseBase< OtherDerived > &other) |
template<typename OtherDerived > | |
void | swap (PlainObjectBase< OtherDerived > &other) |
Scalar | trace () const |
TransposeReturnType | transpose () |
const ConstTransposeReturnType | transpose () const |
void | transposeInPlace () |
CoeffReturnType | value () const |
template<typename Visitor > | |
void | visit (Visitor &func) const |
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors > | |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | colStride () const EIGEN_NOEXCEPT |
Derived & | derived () |
const Derived & | derived () const |
EIGEN_CONSTEXPR Index | innerStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | outerStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | rowStride () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | stride () const EIGEN_NOEXCEPT |
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors > | |
Scalar & | coeffRef (Index index) |
Scalar & | coeffRef (Index row, Index col) |
Scalar & | coeffRefByOuterInner (Index outer, Index inner) |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
Derived & | derived () |
const Derived & | derived () const |
Scalar & | operator() (Index index) |
Scalar & | operator() (Index row, Index col) |
Scalar & | operator[] (Index index) |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
Scalar & | w () |
Scalar & | x () |
Scalar & | y () |
Scalar & | z () |
Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > | |
CoeffReturnType | coeff (Index index) const |
CoeffReturnType | coeff (Index row, Index col) const |
CoeffReturnType | coeffByOuterInner (Index outer, Index inner) const |
Index | colIndexByOuterInner (Index outer, Index inner) const |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
Derived & | derived () |
const Derived & | derived () const |
CoeffReturnType | operator() (Index index) const |
CoeffReturnType | operator() (Index row, Index col) const |
CoeffReturnType | operator[] (Index index) const |
template<int LoadMode> | |
PacketReturnType | packet (Index index) const |
template<int LoadMode> | |
PacketReturnType | packet (Index row, Index col) const |
template<int LoadMode> | |
PacketReturnType | packetByOuterInner (Index outer, Index inner) const |
Index | rowIndexByOuterInner (Index outer, Index inner) const |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
CoeffReturnType | w () const |
CoeffReturnType | x () const |
CoeffReturnType | y () const |
CoeffReturnType | z () const |
Public Member Functions inherited from Eigen::EigenBase< Derived > | |
template<typename Dest > | |
void | addTo (Dest &dst) const |
template<typename Dest > | |
void | applyThisOnTheLeft (Dest &dst) const |
template<typename Dest > | |
void | applyThisOnTheRight (Dest &dst) const |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
Derived & | const_cast_derived () const |
const Derived & | const_derived () const |
Derived & | derived () |
const Derived & | derived () const |
template<typename Dest > | |
void | evalTo (Dest &dst) const |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
template<typename Dest > | |
void | subTo (Dest &dst) const |
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) |
Static Public Member Functions inherited from Eigen::MatrixBase< Derived > | |
static const IdentityReturnType | Identity () |
static const IdentityReturnType | Identity (Index rows, Index cols) |
static const BasisReturnType | Unit (Index i) |
static const BasisReturnType | Unit (Index size, Index i) |
static const BasisReturnType | UnitW () |
static const BasisReturnType | UnitX () |
static const BasisReturnType | UnitY () |
static const BasisReturnType | UnitZ () |
Static Public Member Functions inherited from Eigen::DenseBase< Derived > | |
static const ConstantReturnType | Constant (const Scalar &value) |
static const ConstantReturnType | Constant (Index rows, Index cols, const Scalar &value) |
static const ConstantReturnType | Constant (Index size, const Scalar &value) |
static const RandomAccessEqualSpacedReturnType | EqualSpaced (const Scalar &low, const Scalar &step) |
static const RandomAccessEqualSpacedReturnType | EqualSpaced (Index size, const Scalar &low, const Scalar &step) |
static const RandomAccessLinSpacedReturnType | LinSpaced (const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
static const RandomAccessLinSpacedReturnType | LinSpaced (Index size, const Scalar &low, const Scalar &high) |
Sets a linearly spaced vector. More... | |
static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType | LinSpaced (Sequential_t, const Scalar &low, const Scalar &high) |
static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType | LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high) |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func) |
template<typename CustomNullaryOp > | |
static const CwiseNullaryOp< CustomNullaryOp, PlainObject > | NullaryExpr (Index size, const CustomNullaryOp &func) |
static const ConstantReturnType | Ones () |
static const ConstantReturnType | Ones (Index rows, Index cols) |
static const ConstantReturnType | Ones (Index size) |
static const RandomReturnType | Random () |
static const RandomReturnType | Random (Index rows, Index cols) |
static const RandomReturnType | Random (Index size) |
static const ConstantReturnType | Zero () |
static const ConstantReturnType | Zero (Index rows, Index cols) |
static const ConstantReturnType | Zero (Index size) |
Protected Member Functions inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > > | |
void | _init1 (const DenseBase< OtherDerived > &other) |
void | _init1 (const EigenBase< OtherDerived > &other) |
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) |
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) |
void | _init1 (const Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &other) |
void | _init1 (const ReturnByValue< OtherDerived > &other) |
void | _init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r) |
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) |
void | _init1 (const Scalar &val0, std::enable_if_t< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T > *=0) |
void | _init1 (const Scalar *data) |
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) |
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) |
void | _init2 (const T0 &val0, const T1 &val1, std::enable_if_t< Base::SizeAtCompileTime==2, T0 > *=0) |
void | _init2 (Index rows, Index cols, std::enable_if_t< Base::SizeAtCompileTime!=2, T0 > *=0) |
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. More... | |
Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & | _set_noalias (const DenseBase< OtherDerived > &other) |
PlainObjectBase & | operator= (PlainObjectBase &&other) EIGEN_NOEXCEPT |
PlainObjectBase () | |
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. More... | |
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 | 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... | |
PlainObjectBase (Index size, Index rows, Index cols) | |
PlainObjectBase (PlainObjectBase &&other) EIGEN_NOEXCEPT | |
Protected Member Functions inherited from Eigen::MatrixBase< Derived > | |
template<typename OtherDerived > | |
Derived & | operator+= (const ArrayBase< OtherDerived > &) |
template<typename OtherDerived > | |
Derived & | operator-= (const ArrayBase< OtherDerived > &) |
Protected Member Functions inherited from Eigen::DenseBase< Derived > | |
constexpr | DenseBase () |
Protected Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > | |
void | coeffRef () |
void | coeffRefByOuterInner () |
void | colStride () |
void | copyCoeff () |
void | copyCoeffByOuterInner () |
void | copyPacket () |
void | copyPacketByOuterInner () |
void | innerStride () |
void | outerStride () |
void | rowStride () |
void | stride () |
void | writePacket () |
void | writePacketByOuterInner () |
Protected Attributes inherited from Eigen::PlainObjectBase< Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > > | |
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options > | m_storage |
Related Functions inherited from Eigen::DenseBase< Derived > | |
template<typename Derived > | |
std::ostream & | operator<< (std::ostream &s, const DenseBase< Derived > &m) |
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 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.
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 Extending MatrixBase (and other classes) 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.
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 type | Equivalent C structure |
---|---|
Matrix<T,Dynamic,Dynamic>
| struct {
};
EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT Definition: PlainObjectBase.h:171 const Scalar * data() const Definition: PlainObjectBase.h:261 EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT Definition: PlainObjectBase.h:169 |
Matrix<T,Dynamic,1>
Matrix<T,1,Dynamic>
| |
Matrix<T,Rows,Cols>
| |
Matrix<T,Dynamic,Dynamic,0,MaxRows,MaxCols>
| struct {
};
|
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.
typedef PlainObjectBase<Matrix> Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Base |
typedef Base::PlainObject Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::PlainObject |
anonymous enum |
|
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.
Definition at line 261 of file Matrix.h.
|
inlineexplicit |
|
inline |
|
inline |
|
inlineexplicitconstexpr |
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:
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:
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.
Definition at line 315 of file Matrix.h.
|
explicit |
Constructs a fixed-sized matrix initialized with coefficients starting at data.
|
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.
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). Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix | ( | const Scalar & | x | ) |
Constructs an initialized 1x1 matrix with the given coefficient.
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.
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). Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Matrix | ( | const Scalar & | x, |
const Scalar & | y | ||
) |
Constructs an initialized 2D vector with given coefficients.
|
inline |
Constructs an initialized 3D vector with given coefficients.
Definition at line 382 of file Matrix.h.
|
inline |
Constructs an initialized 4D vector with given coefficients.
|
inline |
|
inline |
|
explicit |
Constructs a Dim x Dim rotation matrix from the rotation r.
This is defined in the Geometry module.
Definition at line 143 of file RotationBase.h.
|
inline |
|
inline |
Definition at line 225 of file Matrix.h.
|
inline |
Copies the generic expression other into *this.
Implementation of matrix base methods
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
Definition at line 238 of file Matrix.h.
|
inline |
|
inline |
Matrix& Eigen::Matrix< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::operator= | ( | const RotationBase< OtherDerived, ColsAtCompileTime > & | r | ) |
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.
Definition at line 157 of file RotationBase.h.
|
inline |
|
inline |