Go to the documentation of this file.
11 #ifndef EIGEN_MATRIXBASE_H
12 #define EIGEN_MATRIXBASE_H
52 #ifndef EIGEN_PARSED_BY_DOXYGEN
71 using Base::const_cast_derived;
79 using Base::operator-;
80 using Base::operator+=;
81 using Base::operator-=;
82 using Base::operator*=;
83 using Base::operator/=;
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
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
144 template <
typename OtherDerived>
148 template <
typename OtherDerived>
152 template<
typename OtherDerived>
156 template<
typename OtherDerived>
159 template<
typename OtherDerived>
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>
190 dot(
const MatrixBase<OtherDerived>&
other)
const;
235 template<
unsigned int Mode>
238 template<
unsigned int Mode>
245 template<
unsigned int UpLo>
248 template<
unsigned int UpLo>
280 template<
typename OtherDerived>
289 template<
typename OtherDerived>
297 template<
typename OtherDerived>
334 template<
typename ResultType>
342 template<
typename ResultType>
376 #ifndef EIGEN_PARSED_BY_DOXYGEN
377 template<
typename OtherDerived>
struct cross_product_return_type {
382 #endif // EIGEN_PARSED_BY_DOXYGEN
383 template<
typename OtherDerived>
385 #ifndef EIGEN_PARSED_BY_DOXYGEN
392 template<
typename OtherDerived>
412 typedef Block<
const Derived,
417 inline const HNormalizedReturnType
hnormalized()
const;
423 template<
typename EssentialPart>
427 template<
typename EssentialPart>
432 template<
typename EssentialPart>
440 template<
typename OtherScalar>
443 template<
typename OtherScalar>
449 template<
typename OtherDerived>
453 return other.cwiseProduct(derived());
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;
471 #if EIGEN_HAS_CXX11_MATH
512 template<
typename Derived>
513 template<
typename OtherDerived>
517 other.derived().applyThisOnTheRight(derived());
526 template<
typename Derived>
527 template<
typename OtherDerived>
530 other.derived().applyThisOnTheRight(derived());
538 template<
typename Derived>
539 template<
typename OtherDerived>
542 other.derived().applyThisOnTheLeft(derived());
547 #endif // EIGEN_MATRIXBASE_H
Expression of the inverse of another expression.
const PartialPivLU< PlainObject > lu() const
void computeInverseWithCheck(ResultType &inverse, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
JacobiSVD< PlainObject > jacobiSvd(unsigned int computationOptions=0) const
static const EIGEN_DEVICE_FUNC BasisReturnType UnitX()
Diagonal< Derived, Index > Type
DenseBase< Derived > Base
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.
void computeInverseAndDetWithCheck(ResultType &inverse, typename ResultType::Scalar &determinant, bool &invertible, const RealScalar &absDeterminantThreshold=NumTraits< Scalar >::dummy_precision()) const
Derived & operator+=(const ArrayBase< OtherDerived > &)
internal::stem_function< Scalar >::type StemFunction
#define EIGEN_DEVICE_FUNC
internal::add_const< Diagonal< const Derived > >::type ConstDiagonalReturnType
Namespace containing all symbols from the Eigen library.
ScalarBinaryOpTraits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType Scalar
EIGEN_DEVICE_FUNC void applyHouseholderOnTheLeft(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Block< Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor > RowXpr
LU decomposition of a matrix with partial pivoting, and related features.
Expression of a fixed-size or dynamic-size block.
const Derived & forceAlignedAccess() const
bool isOrthogonal(const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const LLT< PlainObject > llt() const
const FullPivHouseholderQR< PlainObject > fullPivHouseholderQr() const
#define EIGEN_DEFAULT_EMPTY_CONSTRUCTOR_AND_DESTRUCTOR(Derived)
const EIGEN_DEVICE_FUNC DiagonalWrapper< const Derived > asDiagonal() const
Jet< T, N > sin(const Jet< T, N > &f)
internal::traits< Derived >::Scalar Scalar
const EIGEN_DEVICE_FUNC PlainObject normalized() const
static const EIGEN_DEVICE_FUNC BasisReturnType UnitW()
@ HomogeneousReturnTypeDirection
const unsigned int RowMajorBit
static const EIGEN_DEVICE_FUNC BasisReturnType UnitZ()
void applyOnTheRight(const EigenBase< OtherDerived > &other)
const typedef TriangularView< const Derived, Mode > Type
EIGEN_DEVICE_FUNC RealScalar lpNorm() const
EigenvaluesReturnType eigenvalues() const
Computes the eigenvalues of a matrix.
EIGEN_DEVICE_FUNC SelfAdjointViewReturnType< UpLo >::Type selfadjointView()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator+=(const MatrixBase< OtherDerived > &other)
Block< const Derived, internal::traits< Derived >::ColsAtCompileTime==1 ? SizeMinusOne :1, internal::traits< Derived >::ColsAtCompileTime==1 ? 1 :SizeMinusOne > ConstStartMinusOne
const EIGEN_DEVICE_FUNC LogReturnType log() const
EIGEN_DEVICE_FUNC void applyHouseholderOnTheRight(const EssentialPart &essential, const Scalar &tau, Scalar *workspace)
Expression of a selfadjoint matrix from a triangular part of a dense matrix.
Expression of a mathematical vector or matrix as an array object.
Determines whether the given binary operation of two numeric types is allowed and what the scalar ret...
EIGEN_DEVICE_FUNC MatrixBase< Derived > & matrix()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator-=(const MatrixBase< OtherDerived > &other)
const MatrixFunctionReturnValue< Derived > matrixFunction(StemFunction f) const
Helper function for the unsupported MatrixFunctions module.
#define EIGEN_SIZE_MAX(a, b)
const EIGEN_DEVICE_FUNC ExpReturnType exp() const
Pseudo expression providing an operator = assuming no aliasing.
EIGEN_DEVICE_FUNC cross_product_return_type< OtherDerived >::type cross(const MatrixBase< OtherDerived > &other) const
Rotation given by a cosine-sine pair.
const FullPivLU< PlainObject > fullPivLu() const
LU decomposition of a matrix with complete pivoting, and related features.
EIGEN_DEVICE_FUNC MatrixBase(int)
EIGEN_DEVICE_FUNC Matrix< Scalar, 3, 1 > eulerAngles(Index a0, Index a1, Index a2) const
double beta(double a, double b)
const ColPivHouseholderQR< PlainObject > colPivHouseholderQr() const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType eval() const
Jet< T, N > cos(const Jet< T, N > &f)
EIGEN_DEVICE_FUNC bool operator!=(const MatrixBase< OtherDerived > &other) const
EIGEN_DEVICE_FUNC void makeHouseholder(EssentialPart &essential, Scalar &tau, RealScalar &beta) const
Generic expression of a matrix where all coefficients are defined by a functor.
const Derived & forceAlignedAccessIf() const
Expression of one (or a set of) homogeneous vector(s)
const PermutationWrapper< const Derived > asPermutation() const
const EIGEN_DEVICE_FUNC CoshReturnType cosh() const
Block< const CwiseNullaryOp< internal::scalar_identity_op< Scalar >, SquareMatrixType >, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime > BasisReturnType
static const EIGEN_DEVICE_FUNC BasisReturnType UnitY()
internal::add_const< Diagonal< const Derived, DynamicIndex > >::type ConstDiagonalDynamicIndexReturnType
RealScalar hypotNorm() const
const EIGEN_DEVICE_FUNC Inverse< Derived > inverse() const
Householder rank-revealing QR decomposition of a matrix with full pivoting.
NumTraits< Scalar >::Real RealScalar
RealScalar operatorNorm() const
Computes the L2 operator norm.
EIGEN_DEVICE_FUNC PlainObject cross3(const MatrixBase< OtherDerived > &other) const
static const EIGEN_DEVICE_FUNC IdentityReturnType Identity()
bool isDiagonal(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived & lazyAssign(const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC void normalize()
Class to view a vector of integers as a permutation matrix.
EIGEN_DEVICE_FUNC const Scalar & q
const EIGEN_DEVICE_FUNC SquareReturnType square() const
Base::CoeffReturnType CoeffReturnType
CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject > ConstantReturnType
class Bidiagonal Divide and Conquer SVD
EIGEN_DEVICE_FUNC EIGEN_ALWAYS_INLINE T mini(const T &x, const T &y)
Expression of a diagonal/subdiagonal/superdiagonal in a matrix.
Diagonal< Derived, DynamicIndex > DiagonalDynamicIndexReturnType
#define EIGEN_STRONG_INLINE
Matrix< Scalar, MatrixBase::RowsAtCompileTime, MatrixBase::ColsAtCompileTime > type
const EIGEN_DEVICE_FUNC CwiseBinaryOp< numext::not_equal_to< Scalar >, const Derived, const OtherDerived > cwiseNotEqual(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
Complete orthogonal decomposition (COD) of a matrix.
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ArrayWrapper< Derived > array()
const EIGEN_DEVICE_FUNC PlainObject stableNormalized() const
bool isUnitary(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Robust Cholesky decomposition of a matrix with pivoting.
const typedef Diagonal< const Derived, Index > Type
EIGEN_DEVICE_FUNC TriangularViewReturnType< Mode >::Type triangularView()
Jet< T, N > pow(const Jet< T, N > &f, double g)
Householder rank-revealing QR decomposition of a matrix with column-pivoting.
bool isIdentity(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
BDCSVD< PlainObject > bdcSvd(unsigned int computationOptions=0) const
EIGEN_DEVICE_FUNC Scalar determinant() const
Expression of a diagonal matrix.
const EIGEN_DEVICE_FUNC CwiseBinaryOp< numext::equal_to< Scalar >, const Derived, const OtherDerived > cwiseEqual(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
internal::traits< Derived >::StorageIndex StorageIndex
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & operator=(const MatrixBase &other)
#define EIGEN_DEFAULT_COPY_CONSTRUCTOR(CLASS)
EIGEN_DEVICE_FUNC HomogeneousReturnType homogeneous() const
Base class for all 1D and 2D array, and related expressions.
NumTraits< Scalar >::Real RealScalar
CwiseNullaryOp< internal::scalar_identity_op< Scalar >, PlainObject > IdentityReturnType
const EIGEN_DEVICE_FUNC AdjointReturnType adjoint() const
Block< Derived, internal::traits< Derived >::RowsAtCompileTime, 1, !IsRowMajor > ColXpr
Point2(* f)(const Point3 &, OptionalJacobian< 2, 3 >)
Matrix< std::complex< RealScalar >, internal::traits< Derived >::ColsAtCompileTime, 1, ColMajor > EigenvaluesReturnType
Base::PlainObject PlainObject
const EIGEN_DEVICE_FUNC HNormalizedReturnType hnormalized() const
homogeneous normalization
EIGEN_DEVICE_FUNC Derived & setUnit(Index i)
Set the coefficients of *this to the i-th unit (basis) vector.
void applyOnTheLeft(const EigenBase< OtherDerived > &other)
NumTraits< Scalar >::Real RealScalar
Two-sided Jacobi SVD decomposition of a rectangular matrix.
Base::ConstTransposeReturnType ConstTransposeReturnType
internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, ConstTransposeReturnType >, ConstTransposeReturnType >::type AdjointReturnType
TriangularView< Derived, Mode > Type
bool isLowerTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const CompleteOrthogonalDecomposition< PlainObject > completeOrthogonalDecomposition() const
EIGEN_DEVICE_FUNC ScalarBinaryOpTraits< typename internal::traits< Derived >::Scalar, typename internal::traits< OtherDerived >::Scalar >::ReturnType dot(const MatrixBase< OtherDerived > &other) const
MatrixBase StorageBaseType
Standard Cholesky decomposition (LL^T) of a matrix and associated features.
EIGEN_DEVICE_FUNC void stableNormalize()
const HouseholderQR< PlainObject > householderQr() const
Diagonal< Derived > DiagonalReturnType
Base class for all dense matrices, vectors, and arrays.
EIGEN_DEVICE_FUNC Index diagonalSize() const
#define EIGEN_STATIC_ASSERT(CONDITION, MSG)
const typedef SelfAdjointView< const Derived, UpLo > Type
Derived & forceAlignedAccessIf()
internal::add_const< Transpose< const Derived > >::type ConstTransposeReturnType
Generic expression where a coefficient-wise unary operator is applied to an expression.
EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE ArrayWrapper< const Derived > array() const
internal::traits< Derived >::Scalar Scalar
Base::CoeffReturnType CoeffReturnType
ProductLieGroup< Point2, Pose2 > Product
#define EIGEN_MATRIX_FUNCTION(ReturnType, Name, Description)
const EIGEN_DEVICE_FUNC Product< Derived, OtherDerived, LazyProduct > lazyProduct(const MatrixBase< OtherDerived > &other) const
Derived & operator-=(const ArrayBase< OtherDerived > &)
Expression of a dense or sparse matrix with zero or too small values removed.
Homogeneous< Derived, HomogeneousReturnTypeDirection > HomogeneousReturnType
EIGEN_DEVICE_FUNC void adjointInPlace()
static const EIGEN_DEVICE_FUNC BasisReturnType Unit(Index size, Index i)
const EIGEN_DEVICE_FUNC Product< Derived, OtherDerived > operator*(const MatrixBase< OtherDerived > &other) const
Base class of any sparse matrices or sparse expressions.
Derived & operator*=(const EigenBase< OtherDerived > &other)
internal::packet_traits< Scalar >::type PacketScalar
const EIGEN_STRONG_INLINE SparseMatrixBase< OtherDerived >::template CwiseProductDenseReturnType< Derived >::Type cwiseProduct(const SparseMatrixBase< OtherDerived > &other) const
EIGEN_DEVICE_FUNC Scalar trace() const
Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
The matrix class, also used for vectors and row-vectors.
NoAlias< Derived, Eigen::MatrixBase > EIGEN_DEVICE_FUNC noalias()
RealScalar stableNorm() const
Base class for all dense matrices, vectors, and expressions.
Derived & forceAlignedAccess()
EIGEN_DEVICE_FUNC RealScalar norm() const
internal::traits< Derived >::StorageKind StorageKind
const EIGEN_DEVICE_FUNC SinhReturnType sinh() const
Expression of a triangular part in a matrix.
EIGEN_DEVICE_FUNC DiagonalReturnType diagonal()
#define EIGEN_MATRIX_FUNCTION_1(ReturnType, Name, Description, Argument)
const SparseView< Derived > sparseView(const Scalar &m_reference=Scalar(0), const typename NumTraits< Scalar >::Real &m_epsilon=NumTraits< Scalar >::dummy_precision()) const
const PartialPivLU< PlainObject > partialPivLu() const
const LDLT< PlainObject > ldlt() const
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
const EIGEN_DEVICE_FUNC MatrixBase< Derived > & matrix() const
Jet< T, N > sqrt(const Jet< T, N > &f)
EIGEN_DEVICE_FUNC Derived & setIdentity()
typedef EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(ConstStartMinusOne, Scalar, quotient) HNormalizedReturnType
SelfAdjointView< Derived, UpLo > Type
EIGEN_DEVICE_FUNC bool operator==(const MatrixBase< OtherDerived > &other) const
bool isUpperTriangular(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
RealScalar blueNorm() const
Householder QR decomposition of a matrix.
EIGEN_DEVICE_FUNC void makeHouseholderInPlace(Scalar &tau, RealScalar &beta)
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
EIGEN_DEVICE_FUNC PlainObject unitOrthogonal(void) const
EIGEN_DEVICE_FUNC RealScalar squaredNorm() const
gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:33:41