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>::Index
Index;
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;
69 using Base::CoeffReadCost;
72 using Base::const_cast_derived;
78 using Base::lazyAssign;
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 101 inline Index
diagonalSize()
const {
return (std::min)(rows(),cols()); }
110 internal::traits<Derived>::RowsAtCompileTime,
111 internal::traits<Derived>::ColsAtCompileTime,
113 internal::traits<Derived>::MaxRowsAtCompileTime,
114 internal::traits<Derived>::MaxColsAtCompileTime
117 #ifndef EIGEN_PARSED_BY_DOXYGEN 121 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
123 ConstTransposeReturnType
124 >::type AdjointReturnType;
131 internal::traits<Derived>::RowsAtCompileTime,
132 internal::traits<Derived>::ColsAtCompileTime> BasisReturnType;
133 #endif // not EIGEN_PARSED_BY_DOXYGEN 135 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::MatrixBase 136 # include "../plugins/CommonCwiseUnaryOps.h" 137 # include "../plugins/CommonCwiseBinaryOps.h" 138 # include "../plugins/MatrixCwiseUnaryOps.h" 139 # include "../plugins/MatrixCwiseBinaryOps.h" 140 # ifdef EIGEN_MATRIXBASE_PLUGIN 141 # include EIGEN_MATRIXBASE_PLUGIN 143 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS 153 template <
typename OtherDerived>
156 template <
typename OtherDerived>
159 template<
typename OtherDerived>
160 Derived&
operator=(
const ReturnByValue<OtherDerived>& other);
162 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
163 Derived& lazyAssign(
const ProductBase<ProductDerived, Lhs,Rhs>& other);
165 template<
typename MatrixPower,
typename Lhs,
typename Rhs>
166 Derived& lazyAssign(
const MatrixPowerProduct<MatrixPower, Lhs,Rhs>& other);
168 template<
typename OtherDerived>
170 template<
typename OtherDerived>
173 template<
typename OtherDerived>
177 template<
typename OtherDerived>
181 template<
typename OtherDerived>
184 template<
typename OtherDerived>
187 template<
typename OtherDerived>
190 template<
typename DiagonalDerived>
191 const DiagonalProduct<Derived, DiagonalDerived, OnTheRight>
194 template<
typename OtherDerived>
195 typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType
198 #ifdef EIGEN2_SUPPORT 199 template<
typename OtherDerived>
204 RealScalar
norm()
const;
211 const AdjointReturnType
adjoint()
const;
217 ConstDiagonalReturnType
diagonal()
const;
222 template<
int Index>
typename DiagonalIndexReturnType<Index>::Type
diagonal();
223 template<
int Index>
typename ConstDiagonalIndexReturnType<Index>::Type
diagonal()
const;
228 DiagonalDynamicIndexReturnType
diagonal(Index index);
229 ConstDiagonalDynamicIndexReturnType
diagonal(Index index)
const;
231 #ifdef EIGEN2_SUPPORT 232 template<
unsigned int Mode>
typename internal::eigen2_part_return_type<Derived, Mode>::type part();
233 template<
unsigned int Mode>
const typename internal::eigen2_part_return_type<Derived, Mode>::type part()
const;
237 template<
template<
typename T,
int N>
class U>
240 #endif // EIGEN2_SUPPORT 245 template<
unsigned int Mode>
typename TriangularViewReturnType<Mode>::Type triangularView();
246 template<
unsigned int Mode>
typename ConstTriangularViewReturnType<Mode>::Type triangularView()
const;
251 template<
unsigned int UpLo>
typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
252 template<
unsigned int UpLo>
typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
254 const SparseView<Derived> sparseView(
const Scalar& m_reference = Scalar(0),
256 static const IdentityReturnType
Identity();
257 static const IdentityReturnType
Identity(Index rows, Index cols);
258 static const BasisReturnType
Unit(Index size, Index i);
259 static const BasisReturnType
Unit(Index i);
260 static const BasisReturnType
UnitX();
261 static const BasisReturnType
UnitY();
262 static const BasisReturnType
UnitZ();
263 static const BasisReturnType
UnitW();
277 template<
typename OtherDerived>
286 template<
typename OtherDerived>
294 template<
typename OtherDerived>
302 template<
bool Enable>
inline typename internal::add_const_on_value_type<typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type>::type
forceAlignedAccessIf()
const;
303 template<
bool Enable>
inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type
forceAlignedAccessIf();
305 Scalar
trace()
const;
309 template<
int p> RealScalar lpNorm()
const;
324 #if EIGEN2_SUPPORT_STAGE < STAGE20_RESOLVE_API_CONFLICTS 325 const LU<PlainObject>
lu()
const;
328 #ifdef EIGEN2_SUPPORT 329 const LU<PlainObject> eigen2_lu()
const;
332 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS 336 #ifdef EIGEN2_SUPPORT 337 template<
typename ResultType>
343 const internal::inverse_impl<Derived>
inverse()
const;
344 template<
typename ResultType>
351 template<
typename ResultType>
370 #ifdef EIGEN2_SUPPORT 371 const QR<PlainObject> qr()
const;
381 #ifdef EIGEN2_SUPPORT 382 SVD<PlainObject> svd()
const;
387 #ifndef EIGEN_PARSED_BY_DOXYGEN 388 template<
typename OtherDerived>
struct cross_product_return_type {
390 typedef typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType Scalar;
393 #endif // EIGEN_PARSED_BY_DOXYGEN 394 template<
typename OtherDerived>
395 typename cross_product_return_type<OtherDerived>::type
397 template<
typename OtherDerived>
402 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS 403 ScalarMultipleReturnType
operator*(
const UniformScaling<Scalar>& s)
const;
413 typedef Block<
const Derived,
414 internal::traits<Derived>::ColsAtCompileTime==1 ? SizeMinusOne : 1,
415 internal::traits<Derived>::ColsAtCompileTime==1 ? 1 : SizeMinusOne>
ConstStartMinusOne;
424 template<
typename EssentialPart>
426 Scalar& tau, RealScalar& beta)
const;
427 template<
typename EssentialPart>
431 template<
typename EssentialPart>
438 template<
typename OtherScalar>
440 template<
typename OtherScalar>
445 template<
typename OtherDerived>
454 typedef typename internal::stem_function<Scalar>::type StemFunction;
455 const MatrixExponentialReturnValue<Derived> exp()
const;
456 const MatrixFunctionReturnValue<Derived> matrixFunction(StemFunction f)
const;
457 const MatrixFunctionReturnValue<Derived> cosh()
const;
458 const MatrixFunctionReturnValue<Derived> sinh()
const;
459 const MatrixFunctionReturnValue<Derived> cos()
const;
460 const MatrixFunctionReturnValue<Derived> sin()
const;
461 const MatrixSquareRootReturnValue<Derived> sqrt()
const;
462 const MatrixLogarithmReturnValue<Derived> log()
const;
463 const MatrixPowerReturnValue<Derived> pow(
const RealScalar& p)
const;
465 #ifdef EIGEN2_SUPPORT 466 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
467 Derived&
operator+=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
470 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
471 Derived&
operator-=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
476 template<
typename OtherDerived>
477 Derived& lazyAssign(
const Flagged<OtherDerived, 0, EvalBeforeAssigningBit>& other)
478 {
return lazyAssign(other._expression()); }
480 template<
unsigned int Added>
481 const Flagged<Derived, Added, 0> marked()
const;
482 const Flagged<Derived, 0, EvalBeforeAssigningBit> lazy()
const;
484 inline const Cwise<Derived> cwise()
const;
485 inline Cwise<Derived> cwise();
496 Minor<Derived> minor(Index
row, Index
col);
497 const Minor<Derived> minor(Index row, Index col)
const;
510 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
513 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
528 template<
typename Derived>
529 template<
typename OtherDerived>
533 other.
derived().applyThisOnTheRight(derived());
542 template<
typename Derived>
543 template<
typename OtherDerived>
546 other.
derived().applyThisOnTheRight(derived());
554 template<
typename Derived>
555 template<
typename OtherDerived>
558 other.
derived().applyThisOnTheLeft(derived());
563 #endif // EIGEN_MATRIXBASE_H Expression of the product of two general matrices or vectors.
Definition: GeneralProduct.h:36
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:49
Robust Cholesky decomposition of a matrix with pivoting.
Definition: LDLT.h:48
RealScalar squaredNorm() const
Definition: Dot.h:113
Matrix< Scalar, 3, 1 > eulerAngles(Index a0, Index a1, Index a2) const
Definition: EulerAngles.h:37
JacobiSVD< PlainObject > jacobiSvd(unsigned int computationOptions=0) const
Definition: JacobiSVD.h:969
RowXpr row(Index i)
Definition: DenseBase.h:750
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:34
void applyHouseholderOnTheRight(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:149
const PartialPivLU< PlainObject > lu() const
Definition: PartialPivLU.h:501
Expression of a mathematical vector or matrix as an array object.
Definition: ArrayWrapper.h:41
Householder rank-revealing QR decomposition of a matrix with full pivoting.
Definition: ForwardDeclarations.h:223
bool isDiagonal(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: DiagonalMatrix.h:292
bool isUpperTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:791
void computeInverseAndDetWithCheck(ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Definition: Inverse.h:347
const FullPivLU< PlainObject > fullPivLu() const
Definition: FullPivLU.h:744
bool isIdentity(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:717
RealScalar operatorNorm() const
Computes the L2 operator norm.
Definition: MatrixBaseEigenvalues.h:122
Pseudo expression providing an operator = assuming no aliasing.
Definition: NoAlias.h:31
Expression of the transpose of a matrix.
Definition: Transpose.h:57
RealScalar blueNorm() const
Definition: StableNorm.h:184
NoAlias< Derived, Eigen::MatrixBase > noalias()
Definition: NoAlias.h:127
LU decomposition of a matrix with partial pivoting, and related features.
Definition: ForwardDeclarations.h:217
Rotation given by a cosine-sine pair.
Definition: ForwardDeclarations.h:228
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:88
const PlainObject normalized() const
Definition: Dot.h:139
static const BasisReturnType UnitZ()
Definition: CwiseNullaryOp.h:849
Definition: Constants.h:264
ColXpr col(Index i)
Definition: DenseBase.h:733
void computeInverseWithCheck(ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Definition: Inverse.h:386
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
const CwiseBinaryOp< internal::scalar_product_op< typename Derived::Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived > cwiseProduct(const Eigen::SparseMatrixBase< OtherDerived > &other) const
Definition: SparseMatrixBase.h:23
const PartialPivLU< PlainObject > partialPivLu() const
Definition: PartialPivLU.h:485
static const BasisReturnType UnitW()
Definition: CwiseNullaryOp.h:859
bool isOrthogonal(const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:228
Definition: Constants.h:212
void makeHouseholder(EssentialPart &essential, Scalar &tau, RealScalar &beta) const
Definition: Householder.h:65
internal::add_const_on_value_type< typename internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type >::type forceAlignedAccessIf() const
Definition: ForceAlignedAccess.h:128
Definition: EigenBase.h:26
Scalar trace() const
Definition: Redux.h:402
void applyHouseholderOnTheLeft(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:112
void applyOnTheLeft(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:556
bool isLowerTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:817
Expression of a fixed-size or dynamic-size sub-vector.
Definition: ForwardDeclarations.h:83
const ScalarMultipleReturnType operator*(const Scalar &scalar) const
Definition: MatrixBase.h:50
void applyOnTheRight(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:544
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:239
const HouseholderQR< PlainObject > householderQr() const
Definition: HouseholderQR.h:381
const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived > cwiseEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:42
const internal::inverse_impl< Derived > inverse() const
Definition: Inverse.h:320
RealScalar norm() const
Definition: Dot.h:125
EigenvaluesReturnType eigenvalues() const
Computes the eigenvalues of a matrix.
Definition: MatrixBaseEigenvalues.h:67
const FullPivHouseholderQR< PlainObject > fullPivHouseholderQr() const
Definition: FullPivHouseholderQR.h:615
const HNormalizedReturnType hnormalized() const
Definition: Homogeneous.h:158
Definition: DenseBase.h:108
Derived & derived()
Definition: EigenBase.h:34
Householder rank-revealing QR decomposition of a matrix with column-pivoting.
Definition: ForwardDeclarations.h:222
Standard Cholesky decomposition (LL^T) of a matrix and associated features.
Definition: LLT.h:50
PlainObject cross3(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:74
Definition: Constants.h:268
DiagonalReturnType diagonal()
Definition: Diagonal.h:168
Expression of a selfadjoint matrix from a triangular part of a dense matrix.
Definition: SelfAdjointView.h:53
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:512
const LazyProductReturnType< Derived, OtherDerived >::Type lazyProduct(const MatrixBase< OtherDerived > &other) const
Definition: GeneralProduct.h:615
ArrayWrapper< Derived > array()
Definition: MatrixBase.h:316
Derived & operator+=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:221
static const BasisReturnType UnitX()
Definition: CwiseNullaryOp.h:829
void adjointInPlace()
Definition: Transpose.h:323
void normalize()
Definition: Dot.h:154
Definition: Constants.h:209
internal::traits< Derived >::Index Index
The type of indices.
Definition: DenseBase.h:60
internal::scalar_product_traits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType dot(const MatrixBase< OtherDerived > &other) const
Definition: Dot.h:63
const unsigned int EvalBeforeAssigningBit
Definition: Constants.h:63
PlainObject unitOrthogonal(void) const
Definition: OrthoMethods.h:210
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
void makeHouseholderInPlace(Scalar &tau, RealScalar &beta)
Definition: Householder.h:42
Index diagonalSize() const
Definition: MatrixBase.h:101
LU decomposition of a matrix with complete pivoting, and related features.
Definition: ForwardDeclarations.h:216
const CwiseBinaryOp< std::not_equal_to< Scalar >, const Derived, const OtherDerived > cwiseNotEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:61
Scalar determinant() const
Definition: Determinant.h:92
Householder QR decomposition of a matrix.
Definition: ForwardDeclarations.h:221
HomogeneousReturnType homogeneous() const
Definition: Homogeneous.h:127
Two-sided Jacobi SVD decomposition of a rectangular matrix.
Definition: ForwardDeclarations.h:224
Base class for triangular part in a matrix.
Definition: TriangularMatrix.h:158
static const IdentityReturnType Identity()
Definition: CwiseNullaryOp.h:700
Derived & setIdentity()
Definition: CwiseNullaryOp.h:772
Expression of a diagonal matrix.
Definition: DiagonalMatrix.h:248
Definition: Constants.h:266
RealScalar stableNorm() const
Definition: StableNorm.h:153
Definition: DenseBase.h:115
const ForceAlignedAccess< Derived > forceAlignedAccess() const
Definition: ForceAlignedAccess.h:107
RealScalar hypotNorm() const
Definition: StableNorm.h:196
const unsigned int RowMajorBit
Definition: Constants.h:53
static const BasisReturnType UnitY()
Definition: CwiseNullaryOp.h:839
Derived & operator-=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:207
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Definition: Diagonal.h:64
Generic expression where a coefficient-wise unary operator is applied to an expression.
Definition: CwiseUnaryOp.h:59
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:127
static const BasisReturnType Unit(Index size, Index i)
Definition: CwiseNullaryOp.h:801
const AdjointReturnType adjoint() const
Definition: Transpose.h:237
bool operator==(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:287
bool operator!=(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:295
const DiagonalWrapper< const Derived > asDiagonal() const
Definition: DiagonalMatrix.h:278
const LLT< PlainObject > llt() const
Definition: LLT.h:481
const CwiseBinaryOp< internal::scalar_product_op< typename Derived::Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived > cwiseProduct(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:23
Definition: DenseBase.h:102
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:48
const LDLT< PlainObject > ldlt() const
Definition: LDLT.h:604
Derived & operator*=(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:531
bool isUnitary(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:247
Expression of one (or a set of) homogeneous vector(s)
Definition: ForwardDeclarations.h:268
const ColPivHouseholderQR< PlainObject > colPivHouseholderQr() const
Definition: ColPivHouseholderQR.h:573
Derived & operator=(const MatrixBase &other)
Definition: Assign.h:562