11 #ifndef EIGEN_MATRIXBASE_H 12 #define EIGEN_MATRIXBASE_H 52 #ifndef EIGEN_PARSED_BY_DOXYGEN 54 typedef typename internal::traits<Derived>::StorageKind StorageKind;
55 typedef typename internal::traits<Derived>::StorageIndex
StorageIndex;
56 typedef typename internal::traits<Derived>::Scalar
Scalar;
57 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
61 using Base::RowsAtCompileTime;
62 using Base::ColsAtCompileTime;
63 using Base::SizeAtCompileTime;
64 using Base::MaxRowsAtCompileTime;
65 using Base::MaxColsAtCompileTime;
66 using Base::MaxSizeAtCompileTime;
67 using Base::IsVectorAtCompileTime;
71 using Base::const_cast_derived;
77 using Base::lazyAssign;
79 using Base::operator-;
80 using Base::operator+=;
81 using Base::operator-=;
82 using Base::operator*=;
83 using Base::operator/=;
85 typedef typename Base::CoeffReturnType CoeffReturnType;
87 typedef typename Base::RowXpr RowXpr;
88 typedef typename Base::ColXpr ColXpr;
89 #endif // not EIGEN_PARSED_BY_DOXYGEN 93 #ifndef EIGEN_PARSED_BY_DOXYGEN 97 #endif // not EIGEN_PARSED_BY_DOXYGEN 106 #ifndef EIGEN_PARSED_BY_DOXYGEN 110 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
112 ConstTransposeReturnType
113 >::type AdjointReturnType;
120 internal::traits<Derived>::RowsAtCompileTime,
121 internal::traits<Derived>::ColsAtCompileTime> BasisReturnType;
122 #endif // not EIGEN_PARSED_BY_DOXYGEN 124 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::MatrixBase 125 #define EIGEN_DOC_UNARY_ADDONS(X,Y) 126 # include "../plugins/CommonCwiseBinaryOps.h" 127 # include "../plugins/MatrixCwiseUnaryOps.h" 128 # include "../plugins/MatrixCwiseBinaryOps.h" 129 # ifdef EIGEN_MATRIXBASE_PLUGIN 130 # include EIGEN_MATRIXBASE_PLUGIN 132 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS 133 #undef EIGEN_DOC_UNARY_ADDONS 138 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
144 template <
typename OtherDerived>
145 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
148 template <
typename OtherDerived>
152 template<
typename OtherDerived>
154 Derived&
operator=(
const ReturnByValue<OtherDerived>& other);
156 template<
typename OtherDerived>
157 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
159 template<
typename OtherDerived>
160 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
163 template<
typename OtherDerived>
168 template<
typename OtherDerived>
173 template<
typename OtherDerived>
176 template<
typename OtherDerived>
179 template<
typename OtherDerived>
182 template<
typename DiagonalDerived>
187 template<
typename OtherDerived>
193 EIGEN_DEVICE_FUNC RealScalar
norm()
const;
197 EIGEN_DEVICE_FUNC
const PlainObject
normalized()
const;
202 EIGEN_DEVICE_FUNC
const AdjointReturnType
adjoint()
const;
211 ConstDiagonalReturnType
diagonal()
const;
218 typename DiagonalIndexReturnType<Index>::Type
diagonal();
222 typename ConstDiagonalIndexReturnType<Index>::Type
diagonal()
const;
230 ConstDiagonalDynamicIndexReturnType
diagonal(
Index index)
const;
235 template<
unsigned int Mode>
237 typename TriangularViewReturnType<Mode>::Type triangularView();
238 template<
unsigned int Mode>
240 typename ConstTriangularViewReturnType<Mode>::Type triangularView()
const;
245 template<
unsigned int UpLo>
247 typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
248 template<
unsigned int UpLo>
250 typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
254 EIGEN_DEVICE_FUNC
static const IdentityReturnType
Identity();
257 EIGEN_DEVICE_FUNC
static const BasisReturnType
Unit(
Index i);
258 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitX();
259 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitY();
260 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitZ();
261 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitW();
280 template<
typename OtherDerived>
289 template<
typename OtherDerived>
297 template<
typename OtherDerived>
307 template<
bool Enable>
inline const Derived& forceAlignedAccessIf()
const {
return derived(); }
308 template<
bool Enable>
inline Derived& forceAlignedAccessIf() {
return derived(); }
310 EIGEN_DEVICE_FUNC Scalar
trace()
const;
312 template<
int p> EIGEN_DEVICE_FUNC RealScalar
lpNorm()
const;
334 template<
typename ResultType>
342 template<
typename ResultType>
376 #ifndef EIGEN_PARSED_BY_DOXYGEN 377 template<
typename OtherDerived>
struct cross_product_return_type {
379 typedef typename ScalarBinaryOpTraits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType
Scalar;
382 #endif // EIGEN_PARSED_BY_DOXYGEN 383 template<
typename OtherDerived>
385 #ifndef EIGEN_PARSED_BY_DOXYGEN 386 inline typename cross_product_return_type<OtherDerived>::type
392 template<
typename OtherDerived>
412 typedef Block<
const Derived,
413 internal::traits<Derived>::ColsAtCompileTime==1 ? SizeMinusOne : 1,
414 internal::traits<Derived>::ColsAtCompileTime==1 ? 1 : SizeMinusOne>
ConstStartMinusOne;
415 typedef EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(ConstStartMinusOne,Scalar,quotient) HNormalizedReturnType;
417 inline const HNormalizedReturnType
hnormalized()
const;
423 template<
typename EssentialPart>
426 Scalar& tau, RealScalar& beta)
const;
427 template<
typename EssentialPart>
432 template<
typename EssentialPart>
440 template<
typename OtherScalar>
443 template<
typename OtherScalar>
449 template<
typename OtherDerived>
458 typedef typename internal::stem_function<Scalar>::type StemFunction;
459 #define EIGEN_MATRIX_FUNCTION(ReturnType, Name, Description) \ 461 const ReturnType<Derived> Name() const; 462 #define EIGEN_MATRIX_FUNCTION_1(ReturnType, Name, Description, Argument) \ 464 const ReturnType<Derived> Name(Argument) const; 466 EIGEN_MATRIX_FUNCTION(MatrixExponentialReturnValue,
exp, exponential)
468 const MatrixFunctionReturnValue<Derived>
matrixFunction(StemFunction f)
const;
469 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
cosh, hyperbolic cosine)
470 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
sinh, hyperbolic sine)
471 #if EIGEN_HAS_CXX11_MATH 472 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
atanh, inverse hyperbolic cosine)
473 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
acosh, inverse hyperbolic cosine)
474 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
asinh, inverse hyperbolic sine)
476 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
cos, cosine)
477 EIGEN_MATRIX_FUNCTION(MatrixFunctionReturnValue,
sin, sine)
478 EIGEN_MATRIX_FUNCTION(MatrixSquareRootReturnValue,
sqrt,
square root)
479 EIGEN_MATRIX_FUNCTION(MatrixLogarithmReturnValue,
log, logarithm)
480 EIGEN_MATRIX_FUNCTION_1(MatrixPowerReturnValue,
pow, power to \c p,
const RealScalar& p)
481 EIGEN_MATRIX_FUNCTION_1(MatrixComplexPowerReturnValue,
pow, power to \c p,
const std::complex<RealScalar>& p)
485 EIGEN_DEFAULT_EMPTY_CONSTRUCTOR_AND_DESTRUCTOR(
MatrixBase)
489 EIGEN_DEVICE_FUNC MatrixBase(
int,
int);
494 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
497 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
512 template<
typename Derived>
513 template<
typename OtherDerived>
526 template<
typename Derived>
527 template<
typename OtherDerived>
538 template<
typename Derived>
539 template<
typename OtherDerived>
547 #endif // EIGEN_MATRIXBASE_H const MatrixFunctionReturnValue< Derived > cosh() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperb...
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:60
Scalar trace() const
Definition: Redux.h:508
Robust Cholesky decomposition of a matrix with pivoting.
Definition: LDLT.h:59
const CwiseBinaryOp< numext::not_equal_to< Scalar >, const Derived, const OtherDerived > cwiseNotEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:64
const MatrixFunctionReturnValue< Derived > asinh() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise invers...
const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived > cwiseProduct(const Eigen::SparseMatrixBase< OtherDerived > &other) const
Definition: SparseMatrixBase.h:24
const MatrixPowerReturnValue< Derived > pow(const RealScalar &p) const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise power ...
void makeHouseholder(EssentialPart &essential, Scalar &tau, RealScalar &beta) const
Definition: Householder.h:67
RealScalar blueNorm() const
Definition: StableNorm.h:229
BDCSVD< PlainObject > bdcSvd(unsigned int computationOptions=0) const
Definition: BDCSVD.h:1359
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
Definition: Constants.h:319
Expression of the product of two arbitrary matrices or vectors.
Definition: Product.h:71
Expression of a mathematical vector or matrix as an array object.
Definition: ArrayWrapper.h:42
Householder rank-revealing QR decomposition of a matrix with full pivoting.
Definition: FullPivHouseholderQR.h:60
const AdjointReturnType adjoint() const
Definition: Transpose.h:221
const CompleteOrthogonalDecomposition< PlainObject > completeOrthogonalDecomposition() const
Definition: CompleteOrthogonalDecomposition.h:629
void applyOnTheLeft(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:540
Definition: Constants.h:264
Pseudo expression providing an operator = assuming no aliasing.
Definition: NoAlias.h:31
const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived > cwiseProduct(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:24
Expression of the transpose of a matrix.
Definition: Transpose.h:52
static const BasisReturnType UnitW()
Definition: CwiseNullaryOp.h:960
bool isUnitary(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:302
const ColPivHouseholderQR< PlainObject > colPivHouseholderQr() const
Definition: ColPivHouseholderQR.h:667
void applyOnTheRight(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:528
LU decomposition of a matrix with partial pivoting, and related features.
Definition: PartialPivLU.h:76
Namespace containing all symbols from the Eigen library.
Definition: Core:141
const MatrixFunctionReturnValue< Derived > sinh() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperb...
const Eigen::CwiseUnaryOp< Eigen::internal::scalar_square_op< typename Derived::Scalar >, const Derived > square(const Eigen::ArrayBase< Derived > &x)
Rotation given by a cosine-sine pair.
Definition: Jacobi.h:34
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:232
const PlainObject normalized() const
Definition: Dot.h:124
const MatrixSquareRootReturnValue< Derived > sqrt() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise square...
Derived & setIdentity()
Definition: CwiseNullaryOp.h:873
Definition: DenseBase.h:113
Matrix< Scalar, 3, 1 > eulerAngles(Index a0, Index a1, Index a2) const
Definition: EulerAngles.h:37
Derived & derived()
Definition: EigenBase.h:46
Complete orthogonal decomposition (COD) of a matrix.
Definition: CompleteOrthogonalDecomposition.h:50
RealScalar stableNorm() const
Definition: StableNorm.h:213
EIGEN_CONSTEXPR Index size() const EIGEN_NOEXCEPT
Definition: EigenBase.h:67
const FullPivLU< PlainObject > fullPivLu() const
Definition: FullPivLU.h:870
const unsigned int RowMajorBit
Definition: Constants.h:66
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
PlainObject cross3(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:83
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition: DenseBase.h:63
Definition: EigenBase.h:29
void applyHouseholderOnTheLeft(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:116
PlainObject unitOrthogonal(void) const
Definition: OrthoMethods.h:227
void computeInverseAndDetWithCheck(ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Definition: InverseImpl.h:377
void normalize()
Definition: Dot.h:145
RealScalar norm() const
Definition: Dot.h:108
Expression of the inverse of another expression.
Definition: Inverse.h:43
bool operator!=(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:298
bool isUpperTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:665
static const BasisReturnType UnitX()
Definition: CwiseNullaryOp.h:930
Derived & operator+=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:175
void stableNormalize()
Definition: Dot.h:191
const Derived & forceAlignedAccess() const
Definition: MatrixBase.h:305
RealScalar squaredNorm() const
Definition: Dot.h:96
Base class of any sparse matrices or sparse expressions.
Definition: SparseMatrixBase.h:26
JacobiSVD< PlainObject > jacobiSvd(unsigned int computationOptions=0) const
Definition: JacobiSVD.h:805
PlainObject cross(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:35
const MatrixFunctionReturnValue< Derived > cos() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise cosine...
const MatrixLogarithmReturnValue< Derived > log() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise logari...
ArrayWrapper< Derived > array()
Definition: MatrixBase.h:319
Householder rank-revealing QR decomposition of a matrix with column-pivoting.
Definition: ColPivHouseholderQR.h:51
Standard Cholesky decomposition (LL^T) of a matrix and associated features.
Definition: LLT.h:66
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
const MatrixFunctionReturnValue< Derived > atanh() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise invers...
EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: EigenBase.h:63
const HouseholderQR< PlainObject > householderQr() const
Definition: HouseholderQR.h:427
const ArrayWrapper< const Derived > array() const
Definition: MatrixBase.h:322
bool isDiagonal(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: DiagonalMatrix.h:339
const MatrixFunctionReturnValue< Derived > sin() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise sine u...
Expression of a selfadjoint matrix from a triangular part of a dense matrix.
Definition: SelfAdjointView.h:49
Definition: DenseBase.h:106
Expression of a dense or sparse matrix with zero or too small values removed.
Definition: SparseUtil.h:59
const DiagonalWrapper< const Derived > asDiagonal() const
Definition: DiagonalMatrix.h:325
const MatrixExponentialReturnValue< Derived > exp() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise expone...
static const BasisReturnType UnitY()
Definition: CwiseNullaryOp.h:940
Base class for all 1D and 2D array, and related expressions.
Definition: ArrayBase.h:39
Class to view a vector of integers as a permutation matrix.
Definition: PermutationMatrix.h:486
void adjointInPlace()
Definition: Transpose.h:375
static const BasisReturnType Unit(Index size, Index i)
Definition: CwiseNullaryOp.h:902
const PartialPivLU< PlainObject > partialPivLu() const
Definition: PartialPivLU.h:602
class Bidiagonal Divide and Conquer SVD
Definition: BDCSVD.h:36
const LDLT< PlainObject > ldlt() const
Definition: LDLT.h:681
Definition: Constants.h:267
const MatrixFunctionReturnValue< Derived > acosh() const
This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise invers...
RealScalar operatorNorm() const
Computes the L2 operator norm.
Definition: MatrixBaseEigenvalues.h:120
const PlainObject stableNormalized() const
Definition: Dot.h:167
const Inverse< Derived > inverse() const
Definition: InverseImpl.h:348
bool isLowerTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:690
const HNormalizedReturnType hnormalized() const
homogeneous normalization
Definition: Homogeneous.h:174
internal::conditional< internal::is_same< typename internal::traits< Solve< Decomposition, RhsType > >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
The plain matrix or array type corresponding to this expression.
Definition: DenseBase.h:210
Definition: DenseBase.h:100
static const IdentityReturnType Identity()
Definition: CwiseNullaryOp.h:799
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
const SparseView< Derived > sparseView(const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const
Definition: SparseView.h:226
Derived & operator-=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:162
ScalarBinaryOpTraits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType dot(const MatrixBase< OtherDerived > &other) const
Definition: Dot.h:72
LU decomposition of a matrix with complete pivoting, and related features.
Definition: FullPivLU.h:60
void applyHouseholderOnTheRight(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:154
RealScalar lpNorm() const
Definition: Dot.h:267
Householder QR decomposition of a matrix.
Definition: HouseholderQR.h:56
Two-sided Jacobi SVD decomposition of a rectangular matrix.
Definition: JacobiSVD.h:488
Expression of a triangular part in a matrix.
Definition: TriangularMatrix.h:187
Derived & operator=(const MatrixBase &other)
Definition: Assign.h:55
Expression of a diagonal matrix.
Definition: DiagonalMatrix.h:293
Derived & forceAlignedAccess()
Definition: MatrixBase.h:306
const LLT< PlainObject > llt() const
Definition: LLT.h:540
Derived & operator*=(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:515
DiagonalReturnType diagonal()
Definition: Diagonal.h:187
const MatrixFunctionReturnValue< Derived > matrixFunction(StemFunction f) const
Helper function for the unsupported MatrixFunctions module.
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
Definition: XprHelper.h:801
NoAlias< Derived, Eigen::MatrixBase > noalias()
Definition: NoAlias.h:102
bool isOrthogonal(const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:283
EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: EigenBase.h:60
const PartialPivLU< PlainObject > lu() const
Definition: PartialPivLU.h:617
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Definition: Diagonal.h:63
const CwiseBinaryOp< numext::equal_to< Scalar >, const Derived, const OtherDerived > cwiseEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:44
void makeHouseholderInPlace(Scalar &tau, RealScalar &beta)
Definition: Householder.h:43
const int Dynamic
Definition: Constants.h:22
bool isIdentity(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:816
Generic expression where a coefficient-wise unary operator is applied to an expression.
Definition: CwiseUnaryOp.h:55
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:178
void computeInverseWithCheck(ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Definition: InverseImpl.h:418
HomogeneousReturnType homogeneous() const
Definition: Homogeneous.h:132
bool operator==(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:290
Index diagonalSize() const
Definition: MatrixBase.h:102
const FullPivHouseholderQR< PlainObject > fullPivHouseholderQr() const
Definition: FullPivHouseholderQR.h:706
EigenvaluesReturnType eigenvalues() const
Computes the eigenvalues of a matrix.
Definition: MatrixBaseEigenvalues.h:67
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, Derived, Constant< T > > operator*(const T &scalar) const
Scalar determinant() const
Definition: Determinant.h:108
static const BasisReturnType UnitZ()
Definition: CwiseNullaryOp.h:950
Derived & setUnit(Index i)
Set the coefficients of *this to the i-th unit (basis) vector.
Definition: CwiseNullaryOp.h:972
const Product< Derived, OtherDerived, LazyProduct > lazyProduct(const MatrixBase< OtherDerived > &other) const
Definition: GeneralProduct.h:442
Expression of one (or a set of) homogeneous vector(s)
Definition: Homogeneous.h:60
RealScalar hypotNorm() const
Definition: StableNorm.h:241