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/=;
84 typedef typename Base::CoeffReturnType CoeffReturnType;
86 typedef typename Base::RowXpr RowXpr;
87 typedef typename Base::ColXpr ColXpr;
88 #endif // not EIGEN_PARSED_BY_DOXYGEN 92 #ifndef EIGEN_PARSED_BY_DOXYGEN 96 #endif // not EIGEN_PARSED_BY_DOXYGEN 105 #ifndef EIGEN_PARSED_BY_DOXYGEN 109 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
111 ConstTransposeReturnType
112 >::type AdjointReturnType;
119 internal::traits<Derived>::RowsAtCompileTime,
120 internal::traits<Derived>::ColsAtCompileTime> BasisReturnType;
121 #endif // not EIGEN_PARSED_BY_DOXYGEN 123 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::MatrixBase 124 #define EIGEN_DOC_UNARY_ADDONS(X,Y) 125 # include "../plugins/CommonCwiseUnaryOps.h" 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
164 template<
typename OtherDerived>
171 template<
typename OtherDerived>
177 template<
typename OtherDerived>
182 template<
typename OtherDerived>
185 template<
typename OtherDerived>
188 template<
typename OtherDerived>
191 template<
typename DiagonalDerived>
196 template<
typename OtherDerived>
202 EIGEN_DEVICE_FUNC RealScalar
norm()
const;
206 EIGEN_DEVICE_FUNC
const PlainObject
normalized()
const;
211 EIGEN_DEVICE_FUNC
const AdjointReturnType
adjoint()
const;
220 ConstDiagonalReturnType
diagonal()
const;
227 typename DiagonalIndexReturnType<Index>::Type
diagonal();
231 typename ConstDiagonalIndexReturnType<Index>::Type
diagonal()
const;
239 ConstDiagonalDynamicIndexReturnType
diagonal(
Index index)
const;
244 template<
unsigned int Mode>
246 typename TriangularViewReturnType<Mode>::Type triangularView();
247 template<
unsigned int Mode>
249 typename ConstTriangularViewReturnType<Mode>::Type triangularView()
const;
254 template<
unsigned int UpLo>
256 typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
257 template<
unsigned int UpLo>
259 typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
263 EIGEN_DEVICE_FUNC
static const IdentityReturnType
Identity();
266 EIGEN_DEVICE_FUNC
static const BasisReturnType
Unit(
Index i);
267 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitX();
268 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitY();
269 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitZ();
270 EIGEN_DEVICE_FUNC
static const BasisReturnType
UnitW();
287 template<
typename OtherDerived>
296 template<
typename OtherDerived>
304 template<
typename OtherDerived>
314 template<
bool Enable>
inline const Derived& forceAlignedAccessIf()
const {
return derived(); }
315 template<
bool Enable>
inline Derived& forceAlignedAccessIf() {
return derived(); }
317 EIGEN_DEVICE_FUNC Scalar
trace()
const;
319 template<
int p> EIGEN_DEVICE_FUNC RealScalar
lpNorm()
const;
340 template<
typename ResultType>
347 template<
typename ResultType>
379 #ifndef EIGEN_PARSED_BY_DOXYGEN 380 template<
typename OtherDerived>
struct cross_product_return_type {
382 typedef typename ScalarBinaryOpTraits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType
Scalar;
385 #endif // EIGEN_PARSED_BY_DOXYGEN 386 template<
typename OtherDerived>
388 #ifndef EIGEN_PARSED_BY_DOXYGEN 389 inline typename cross_product_return_type<OtherDerived>::type
395 template<
typename OtherDerived>
415 typedef Block<
const Derived,
416 internal::traits<Derived>::ColsAtCompileTime==1 ? SizeMinusOne : 1,
417 internal::traits<Derived>::ColsAtCompileTime==1 ? 1 : SizeMinusOne>
ConstStartMinusOne;
418 typedef EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(ConstStartMinusOne,Scalar,quotient) HNormalizedReturnType;
420 inline const HNormalizedReturnType
hnormalized()
const;
425 template<
typename EssentialPart>
427 Scalar& tau, RealScalar& beta)
const;
428 template<
typename EssentialPart>
432 template<
typename EssentialPart>
439 template<
typename OtherScalar>
441 template<
typename OtherScalar>
446 template<
typename OtherDerived>
455 typedef typename internal::stem_function<Scalar>::type StemFunction;
456 const MatrixExponentialReturnValue<Derived> exp()
const;
457 const MatrixFunctionReturnValue<Derived> matrixFunction(StemFunction f)
const;
458 const MatrixFunctionReturnValue<Derived>
cosh()
const;
459 const MatrixFunctionReturnValue<Derived>
sinh()
const;
460 const MatrixFunctionReturnValue<Derived> cos()
const;
461 const MatrixFunctionReturnValue<Derived> sin()
const;
462 const MatrixSquareRootReturnValue<Derived> sqrt()
const;
463 const MatrixLogarithmReturnValue<Derived> log()
const;
464 const MatrixPowerReturnValue<Derived> pow(
const RealScalar& p)
const;
465 const MatrixComplexPowerReturnValue<Derived> pow(
const std::complex<RealScalar>& p)
const;
471 EIGEN_DEVICE_FUNC
explicit MatrixBase(
int);
472 EIGEN_DEVICE_FUNC MatrixBase(
int,
int);
477 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
480 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
495 template<
typename Derived>
496 template<
typename OtherDerived>
509 template<
typename Derived>
510 template<
typename OtherDerived>
521 template<
typename Derived>
522 template<
typename OtherDerived>
530 #endif // EIGEN_MATRIXBASE_H Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:60
Scalar trace() const
Definition: Redux.h:498
Robust Cholesky decomposition of a matrix with pivoting.
Definition: LDLT.h:50
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
void makeHouseholder(EssentialPart &essential, Scalar &tau, RealScalar &beta) const
Definition: Householder.h:65
RealScalar blueNorm() const
Definition: StableNorm.h:202
Definition: DenseBase.h:100
BDCSVD< PlainObject > bdcSvd(unsigned int computationOptions=0) const
Definition: BDCSVD.h:1223
const CwiseBinaryOp< std::not_equal_to< Scalar >, const Derived, const OtherDerived > cwiseNotEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:64
const Eigen::CwiseUnaryOp< Eigen::internal::scalar_sinh_op< typename Derived::Scalar >, const Derived > sinh(const Eigen::ArrayBase< Derived > &x)
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
Definition: Constants.h:320
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: ForwardDeclarations.h:256
const AdjointReturnType adjoint() const
Definition: Transpose.h:210
const CompleteOrthogonalDecomposition< PlainObject > completeOrthogonalDecomposition() const
Definition: CompleteOrthogonalDecomposition.h:556
void applyOnTheLeft(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:523
Definition: Constants.h:265
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:861
bool isUnitary(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:299
const ColPivHouseholderQR< PlainObject > colPivHouseholderQr() const
Definition: ColPivHouseholderQR.h:646
const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived > cwiseEqual(const Eigen::MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:44
void applyOnTheRight(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:511
LU decomposition of a matrix with partial pivoting, and related features.
Definition: ForwardDeclarations.h:250
Namespace containing all symbols from the Eigen library.
Definition: Core:287
Rotation given by a cosine-sine pair.
Definition: ForwardDeclarations.h:263
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:150
const PlainObject normalized() const
Definition: Dot.h:121
Derived & setIdentity()
Definition: CwiseNullaryOp.h:774
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:45
Complete orthogonal decomposition (COD) of a matrix.
Definition: ForwardDeclarations.h:257
RealScalar stableNorm() const
Definition: StableNorm.h:157
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:38
const FullPivLU< PlainObject > fullPivLu() const
Definition: FullPivLU.h:884
const unsigned int RowMajorBit
Definition: Constants.h:61
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
PlainObject cross3(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:82
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:113
PlainObject unitOrthogonal(void) const
Definition: OrthoMethods.h:226
void computeInverseAndDetWithCheck(ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Definition: InverseImpl.h:362
void normalize()
Definition: Dot.h:142
RealScalar norm() const
Definition: Dot.h:105
Expression of the inverse of another expression.
Definition: Inverse.h:43
bool operator!=(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:305
bool isUpperTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:648
static const BasisReturnType UnitX()
Definition: CwiseNullaryOp.h:831
Derived & operator+=(const MatrixBase< OtherDerived > &other)
Definition: CwiseBinaryOp.h:175
void stableNormalize()
Definition: Dot.h:188
const Derived & forceAlignedAccess() const
Definition: MatrixBase.h:312
RealScalar squaredNorm() const
Definition: Dot.h:93
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:281
Index size() const
Definition: EigenBase.h:66
JacobiSVD< PlainObject > jacobiSvd(unsigned int computationOptions=0) const
Definition: JacobiSVD.h:797
PlainObject cross(const MatrixBase< OtherDerived > &other) const
Definition: OrthoMethods.h:34
Index rows() const
Definition: EigenBase.h:59
ArrayWrapper< Derived > array()
Definition: MatrixBase.h:326
Householder rank-revealing QR decomposition of a matrix with column-pivoting.
Definition: ForwardDeclarations.h:255
Standard Cholesky decomposition (LL^T) of a matrix and associated features.
Definition: LLT.h:52
const HouseholderQR< PlainObject > householderQr() const
Definition: HouseholderQR.h:402
const ArrayWrapper< const Derived > array() const
Definition: MatrixBase.h:329
bool isDiagonal(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: DiagonalMatrix.h:291
Expression of a selfadjoint matrix from a triangular part of a dense matrix.
Definition: SelfAdjointView.h:49
Expression of a dense or sparse matrix with zero or too small values removed.
Definition: ForwardDeclarations.h:126
const DiagonalWrapper< const Derived > asDiagonal() const
Definition: DiagonalMatrix.h:277
static const BasisReturnType UnitY()
Definition: CwiseNullaryOp.h:841
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:514
void adjointInPlace()
Definition: Transpose.h:315
static const BasisReturnType Unit(Index size, Index i)
Definition: CwiseNullaryOp.h:803
Definition: DenseBase.h:106
const PartialPivLU< PlainObject > partialPivLu() const
Definition: PartialPivLU.h:589
class Bidiagonal Divide and Conquer SVD
Definition: ForwardDeclarations.h:259
const LDLT< PlainObject > ldlt() const
Definition: LDLT.h:662
Definition: Constants.h:268
RealScalar operatorNorm() const
Computes the L2 operator norm.
Definition: MatrixBaseEigenvalues.h:122
const Eigen::CwiseUnaryOp< Eigen::internal::scalar_cosh_op< typename Derived::Scalar >, const Derived > cosh(const Eigen::ArrayBase< Derived > &x)
const PlainObject stableNormalized() const
Definition: Dot.h:164
const Inverse< Derived > inverse() const
Definition: InverseImpl.h:335
bool isLowerTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: TriangularMatrix.h:673
const HNormalizedReturnType hnormalized() const
homogeneous normalization
Definition: Homogeneous.h:172
internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
The plain matrix or array type corresponding to this expression.
Definition: DenseBase.h:205
static const IdentityReturnType Identity()
Definition: CwiseNullaryOp.h:700
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:225
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:69
LU decomposition of a matrix with complete pivoting, and related features.
Definition: ForwardDeclarations.h:249
void applyHouseholderOnTheRight(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Definition: Householder.h:150
RealScalar lpNorm() const
Definition: Dot.h:264
Householder QR decomposition of a matrix.
Definition: ForwardDeclarations.h:254
Two-sided Jacobi SVD decomposition of a rectangular matrix.
Definition: ForwardDeclarations.h:258
Expression of a triangular part in a matrix.
Definition: TriangularMatrix.h:186
Derived & operator=(const MatrixBase &other)
Definition: Assign.h:55
Expression of a diagonal matrix.
Definition: DiagonalMatrix.h:245
Derived & forceAlignedAccess()
Definition: MatrixBase.h:313
const LLT< PlainObject > llt() const
Definition: LLT.h:516
Derived & operator*=(const EigenBase< OtherDerived > &other)
Definition: MatrixBase.h:498
DiagonalReturnType diagonal()
Definition: Diagonal.h:188
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
Definition: XprHelper.h:766
NoAlias< Derived, Eigen::MatrixBase > noalias()
Definition: NoAlias.h:101
bool isOrthogonal(const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Dot.h:280
const PartialPivLU< PlainObject > lu() const
Definition: PartialPivLU.h:604
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Definition: Diagonal.h:63
void makeHouseholderInPlace(Scalar &tau, RealScalar &beta)
Definition: Householder.h:42
const int Dynamic
Definition: Constants.h:21
bool isIdentity(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:717
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:401
HomogeneousReturnType homogeneous() const
Definition: Homogeneous.h:130
Index cols() const
Definition: EigenBase.h:62
bool operator==(const MatrixBase< OtherDerived > &other) const
Definition: MatrixBase.h:297
Index diagonalSize() const
Definition: MatrixBase.h:101
const FullPivHouseholderQR< PlainObject > fullPivHouseholderQr() const
Definition: FullPivHouseholderQR.h:669
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:92
static const BasisReturnType UnitZ()
Definition: CwiseNullaryOp.h:851
const Product< Derived, OtherDerived, LazyProduct > lazyProduct(const MatrixBase< OtherDerived > &other) const
Definition: GeneralProduct.h:431
Expression of one (or a set of) homogeneous vector(s)
Definition: ForwardDeclarations.h:278
RealScalar hypotNorm() const
Definition: StableNorm.h:214