WPILibC++ 2023.4.3
Eigen::MatrixWrapper< ExpressionType > Class Template Reference

Expression of an array as a mathematical vector or matrix. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/ArrayWrapper.h>

Inheritance diagram for Eigen::MatrixWrapper< ExpressionType >:
Eigen::MatrixBase< MatrixWrapper< ExpressionType > > Eigen::DenseBase< MatrixWrapper< ExpressionType > > Eigen::DenseCoeffsBase< MatrixWrapper< ExpressionType >, internal::accessors_level< MatrixWrapper< ExpressionType > >::value >

Public Types

typedef MatrixBase< MatrixWrapper< ExpressionType > > Base
 
typedef internal::remove_all< ExpressionType >::type NestedExpression
 
typedef internal::conditional< internal::is_lvalue< ExpressionType >::value, Scalar, constScalar >::type ScalarWithConstIfNotLvalue
 
typedef internal::ref_selector< ExpressionType >::non_const_type NestedExpressionType
 
- Public Types inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
enum  
 
enum  
 
typedef MatrixBase StorageBaseType
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageKind StorageKind
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageIndex StorageIndex
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::Scalar Scalar
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef DenseBase< MatrixWrapper< ExpressionType > > Base
 
typedef Base::CoeffReturnType CoeffReturnType
 
typedef Base::ConstTransposeReturnType ConstTransposeReturnType
 
typedef Base::RowXpr RowXpr
 
typedef Base::ColXpr ColXpr
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 type of the equivalent square matrix More...
 
typedef Base::PlainObject PlainObject
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObjectConstantReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, ConstTransposeReturnType >, ConstTransposeReturnType >::type AdjointReturnType
 
typedef Matrix< std::complex< RealScalar >, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, 1, ColMajor > EigenvaluesReturnType
 
typedef CwiseNullaryOp< internal::scalar_identity_op< Scalar >, PlainObjectIdentityReturnType
 
typedef Block< const CwiseNullaryOp< internal::scalar_identity_op< Scalar >, SquareMatrixType >, internal::traits< MatrixWrapper< ExpressionType > >::RowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTimeBasisReturnType
 
typedef Diagonal< MatrixWrapper< ExpressionType > > DiagonalReturnType
 
typedef internal::add_const< Diagonal< constDerived > >::type ConstDiagonalReturnType
 
typedef Diagonal< MatrixWrapper< ExpressionType >, DynamicIndex > DiagonalDynamicIndexReturnType
 
typedef internal::add_const< Diagonal< constDerived, DynamicIndex > >::type ConstDiagonalDynamicIndexReturnType
 
typedef Homogeneous< MatrixWrapper< ExpressionType >, HomogeneousReturnTypeDirectionHomogeneousReturnType
 
typedef Block< const MatrixWrapper< ExpressionType >, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime==1 ? SizeMinusOne :1, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime==1 ? 1 :SizeMinusOneConstStartMinusOne
 
typedef internal::stem_function< Scalar >::type StemFunction
 
- Public Types inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
enum  
 
enum  
 
typedef Eigen::InnerIterator< MatrixWrapper< ExpressionType > > InnerIterator
 Inner iterator type to iterate over the coefficients of a row or column. More...
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageKind StorageKind
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageIndex StorageIndex
 The type used to store indices. More...
 
typedef internal::traits< MatrixWrapper< ExpressionType > >::Scalar Scalar
 The numeric type of the expression' coefficients, e.g. More...
 
typedef Scalar value_type
 The numeric type of the expression' coefficients, e.g. More...
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef DenseCoeffsBase< MatrixWrapper< ExpressionType >, internal::accessors_level< MatrixWrapper< ExpressionType > >::valueBase
 
typedef Base::CoeffReturnType CoeffReturnType
 
typedef internal::find_best_packet< Scalar, SizeAtCompileTime >::type PacketScalar
 
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
 The plain matrix type corresponding to this expression. More...
 
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
 The plain array type corresponding to this expression. More...
 
typedef internal::conditional< internal::is_same< typenameinternal::traits< MatrixWrapper< ExpressionType > >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
 The plain matrix or array type corresponding to this expression. More...
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObjectConstantReturnType
 
typedef CwiseNullaryOp< internal::linspaced_op< Scalar >, PlainObjectRandomAccessLinSpacedReturnType
 
typedef Matrix< typename NumTraits< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar >::Real, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, 1 > EigenvaluesReturnType
 
typedef Transpose< MatrixWrapper< ExpressionType > > TransposeReturnType
 
typedef internal::add_const< Transpose< constDerived > >::type ConstTransposeReturnType
 
typedef internal::add_const_on_value_type< typenameinternal::eval< MatrixWrapper< ExpressionType > >::type >::type EvalReturnType
 
typedef VectorwiseOp< MatrixWrapper< ExpressionType >, Horizontal > RowwiseReturnType
 
typedef const VectorwiseOp< const MatrixWrapper< ExpressionType >, Horizontal > ConstRowwiseReturnType
 
typedef VectorwiseOp< MatrixWrapper< ExpressionType >, Vertical > ColwiseReturnType
 
typedef const VectorwiseOp< const MatrixWrapper< ExpressionType >, Vertical > ConstColwiseReturnType
 
typedef CwiseNullaryOp< internal::scalar_random_op< Scalar >, PlainObjectRandomReturnType
 
typedef Reverse< MatrixWrapper< ExpressionType >, BothDirections > ReverseReturnType
 
typedef const Reverse< const MatrixWrapper< ExpressionType >, BothDirections > ConstReverseReturnType
 
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< MatrixWrapper< ExpressionType > >, internal::generic_randaccess_stl_iterator< MatrixWrapper< ExpressionType > > >::type iterator_type
 
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< constDerived >, internal::generic_randaccess_stl_iterator< constDerived > >::type const_iterator_type
 
typedef internal::conditional< IsVectorAtCompileTime, iterator_type, void >::type iterator
 
typedef internal::conditional< IsVectorAtCompileTime, const_iterator_type, void >::type const_iterator
 

Public Member Functions

EIGEN_DEVICE_FUNC MatrixWrapper (ExpressionType &matrix)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvaluedata ()
 
EIGEN_DEVICE_FUNC const Scalardata () const
 
EIGEN_DEVICE_FUNC const ScalarcoeffRef (Index rowId, Index colId) const
 
EIGEN_DEVICE_FUNC const ScalarcoeffRef (Index index) const
 
EIGEN_DEVICE_FUNC const internal::remove_all< NestedExpressionType >::typenestedExpression () const
 
EIGEN_DEVICE_FUNC void resize (Index newSize)
 Forwards the resizing request to the nested expression. More...
 
EIGEN_DEVICE_FUNC void resize (Index rows, Index cols)
 Forwards the resizing request to the nested expression. More...
 
- Public Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
EIGEN_DEVICE_FUNC Index diagonalSize () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const MatrixBase &other)
 Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1) More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator= (const EigenBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator= (const ReturnByValue< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const EigenBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const ReturnByValue< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator+= (const MatrixBase< OtherDerived > &other)
 replaces *this by *this + other. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator-= (const MatrixBase< OtherDerived > &other)
 replaces *this by *this - other. More...
 
EIGEN_DEVICE_FUNC const Product< MatrixWrapper< ExpressionType >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const Product< MatrixWrapper< ExpressionType >, DiagonalDerived, LazyProduct > operator* (const DiagonalBase< DiagonalDerived > &diagonal) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Product< MatrixWrapper< ExpressionType >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const Product< MatrixWrapper< ExpressionType >, OtherDerived, LazyProduct > lazyProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Product< MatrixWrapper< ExpressionType >, OtherDerived, LazyProduct > lazyProduct (const MatrixBase< OtherDerived > &other) const
 
MatrixWrapper< ExpressionType > & operator*= (const EigenBase< OtherDerived > &other)
 replaces *this by *this * other. More...
 
void applyOnTheLeft (const EigenBase< OtherDerived > &other)
 replaces *this by other * *this. More...
 
EIGEN_DEVICE_FUNC void applyOnTheLeft (Index p, Index q, const JacobiRotation< OtherScalar > &j)
 \jacobi_module Applies the rotation in the plane j to the rows p and q of *this, i.e., it computes B = J * B, with \( B = \left ( \begin{array}{cc} \text{*this.row}(p) \\ \text{*this.row}(q) \end{array} \right ) \). More...
 
void applyOnTheRight (const EigenBase< OtherDerived > &other)
 replaces *this by *this * other. More...
 
EIGEN_DEVICE_FUNC void applyOnTheRight (Index p, Index q, const JacobiRotation< OtherScalar > &j)
 Applies the rotation in the plane j to the columns p and q of *this, i.e., it computes B = B * J with \( B = \left ( \begin{array}{cc} \text{*this.col}(p) & \text{*this.col}(q) \end{array} \right ) \). More...
 
EIGEN_DEVICE_FUNC ScalarBinaryOpTraits< typenameinternal::traits< MatrixWrapper< ExpressionType > >::Scalar, typenameinternal::traits< OtherDerived >::Scalar >::ReturnType dot (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ScalarBinaryOpTraits< typenameinternal::traits< MatrixWrapper< ExpressionType > >::Scalar, typenameinternal::traits< OtherDerived >::Scalar >::ReturnType dot (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC RealScalar squaredNorm () const
 
EIGEN_DEVICE_FUNC RealScalar norm () const
 
RealScalar stableNorm () const
 
RealScalar blueNorm () const
 
RealScalar hypotNorm () const
 
EIGEN_DEVICE_FUNC const PlainObject normalized () const
 
EIGEN_DEVICE_FUNC const PlainObject stableNormalized () const
 
EIGEN_DEVICE_FUNC void normalize ()
 Normalizes the vector, i.e. More...
 
EIGEN_DEVICE_FUNC void stableNormalize ()
 Normalizes the vector while avoid underflow and overflow. More...
 
EIGEN_DEVICE_FUNC const AdjointReturnType adjoint () const
 
EIGEN_DEVICE_FUNC void adjointInPlace ()
 This is the "in place" version of adjoint(): it replaces *this by its own transpose. More...
 
EIGEN_DEVICE_FUNC DiagonalReturnType diagonal ()
 
EIGEN_DEVICE_FUNC ConstDiagonalReturnType diagonal () const
 This is the const version of diagonal(). More...
 
EIGEN_DEVICE_FUNC DiagonalIndexReturnType< Index >::Type diagonal ()
 
EIGEN_DEVICE_FUNC ConstDiagonalIndexReturnType< Index >::Type diagonal () const
 
EIGEN_DEVICE_FUNC DiagonalDynamicIndexReturnType diagonal (Index index)
 
EIGEN_DEVICE_FUNC ConstDiagonalDynamicIndexReturnType diagonal (Index index) const
 This is the const version of diagonal(Index). More...
 
EIGEN_DEVICE_FUNC TriangularViewReturnType< Mode >::Type triangularView ()
 
EIGEN_DEVICE_FUNC ConstTriangularViewReturnType< Mode >::Type triangularView () const
 
EIGEN_DEVICE_FUNC MatrixBase< MatrixWrapper< ExpressionType > >::template TriangularViewReturnType< Mode >::Type triangularView ()
 
EIGEN_DEVICE_FUNC MatrixBase< MatrixWrapper< ExpressionType > >::template ConstTriangularViewReturnType< Mode >::Type triangularView () const
 This is the const version of MatrixBase::triangularView() More...
 
EIGEN_DEVICE_FUNC SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
EIGEN_DEVICE_FUNC ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
EIGEN_DEVICE_FUNC MatrixBase< MatrixWrapper< ExpressionType > >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 This is the const version of MatrixBase::selfadjointView() More...
 
EIGEN_DEVICE_FUNC MatrixBase< MatrixWrapper< ExpressionType > >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
const SparseView< MatrixWrapper< ExpressionType > > sparseView (const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC const DiagonalWrapper< const MatrixWrapper< ExpressionType > > asDiagonal () const
 
const PermutationWrapper< const MatrixWrapper< ExpressionType > > asPermutation () const
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setIdentity ()
 Writes the identity expression (not necessarily square) into *this. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setIdentity (Index rows, Index cols)
 Resizes to the given size, and writes the identity expression (not necessarily square) into *this. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setUnit (Index i)
 Set the coefficients of *this to the i-th unit (basis) vector. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setUnit (Index newSize, Index i)
 Resizes to the given newSize, and writes the i-th unit (basis) vector into *this. More...
 
bool isIdentity (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isDiagonal (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isUpperTriangular (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
 
EIGEN_DEVICE_FUNC bool operator== (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC bool operator!= (const MatrixBase< OtherDerived > &other) const
 
NoAlias< MatrixWrapper< ExpressionType >, Eigen::MatrixBase > EIGEN_DEVICE_FUNC noalias ()
 
const MatrixWrapper< ExpressionType > & forceAlignedAccess () const
 
MatrixWrapper< ExpressionType > & forceAlignedAccess ()
 
const MatrixWrapper< ExpressionType > & forceAlignedAccessIf () const
 
MatrixWrapper< ExpressionType > & forceAlignedAccessIf ()
 
internal::add_const_on_value_type< typenameinternal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type >::type forceAlignedAccessIf () const
 
internal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type forceAlignedAccessIf ()
 
EIGEN_DEVICE_FUNC Scalar trace () const
 
EIGEN_DEVICE_FUNC RealScalar lpNorm () const
 
EIGEN_DEVICE_FUNC NumTraits< typenameinternal::traits< MatrixWrapper< ExpressionType > >::Scalar >::Real lpNorm () const
 
EIGEN_DEVICE_FUNC MatrixBase< MatrixWrapper< ExpressionType > > & matrix ()
 
EIGEN_DEVICE_FUNC const MatrixBase< MatrixWrapper< ExpressionType > > & matrix () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ArrayWrapper< MatrixWrapper< ExpressionType > > array ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ArrayWrapper< const MatrixWrapper< ExpressionType > > array () const
 
const FullPivLU< PlainObjectfullPivLu () const
 \lu_module More...
 
const PartialPivLU< PlainObjectpartialPivLu () const
 \lu_module More...
 
const PartialPivLU< PlainObjectlu () const
 \lu_module More...
 
EIGEN_DEVICE_FUNC const Inverse< MatrixWrapper< ExpressionType > > inverse () const
 \lu_module More...
 
void computeInverseAndDetWithCheck (ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
 \lu_module More...
 
void computeInverseWithCheck (ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
 \lu_module More...
 
EIGEN_DEVICE_FUNC Scalar determinant () const
 \lu_module More...
 
const LLT< PlainObjectllt () const
 \cholesky_module More...
 
const LDLT< PlainObjectldlt () const
 \cholesky_module More...
 
const HouseholderQR< PlainObjecthouseholderQr () const
 
const ColPivHouseholderQR< PlainObjectcolPivHouseholderQr () const
 
const FullPivHouseholderQR< PlainObjectfullPivHouseholderQr () const
 
const CompleteOrthogonalDecomposition< PlainObjectcompleteOrthogonalDecomposition () const
 
EigenvaluesReturnType eigenvalues () const
 Computes the eigenvalues of a matrix. More...
 
RealScalar operatorNorm () const
 Computes the L2 operator norm. More...
 
JacobiSVD< PlainObjectjacobiSvd (unsigned int computationOptions=0) const
 \svd_module More...
 
BDCSVD< PlainObjectbdcSvd (unsigned int computationOptions=0) const
 \svd_module More...
 
EIGEN_DEVICE_FUNC cross_product_return_type< OtherDerived >::type cross (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC PlainObject cross3 (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC PlainObject unitOrthogonal (void) const
 
EIGEN_DEVICE_FUNC Matrix< Scalar, 3, 1 > eulerAngles (Index a0, Index a1, Index a2) const
 
EIGEN_DEVICE_FUNC HomogeneousReturnType homogeneous () const
 
typedef EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE (ConstStartMinusOne, Scalar, quotient) HNormalizedReturnType
 
EIGEN_DEVICE_FUNC const HNormalizedReturnType hnormalized () const
 
EIGEN_DEVICE_FUNC void makeHouseholderInPlace (Scalar &tau, RealScalar &beta)
 Computes the elementary reflector H such that: \( H *this = [ beta 0 ... 0]^T \) where the transformation H is: \( H = I - tau v v^*\) and the vector v is: \( v^T = [1 essential^T] \). More...
 
EIGEN_DEVICE_FUNC void makeHouseholder (EssentialPart &essential, Scalar &tau, RealScalar &beta) const
 Computes the elementary reflector H such that: \( H *this = [ beta 0 ... 0]^T \) where the transformation H is: \( H = I - tau v v^*\) and the vector v is: \( v^T = [1 essential^T] \). More...
 
EIGEN_DEVICE_FUNC void applyHouseholderOnTheLeft (const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
 Apply the elementary reflector H given by \( H = I - tau v v^*\) with \( v^T = [1 essential^T] \) from the left to a vector or matrix. More...
 
EIGEN_DEVICE_FUNC void applyHouseholderOnTheRight (const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
 Apply the elementary reflector H given by \( H = I - tau v v^*\) with \( v^T = [1 essential^T] \) from the right to a vector or matrix. More...
 
EIGEN_STRONG_INLINE const SparseMatrixBase< OtherDerived >::template CwiseProductDenseReturnType< MatrixWrapper< ExpressionType > >::Type cwiseProduct (const SparseMatrixBase< OtherDerived > &other) const
 
const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > > matrixFunction (StemFunction f) const
 Helper function for the unsupported MatrixFunctions module. More...
 
- Public Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index nonZeros () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerSize () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerSize () const
 
EIGEN_DEVICE_FUNC void resize (Index newSize)
 Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). More...
 
EIGEN_DEVICE_FUNC void resize (Index rows, Index cols)
 Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const DenseBase< OtherDerived > &other)
 Copies other into *this. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator= (const DenseBase &other)
 Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1) More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator= (const EigenBase< OtherDerived > &other)
 Copies the generic expression other into *this. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator= (const ReturnByValue< OtherDerived > &func)
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator+= (const EigenBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & operator-= (const EigenBase< OtherDerived > &other)
 
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & lazyAssign (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & lazyAssign (const DenseBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC CommaInitializer< MatrixWrapper< ExpressionType > > operator<< (const Scalar &s)
 Convenient operator to set the coefficients of a matrix. More...
 
EIGEN_DEVICE_FUNC CommaInitializer< MatrixWrapper< ExpressionType > > operator<< (const DenseBase< OtherDerived > &other)
 
EIGEN_DEPRECATED const MatrixWrapper< ExpressionType > & flagged () const
 
EIGEN_DEVICE_FUNC TransposeReturnType transpose ()
 
EIGEN_DEVICE_FUNC ConstTransposeReturnType transpose () const
 This is the const version of transpose(). More...
 
EIGEN_DEVICE_FUNC void transposeInPlace ()
 This is the "in place" version of transpose(): it replaces *this by its own transpose. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< MatrixWrapper< ExpressionType > >::PlainObjectNullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< MatrixWrapper< ExpressionType > >::PlainObjectNullaryExpr (Index size, const CustomNullaryOp &func)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< MatrixWrapper< ExpressionType > >::PlainObjectNullaryExpr (const CustomNullaryOp &func)
 
EIGEN_DEVICE_FUNC void fill (const Scalar &value)
 Alias for setConstant(): sets all coefficients in this expression to val. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setConstant (const Scalar &value)
 Sets all coefficients in this expression to value val. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setLinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setLinSpaced (const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setZero ()
 Sets all coefficients in this expression to zero. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setOnes ()
 Sets all coefficients in this expression to one. More...
 
EIGEN_DEVICE_FUNC MatrixWrapper< ExpressionType > & setRandom ()
 Sets all coefficients in this expression to random values. More...
 
EIGEN_DEVICE_FUNC bool isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC bool isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC bool isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC bool isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
 
EIGEN_DEVICE_FUNC bool isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC bool isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 This is just an alias for isApproxToConstant(). More...
 
EIGEN_DEVICE_FUNC bool isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
EIGEN_DEVICE_FUNC bool isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool hasNaN () const
 
bool allFinite () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator*= (const Scalar &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE MatrixWrapper< ExpressionType > & operator/= (const Scalar &other)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType eval () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap (const DenseBase< OtherDerived > &other)
 swaps *this with the expression other. More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void swap (PlainObjectBase< OtherDerived > &other)
 swaps *this with the matrix or array other. More...
 
EIGEN_DEVICE_FUNC const NestByValue< MatrixWrapper< ExpressionType > > nestByValue () const
 
EIGEN_DEVICE_FUNC const ForceAlignedAccess< MatrixWrapper< ExpressionType > > forceAlignedAccess () const
 
EIGEN_DEVICE_FUNC ForceAlignedAccess< MatrixWrapper< ExpressionType > > forceAlignedAccess ()
 
EIGEN_DEVICE_FUNC const internal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type forceAlignedAccessIf () const
 
EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< MatrixWrapper< ExpressionType > >, MatrixWrapper< ExpressionType > & >::type forceAlignedAccessIf ()
 
EIGEN_DEVICE_FUNC Scalar sum () const
 
EIGEN_DEVICE_FUNC Scalar mean () const
 
EIGEN_DEVICE_FUNC Scalar trace () const
 
EIGEN_DEVICE_FUNC Scalar prod () const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *index) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *row, IndexType *col) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar minCoeff (IndexType *index) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff () const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *row, IndexType *col) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *index) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *row, IndexType *col) const
 
EIGEN_DEVICE_FUNC internal::traits< MatrixWrapper< ExpressionType > >::Scalar maxCoeff (IndexType *index) const
 
EIGEN_DEVICE_FUNC Scalar redux (const BinaryOp &func) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< MatrixWrapper< ExpressionType > >::Scalar redux (const Func &func) const
 
EIGEN_DEVICE_FUNC void visit (Visitor &func) const
 Applies the visitor visitor to the whole coefficients of the matrix or vector. More...
 
const WithFormat< MatrixWrapper< ExpressionType > > format (const IOFormat &fmt) const
 
EIGEN_DEVICE_FUNC CoeffReturnType value () const
 
EIGEN_DEVICE_FUNC bool all () const
 
EIGEN_DEVICE_FUNC bool any () const
 
EIGEN_DEVICE_FUNC Index count () const
 
EIGEN_DEVICE_FUNC ConstRowwiseReturnType rowwise () const
 
EIGEN_DEVICE_FUNC RowwiseReturnType rowwise ()
 
EIGEN_DEVICE_FUNC ConstColwiseReturnType colwise () const
 
EIGEN_DEVICE_FUNC ColwiseReturnType colwise ()
 
EIGEN_DEVICE_FUNC const Select< MatrixWrapper< ExpressionType >, ThenDerived, ElseDerived > select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
 
EIGEN_DEVICE_FUNC const Select< MatrixWrapper< ExpressionType >, ThenDerived, typename ThenDerived::ConstantReturnType > select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
 Version of DenseBase::select(const DenseBase&, const DenseBase&) with the else expression being a scalar value. More...
 
EIGEN_DEVICE_FUNC const Select< MatrixWrapper< ExpressionType >, typename ElseDerived::ConstantReturnType, ElseDerived > select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
 Version of DenseBase::select(const DenseBase&, const DenseBase&) with the then expression being a scalar value. More...
 
RealScalar lpNorm () const
 
EIGEN_DEVICE_FUNC const Replicate< MatrixWrapper< ExpressionType >, RowFactor, ColFactor > replicate () const
 
EIGEN_DEVICE_FUNC const Replicate< MatrixWrapper< ExpressionType >, Dynamic, Dynamic > replicate (Index rowFactor, Index colFactor) const
 
EIGEN_DEVICE_FUNC ReverseReturnType reverse ()
 
EIGEN_DEVICE_FUNC ConstReverseReturnType reverse () const
 This is the const version of reverse(). More...
 
EIGEN_DEVICE_FUNC void reverseInPlace ()
 This is the "in place" version of reverse: it reverses *this. More...
 
iterator begin ()
 returns an iterator to the first element of the 1D vector or array \only_for_vectors More...
 
const_iterator begin () const
 const version of begin() More...
 
const_iterator cbegin () const
 returns a read-only const_iterator to the first element of the 1D vector or array \only_for_vectors More...
 
iterator end ()
 returns an iterator to the element following the last element of the 1D vector or array \only_for_vectors More...
 
const_iterator end () const
 const version of end() More...
 
const_iterator cend () const
 returns a read-only const_iterator to the element following the last element of the 1D vector or array \only_for_vectors More...
 
EIGEN_DEVICE_FUNC void evalTo (Dest &) const
 

Protected Attributes

NestedExpressionType m_expression
 

Additional Inherited Members

- Static Public Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
static EIGEN_DEVICE_FUNC const IdentityReturnType Identity ()
 
static EIGEN_DEVICE_FUNC const IdentityReturnType Identity (Index rows, Index cols)
 
static EIGEN_DEVICE_FUNC const BasisReturnType Unit (Index size, Index i)
 
static EIGEN_DEVICE_FUNC const BasisReturnType Unit (Index i)
 
static EIGEN_DEVICE_FUNC const BasisReturnType UnitX ()
 
static EIGEN_DEVICE_FUNC const BasisReturnType UnitY ()
 
static EIGEN_DEVICE_FUNC const BasisReturnType UnitZ ()
 
static EIGEN_DEVICE_FUNC const BasisReturnType UnitW ()
 
- Static Public Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
static EIGEN_DEVICE_FUNC const ConstantReturnType Constant (Index rows, Index cols, const Scalar &value)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Constant (Index size, const Scalar &value)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Constant (const Scalar &value)
 
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
 
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
 
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced (Index size, const Scalar &low, const Scalar &high)
 Sets a linearly spaced vector. More...
 
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType LinSpaced (const Scalar &low, const Scalar &high)
 
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
 
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (Index size, const CustomNullaryOp &func)
 
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObjectNullaryExpr (const CustomNullaryOp &func)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Zero (Index rows, Index cols)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Zero (Index size)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Zero ()
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Ones (Index rows, Index cols)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Ones (Index size)
 
static EIGEN_DEVICE_FUNC const ConstantReturnType Ones ()
 
static const RandomReturnType Random (Index rows, Index cols)
 
static const RandomReturnType Random (Index size)
 
static const RandomReturnType Random ()
 
- Public Attributes inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
EIGEN_DEPRECATED typedef CwiseNullaryOp< internal::linspaced_op< Scalar >, PlainObjectSequentialLinSpacedReturnType
 
- Protected Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
MatrixWrapper< ExpressionType > & operator+= (const ArrayBase< OtherDerived > &)
 
MatrixWrapper< ExpressionType > & operator-= (const ArrayBase< OtherDerived > &)
 
- Protected Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
EIGEN_DEVICE_FUNC DenseBase ()
 Default constructor. More...
 

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

Member Typedef Documentation

◆ Base

template<typename ExpressionType >
typedef MatrixBase<MatrixWrapper<ExpressionType> > Eigen::MatrixWrapper< ExpressionType >::Base

◆ NestedExpression

template<typename ExpressionType >
typedef internal::remove_all<ExpressionType>::type Eigen::MatrixWrapper< ExpressionType >::NestedExpression

◆ NestedExpressionType

template<typename ExpressionType >
typedef internal::ref_selector<ExpressionType>::non_const_type Eigen::MatrixWrapper< ExpressionType >::NestedExpressionType

◆ ScalarWithConstIfNotLvalue

template<typename ExpressionType >
typedef internal::conditional<internal::is_lvalue<ExpressionType>::value,Scalar,constScalar>::type Eigen::MatrixWrapper< ExpressionType >::ScalarWithConstIfNotLvalue

Constructor & Destructor Documentation

◆ MatrixWrapper()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC Eigen::MatrixWrapper< ExpressionType >::MatrixWrapper ( ExpressionType &  matrix)
inlineexplicit

Member Function Documentation

◆ coeffRef() [1/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const Scalar & Eigen::MatrixWrapper< ExpressionType >::coeffRef ( Index  index) const
inline

◆ coeffRef() [2/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const Scalar & Eigen::MatrixWrapper< ExpressionType >::coeffRef ( Index  rowId,
Index  colId 
) const
inline

◆ cols()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper< ExpressionType >::cols ( void  ) const
inline

◆ data() [1/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue * Eigen::MatrixWrapper< ExpressionType >::data ( )
inline

◆ data() [2/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const Scalar * Eigen::MatrixWrapper< ExpressionType >::data ( ) const
inline

◆ innerStride()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper< ExpressionType >::innerStride ( ) const
inline

◆ nestedExpression()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC const internal::remove_all< NestedExpressionType >::type & Eigen::MatrixWrapper< ExpressionType >::nestedExpression ( ) const
inline

◆ outerStride()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper< ExpressionType >::outerStride ( ) const
inline

◆ resize() [1/2]

template<typename ExpressionType >
EIGEN_DEVICE_FUNC 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 >
EIGEN_DEVICE_FUNC void Eigen::MatrixWrapper< ExpressionType >::resize ( Index  rows,
Index  cols 
)
inline

Forwards the resizing request to the nested expression.

See also
DenseBase::resize(Index,Index)

◆ rows()

template<typename ExpressionType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper< ExpressionType >::rows ( void  ) const
inline

Member Data Documentation

◆ m_expression

template<typename ExpressionType >
NestedExpressionType Eigen::MatrixWrapper< ExpressionType >::m_expression
protected

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