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 #ifndef EIGEN_PARSED_BY_DOXYGEN
163 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
164 Derived& lazyAssign(
const ProductBase<ProductDerived, Lhs,Rhs>& other);
166 template<
typename MatrixPower,
typename Lhs,
typename Rhs>
167 Derived& lazyAssign(
const MatrixPowerProduct<MatrixPower, Lhs,Rhs>& other);
168 #endif // not EIGEN_PARSED_BY_DOXYGEN
170 template<
typename OtherDerived>
172 template<
typename OtherDerived>
175 template<
typename OtherDerived>
179 template<
typename OtherDerived>
183 template<
typename OtherDerived>
186 template<
typename OtherDerived>
189 template<
typename OtherDerived>
192 template<
typename DiagonalDerived>
193 const DiagonalProduct<Derived, DiagonalDerived, OnTheRight>
196 template<
typename OtherDerived>
197 typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType
200 #ifdef EIGEN2_SUPPORT
201 template<
typename OtherDerived>
206 RealScalar
norm()
const;
213 const AdjointReturnType
adjoint()
const;
219 ConstDiagonalReturnType
diagonal()
const;
224 template<
int Index>
typename DiagonalIndexReturnType<Index>::Type
diagonal();
225 template<
int Index>
typename ConstDiagonalIndexReturnType<Index>::Type
diagonal()
const;
227 typedef Diagonal<Derived,DynamicIndex> DiagonalDynamicIndexReturnType;
228 typedef typename internal::add_const<Diagonal<const Derived,DynamicIndex> >::type ConstDiagonalDynamicIndexReturnType;
230 DiagonalDynamicIndexReturnType
diagonal(Index index);
231 ConstDiagonalDynamicIndexReturnType
diagonal(Index index)
const;
233 #ifdef EIGEN2_SUPPORT
234 template<
unsigned int Mode>
typename internal::eigen2_part_return_type<Derived, Mode>::type part();
235 template<
unsigned int Mode>
const typename internal::eigen2_part_return_type<Derived, Mode>::type part()
const;
239 template<
template<
typename T,
int N>
class U>
240 const DiagonalWrapper<ConstDiagonalReturnType> part()
const
242 #endif // EIGEN2_SUPPORT
244 template<
unsigned int Mode>
struct TriangularViewReturnType {
typedef TriangularView<Derived, Mode> Type; };
245 template<
unsigned int Mode>
struct ConstTriangularViewReturnType {
typedef const TriangularView<const Derived, Mode> Type; };
247 template<
unsigned int Mode>
typename TriangularViewReturnType<Mode>::Type triangularView();
248 template<
unsigned int Mode>
typename ConstTriangularViewReturnType<Mode>::Type triangularView()
const;
250 template<
unsigned int UpLo>
struct SelfAdjointViewReturnType {
typedef SelfAdjointView<Derived, UpLo> Type; };
251 template<
unsigned int UpLo>
struct ConstSelfAdjointViewReturnType {
typedef const SelfAdjointView<const Derived, UpLo> Type; };
253 template<
unsigned int UpLo>
typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
254 template<
unsigned int UpLo>
typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
256 const SparseView<Derived> sparseView(
const Scalar& m_reference = Scalar(0),
257 const typename NumTraits<Scalar>::Real& m_epsilon = NumTraits<Scalar>::dummy_precision())
const;
258 static const IdentityReturnType
Identity();
259 static const IdentityReturnType
Identity(Index rows, Index cols);
260 static const BasisReturnType
Unit(Index size, Index i);
261 static const BasisReturnType
Unit(Index i);
262 static const BasisReturnType
UnitX();
263 static const BasisReturnType
UnitY();
264 static const BasisReturnType
UnitZ();
265 static const BasisReturnType
UnitW();
267 const DiagonalWrapper<const Derived>
asDiagonal()
const;
268 const PermutationWrapper<const Derived> asPermutation()
const;
273 bool isIdentity(
const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
274 bool isDiagonal(
const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
276 bool isUpperTriangular(
const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
277 bool isLowerTriangular(
const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
279 template<
typename OtherDerived>
280 bool isOrthogonal(
const MatrixBase<OtherDerived>& other,
281 const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
282 bool isUnitary(
const RealScalar& prec = NumTraits<Scalar>::dummy_precision())
const;
288 template<
typename OtherDerived>
296 template<
typename OtherDerived>
304 template<
bool Enable>
inline typename internal::add_const_on_value_type<typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type>::type forceAlignedAccessIf()
const;
305 template<
bool Enable>
inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf();
307 Scalar
trace()
const;
311 template<
int p> RealScalar lpNorm()
const;
314 const MatrixBase<Derived>& matrix()
const {
return *
this; }
323 const FullPivLU<PlainObject>
fullPivLu()
const;
326 #if EIGEN2_SUPPORT_STAGE < STAGE20_RESOLVE_API_CONFLICTS
327 const LU<PlainObject>
lu()
const;
330 #ifdef EIGEN2_SUPPORT
331 const LU<PlainObject> eigen2_lu()
const;
334 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS
335 const PartialPivLU<PlainObject>
lu()
const;
338 #ifdef EIGEN2_SUPPORT
339 template<
typename ResultType>
340 void computeInverse(MatrixBase<ResultType> *result)
const {
345 const internal::inverse_impl<Derived>
inverse()
const;
346 template<
typename ResultType>
351 const RealScalar& absDeterminantThreshold = NumTraits<Scalar>::dummy_precision()
353 template<
typename ResultType>
357 const RealScalar& absDeterminantThreshold = NumTraits<Scalar>::dummy_precision()
363 const LLT<PlainObject>
llt()
const;
364 const LDLT<PlainObject>
ldlt()
const;
372 #ifdef EIGEN2_SUPPORT
373 const QR<PlainObject> qr()
const;
381 JacobiSVD<PlainObject>
jacobiSvd(
unsigned int computationOptions = 0)
const;
383 #ifdef EIGEN2_SUPPORT
384 SVD<PlainObject> svd()
const;
389 #ifndef EIGEN_PARSED_BY_DOXYGEN
390 template<
typename OtherDerived>
struct cross_product_return_type {
392 typedef typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType Scalar;
393 typedef Matrix<Scalar,MatrixBase::RowsAtCompileTime,MatrixBase::ColsAtCompileTime> type;
395 #endif // EIGEN_PARSED_BY_DOXYGEN
396 template<
typename OtherDerived>
397 typename cross_product_return_type<OtherDerived>::type
398 cross(
const MatrixBase<OtherDerived>& other)
const;
399 template<
typename OtherDerived>
402 Matrix<Scalar,3,1>
eulerAngles(Index a0, Index a1, Index a2)
const;
404 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS
405 ScalarMultipleReturnType
operator*(
const UniformScaling<Scalar>& s)
const;
408 typedef Homogeneous<Derived, HomogeneousReturnTypeDirection> HomogeneousReturnType;
415 typedef Block<
const Derived,
416 internal::traits<Derived>::ColsAtCompileTime==1 ? SizeMinusOne : 1,
417 internal::traits<Derived>::ColsAtCompileTime==1 ? 1 : SizeMinusOne> ConstStartMinusOne;
418 typedef CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>,
419 const ConstStartMinusOne > HNormalizedReturnType;
426 template<
typename EssentialPart>
428 Scalar& tau, RealScalar& beta)
const;
429 template<
typename EssentialPart>
433 template<
typename EssentialPart>
440 template<
typename OtherScalar>
441 void applyOnTheLeft(Index p, Index q,
const JacobiRotation<OtherScalar>& j);
442 template<
typename OtherScalar>
443 void applyOnTheRight(Index p, Index q,
const JacobiRotation<OtherScalar>& j);
447 typedef typename internal::stem_function<Scalar>::type StemFunction;
448 const MatrixExponentialReturnValue<Derived> exp()
const;
449 const MatrixFunctionReturnValue<Derived> matrixFunction(StemFunction f)
const;
450 const MatrixFunctionReturnValue<Derived> cosh()
const;
451 const MatrixFunctionReturnValue<Derived> sinh()
const;
452 const MatrixFunctionReturnValue<Derived> cos()
const;
453 const MatrixFunctionReturnValue<Derived> sin()
const;
454 const MatrixSquareRootReturnValue<Derived> sqrt()
const;
455 const MatrixLogarithmReturnValue<Derived> log()
const;
456 const MatrixPowerReturnValue<Derived> pow(
const RealScalar& p)
const;
458 #ifdef EIGEN2_SUPPORT
459 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
460 Derived&
operator+=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
463 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
464 Derived&
operator-=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
469 template<
typename OtherDerived>
470 Derived& lazyAssign(
const Flagged<OtherDerived, 0, EvalBeforeAssigningBit>& other)
471 {
return lazyAssign(other._expression()); }
473 template<
unsigned int Added>
474 const Flagged<Derived, Added, 0> marked()
const;
475 const Flagged<Derived, 0, EvalBeforeAssigningBit> lazy()
const;
477 inline const Cwise<Derived> cwise()
const;
478 inline Cwise<Derived> cwise();
480 VectorBlock<Derived> start(Index size);
481 const VectorBlock<const Derived> start(Index size)
const;
482 VectorBlock<Derived> end(Index size);
483 const VectorBlock<const Derived> end(Index size)
const;
484 template<
int Size> VectorBlock<Derived,Size> start();
485 template<
int Size>
const VectorBlock<const Derived,Size> start()
const;
486 template<
int Size> VectorBlock<Derived,Size> end();
487 template<
int Size>
const VectorBlock<const Derived,Size> end()
const;
489 Minor<Derived> minor(Index
row, Index
col);
490 const Minor<Derived> minor(Index
row, Index
col)
const;
494 MatrixBase() : Base() {}
497 explicit MatrixBase(
int);
499 template<
typename OtherDerived>
explicit MatrixBase(
const MatrixBase<OtherDerived>&);
502 template<
typename OtherDerived> Derived&
operator+=(
const ArrayBase<OtherDerived>& )
503 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
505 template<
typename OtherDerived> Derived&
operator-=(
const ArrayBase<OtherDerived>& )
506 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
521 template<
typename Derived>
522 template<
typename OtherDerived>
526 other.
derived().applyThisOnTheRight(derived());
535 template<
typename Derived>
536 template<
typename OtherDerived>
539 other.
derived().applyThisOnTheRight(derived());
547 template<
typename Derived>
548 template<
typename OtherDerived>
551 other.
derived().applyThisOnTheLeft(derived());
556 #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
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:962
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:493
Expression of a mathematical vector or matrix as an array object.
Definition: ArrayWrapper.h:41
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:736
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
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
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 PartialPivLU< PlainObject > partialPivLu() const
Definition: PartialPivLU.h:477
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
const CwiseUnaryOp< std::binder1st< std::equal_to< Scalar > >, const Derived > cwiseEqual(const Scalar &s) const
Definition: MatrixBase.h:64
Definition: EigenBase.h:26
Scalar trace() const
Definition: Redux.h:401
void applyHouseholderOnTheLeft(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:112
void applyOnTheLeft(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:549
bool isLowerTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:817
const ScalarMultipleReturnType operator*(const Scalar &scalar) const
Definition: MatrixBase.h:50
void applyOnTheRight(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:537
const HouseholderQR< PlainObject > householderQr() const
Definition: HouseholderQR.h:367
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:607
const HNormalizedReturnType hnormalized() const
Definition: Homogeneous.h:158
Definition: DenseBase.h:108
Derived & derived()
Definition: EigenBase.h:34
PlainObject cross3(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:74
DiagonalReturnType diagonal()
Definition: Diagonal.h:168
ArrayWrapper< Derived > array()
Definition: MatrixBase.h:318
Derived & operator+=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:220
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:61
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:102
void makeHouseholderInPlace(Scalar &tau, RealScalar &beta)
Definition: Householder.h:42
Index diagonalSize() const
Definition: MatrixBase.h:101
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
Definition: Constants.h:268
HomogeneousReturnType homogeneous() const
Definition: Homogeneous.h:127
static const IdentityReturnType Identity()
Definition: CwiseNullaryOp.h:700
Derived & setIdentity()
Definition: CwiseNullaryOp.h:772
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:206
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:289
bool operator!=(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:297
const DiagonalWrapper< const Derived > asDiagonal() const
Definition: DiagonalMatrix.h:278
const LLT< PlainObject > llt() const
Definition: LLT.h:473
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:597
Matrix< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime > PlainObject
The plain matrix type corresponding to this expression.
Definition: MatrixBase.h:115
Definition: Constants.h:266
Derived & operator*=(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:524
bool isUnitary(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:247
const ColPivHouseholderQR< PlainObject > colPivHouseholderQr() const
Definition: ColPivHouseholderQR.h:573
Derived & operator=(const MatrixBase &other)
Definition: Assign.h:555
Definition: Constants.h:264