Eigen  3.4.0 (git rev e3e74001f7c4bf95f0dde572e8a08c5b2918a3ab)
Eigen::MatrixWrapper< ExpressionType > Class Template Reference

Detailed Description

template<typename ExpressionType>
class Eigen::MatrixWrapper< ExpressionType >

Expression of an array as a mathematical vector or matrix.

This class is the return type of ArrayBase::matrix(), and most of the time this is the only way it is use.

See also
MatrixBase::matrix(), class ArrayWrapper
+ Inheritance diagram for Eigen::MatrixWrapper< ExpressionType >:

Public Member Functions

void resize (Index newSize)
 
void resize (Index rows, Index cols)
 
- Public Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > 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 ()
 
void applyHouseholderOnTheLeft (const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
 
void applyHouseholderOnTheRight (const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
 
void applyOnTheLeft (const EigenBase< OtherDerived > &other)
 
void applyOnTheLeft (Index p, Index q, const JacobiRotation< OtherScalar > &j)
 
void applyOnTheRight (const EigenBase< OtherDerived > &other)
 
void applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j)
 
ArrayWrapper< MatrixWrapper< ExpressionType > > array ()
 
const ArrayWrapper< const MatrixWrapper< ExpressionType > > array () const
 
const DiagonalWrapper< const MatrixWrapper< ExpressionType > > asDiagonal () const
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > asinh () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise inverse hyperbolic sine use ArrayBase::asinh . More...
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > atanh () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise inverse hyperbolic cosine use ArrayBase::atanh . More...
 
BDCSVD< PlainObjectbdcSvd (unsigned int computationOptions=0) const
 
RealScalar blueNorm () const
 
const ColPivHouseholderQR< PlainObjectcolPivHouseholderQr () const
 
const CompleteOrthogonalDecomposition< PlainObjectcompleteOrthogonalDecomposition () const
 
void computeInverseAndDetWithCheck (ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
 
void computeInverseWithCheck (ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > cos () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise cosine use ArrayBase::cos . More...
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > cosh () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic cosine use ArrayBase::cosh . More...
 
PlainObject cross (const MatrixBase< OtherDerived > &other) const
 
PlainObject cross3 (const MatrixBase< OtherDerived > &other) const
 
Scalar determinant () const
 
DiagonalReturnType diagonal ()
 
ConstDiagonalReturnType diagonal () const
 
DiagonalDynamicIndexReturnType diagonal (Index index)
 
ConstDiagonalDynamicIndexReturnType diagonal (Index index) const
 
Index diagonalSize () const
 
ScalarBinaryOpTraits< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType dot (const MatrixBase< OtherDerived > &other) const
 
EigenvaluesReturnType eigenvalues () const
 Computes the eigenvalues of a matrix. More...
 
Matrix< Scalar, 3, 1 > eulerAngles (Index a0, Index a1, Index a2) const
 
const MatrixExponentialReturnValue< MatrixWrapper< ExpressionType > > exp () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise exponential use ArrayBase::exp . More...
 
MatrixWrapper< ExpressionType > & forceAlignedAccess ()
 
const MatrixWrapper< ExpressionType > & forceAlignedAccess () const
 
internal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type forceAlignedAccessIf ()
 
internal::add_const_on_value_type< typename internal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type >::type forceAlignedAccessIf () const
 
const FullPivHouseholderQR< PlainObjectfullPivHouseholderQr () const
 
const FullPivLU< PlainObjectfullPivLu () const
 
const HNormalizedReturnType hnormalized () const
 homogeneous normalization More...
 
HomogeneousReturnType homogeneous () const
 
const HouseholderQR< PlainObjecthouseholderQr () const
 
RealScalar hypotNorm () const
 
const Inverse< MatrixWrapper< ExpressionType > > 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
 
bool isOrthogonal (const MatrixBase< OtherDerived > &other, 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
 
JacobiSVD< PlainObjectjacobiSvd (unsigned int computationOptions=0) const
 
const Product< MatrixWrapper< ExpressionType >, OtherDerived, LazyProduct > lazyProduct (const MatrixBase< OtherDerived > &other) const
 
const LDLT< PlainObjectldlt () const
 
const LLT< PlainObjectllt () const
 
const MatrixLogarithmReturnValue< MatrixWrapper< ExpressionType > > log () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise logarithm use ArrayBase::log . More...
 
RealScalar lpNorm () const
 
const PartialPivLU< PlainObjectlu () const
 
void makeHouseholder (EssentialPart &essential, Scalar &tau, RealScalar &beta) const
 
void makeHouseholderInPlace (Scalar &tau, RealScalar &beta)
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > matrixFunction (StemFunction f) const
 Helper function for the unsupported MatrixFunctions module.
 
NoAlias< MatrixWrapper< ExpressionType >, Eigen::MatrixBasenoalias ()
 
RealScalar norm () const
 
void normalize ()
 
const PlainObject normalized () const
 
bool operator!= (const MatrixBase< OtherDerived > &other) const
 
const Product< MatrixWrapper< ExpressionType >, DiagonalDerived, LazyProduct > operator* (const DiagonalBase< DiagonalDerived > &diagonal) const
 
const Product< MatrixWrapper< ExpressionType >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
MatrixWrapper< ExpressionType > & operator*= (const EigenBase< OtherDerived > &other)
 
MatrixWrapper< ExpressionType > & operator+= (const MatrixBase< OtherDerived > &other)
 
MatrixWrapper< ExpressionType > & operator-= (const MatrixBase< OtherDerived > &other)
 
MatrixWrapper< ExpressionType > & operator= (const MatrixBase &other)
 
bool operator== (const MatrixBase< OtherDerived > &other) const
 
RealScalar operatorNorm () const
 Computes the L2 operator norm. More...
 
const PartialPivLU< PlainObjectpartialPivLu () const
 
const MatrixPowerReturnValue< MatrixWrapper< ExpressionType > > 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< MatrixWrapper< ExpressionType > > 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...
 
MatrixBase< MatrixWrapper< ExpressionType > >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
MatrixBase< MatrixWrapper< ExpressionType > >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
MatrixWrapper< ExpressionType > & setIdentity ()
 
MatrixWrapper< ExpressionType > & setIdentity (Index rows, Index cols)
 Resizes to the given size, and writes the identity expression (not necessarily square) into *this. More...
 
MatrixWrapper< ExpressionType > & setUnit (Index i)
 Set the coefficients of *this to the i-th unit (basis) vector. More...
 
MatrixWrapper< ExpressionType > & setUnit (Index newSize, Index i)
 Resizes to the given newSize, and writes the i-th unit (basis) vector into *this. More...
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > sin () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise sine use ArrayBase::sin . More...
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > sinh () const
 This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic sine use ArrayBase::sinh . More...
 
const SparseView< MatrixWrapper< ExpressionType > > sparseView (const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const
 
const MatrixSquareRootReturnValue< MatrixWrapper< ExpressionType > > 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
 
MatrixBase< MatrixWrapper< ExpressionType > >::template TriangularViewReturnType< Mode >::Type triangularView ()
 
MatrixBase< MatrixWrapper< ExpressionType > >::template ConstTriangularViewReturnType< Mode >::Type triangularView () const
 
PlainObject unitOrthogonal (void) const
 
- Public Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
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
 
void fill (const Scalar &value)
 
EIGEN_DEPRECATED const MatrixWrapper< ExpressionType > & flagged () const
 
const WithFormat< MatrixWrapper< ExpressionType > > format (const IOFormat &fmt) const
 
bool hasNaN () const
 
EIGEN_CONSTEXPR Index innerSize () const
 
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
 
bool isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
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
 
EIGEN_DEPRECATED MatrixWrapper< ExpressionType > & lazyAssign (const DenseBase< OtherDerived > &other)
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff () const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *index) const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *row, IndexType *col) const
 
Scalar mean () const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff () const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *index) const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
const NestByValue< MatrixWrapper< ExpressionType > > nestByValue () const
 
EIGEN_CONSTEXPR Index nonZeros () const
 
CommaInitializer< MatrixWrapper< ExpressionType > > operator<< (const DenseBase< OtherDerived > &other)
 
CommaInitializer< MatrixWrapper< ExpressionType > > operator<< (const Scalar &s)
 
MatrixWrapper< ExpressionType > & operator= (const DenseBase &other)
 
MatrixWrapper< ExpressionType > & operator= (const DenseBase< OtherDerived > &other)
 
MatrixWrapper< ExpressionType > & operator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
EIGEN_CONSTEXPR Index outerSize () const
 
Scalar prod () const
 
internal::traits< MatrixWrapper< ExpressionType > >::Scalar redux (const Func &func) const
 
const Replicate< MatrixWrapper< ExpressionType >, RowFactor, ColFactor > replicate () const
 
const Replicate< MatrixWrapper< ExpressionType >, 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
 
const Select< MatrixWrapper< ExpressionType >, ThenDerived, ElseDerived > select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
 
const Select< MatrixWrapper< ExpressionType >, ThenDerived, typename ThenDerived::ConstantReturnType > select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
 
const Select< MatrixWrapper< ExpressionType >, typename ElseDerived::ConstantReturnType, ElseDerived > select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
 
MatrixWrapper< ExpressionType > & setConstant (const Scalar &value)
 
MatrixWrapper< ExpressionType > & setLinSpaced (const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
MatrixWrapper< ExpressionType > & setLinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
MatrixWrapper< ExpressionType > & setOnes ()
 
MatrixWrapper< ExpressionType > & setRandom ()
 
MatrixWrapper< ExpressionType > & setZero ()
 
Scalar sum () const
 
void swap (const DenseBase< OtherDerived > &other)
 
void swap (PlainObjectBase< OtherDerived > &other)
 
TransposeReturnType transpose ()
 
ConstTransposeReturnType transpose () const
 
void transposeInPlace ()
 
CoeffReturnType value () const
 
void visit (Visitor &func) const
 

Additional Inherited Members

- Public Types inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
typedef random_access_iterator_type const_iterator
 
typedef random_access_iterator_type iterator
 
typedef Array< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar, internal::traits< MatrixWrapper< ExpressionType > >::RowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, AutoAlign|(internal::traits< MatrixWrapper< ExpressionType > >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< MatrixWrapper< ExpressionType > >::MaxRowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::MaxColsAtCompileTimePlainArray
 
typedef Matrix< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar, internal::traits< MatrixWrapper< ExpressionType > >::RowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, AutoAlign|(internal::traits< MatrixWrapper< ExpressionType > >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< MatrixWrapper< ExpressionType > >::MaxRowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::MaxColsAtCompileTimePlainMatrix
 
typedef internal::conditional< internal::is_same< typename internal::traits< MatrixWrapper< ExpressionType > >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
 The plain matrix or array type corresponding to this expression. More...
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::Scalar Scalar
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageIndex StorageIndex
 The type used to store indices. More...
 
typedef Scalar value_type
 
- Static Public Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
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< MatrixWrapper< ExpressionType > >
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 RandomAccessLinSpacedReturnType LinSpaced (const Scalar &low, const Scalar &high)
 
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)
 
static const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (const CustomNullaryOp &func)
 
static const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
 
static const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (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::DenseBase< MatrixWrapper< ExpressionType > >
 DenseBase ()
 

Member Function Documentation

◆ resize() [1/2]

template<typename ExpressionType >
void Eigen::MatrixWrapper< ExpressionType >::resize ( Index  newSize)
inline

Forwards the resizing request to the nested expression

See also
DenseBase::resize(Index)

◆ resize() [2/2]

template<typename ExpressionType >
void Eigen::MatrixWrapper< ExpressionType >::resize ( Index  rows,
Index  cols 
)
inline

Forwards the resizing request to the nested expression

See also
DenseBase::resize(Index,Index)

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