Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | List of all members
Eigen::TriangularViewImpl< MatrixType, Mode, Sparse > Class Template Reference
Sparse linear algebra » Reference » SparseCore_Module

Base class for a triangular part in a sparse matrix. More...

#include <SparseTriangularView.h>

Inheritance diagram for Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >:
Inheritance graph
[legend]

Public Types

typedef MatrixType::Nested MatrixTypeNested
 
typedef internal::remove_all< MatrixTypeNested >::type MatrixTypeNestedCleaned
 
typedef internal::remove_reference< MatrixTypeNested >::type MatrixTypeNestedNonRef
 
- Public Types inherited from Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >
enum  
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > >::type AdjointReturnType
 
typedef EigenBase< Derived > Base
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef internal::add_const< Transpose< const Derived > >::type ConstTransposeReturnType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime > DenseMatrixType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex > PlainObject
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< Derived >::StorageIndex StorageIndex
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
typedef Transpose< Derived > TransposeReturnType
 
typedef Scalar value_type
 

Public Member Functions

template<typename RhsType , typename DstType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void _solve_impl (const RhsType &rhs, DstType &dst) const
 
template<typename OtherDerived >
void solveInPlace (MatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
void solveInPlace (SparseMatrixBase< OtherDerived > &other) const
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >
const AdjointReturnType adjoint () const
 
RealScalar blueNorm () const
 
Index cols () const
 
Derived & const_cast_derived () const
 
const EIGEN_STRONG_INLINE CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
const EIGEN_STRONG_INLINE SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
Derived & derived ()
 
const Derived & derived () const
 
internal::traits< Derived >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
internal::traits< Derived >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
const internal::eval< Derived >::type eval () const
 
Index innerSize () const
 
bool isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isRValue () const
 
bool isVector () const
 
Derived & markAsRValue ()
 
RealScalar norm () const
 
const Product< Derived, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< Derived, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
const Product< Derived, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE Derived & operator*= (const Scalar &other)
 
Derived & operator*= (const Scalar &other)
 
Derived & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator+= (const DiagonalBase< OtherDerived > &other)
 
Derived & operator+= (const EigenBase< OtherDerived > &other)
 
Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE Derived & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator-= (const DiagonalBase< OtherDerived > &other)
 
Derived & operator-= (const EigenBase< OtherDerived > &other)
 
Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE Derived & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
Derived & operator/= (const Scalar &other)
 
Derived & operator= (const Derived &other)
 
Derived & operator= (const Derived &other)
 
Derived & operator= (const EigenBase< OtherDerived > &other)
 
Derived & operator= (const ReturnByValue< OtherDerived > &other)
 
Derived & operator= (const SparseMatrixBase< OtherDerived > &other)
 
Index outerSize () const
 
const SparseView< Derived > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
Index rows () const
 
SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
SparseMatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
Scalar sum () const
 
DenseMatrixType toDense () const
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 
const TriangularView< const Derived, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< Derived, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 

Protected Types

typedef SparseMatrixBase< TriangularViewType > Base
 

Protected Member Functions

void solve () const
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >
Derived & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 

Private Types

enum  { SkipFirst, SkipLast = !SkipFirst, SkipDiag = (Mode&ZeroDiag) ? 1 : 0, HasUnitDiag = (Mode&UnitDiag) ? 1 : 0 }
 
typedef TriangularView< MatrixType, Mode > TriangularViewType
 

Additional Inherited Members

- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >
static StorageIndex convert_index (const Index idx)
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >
bool m_isRValue
 

Detailed Description

template<typename MatrixType, unsigned int Mode>
class Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >

Base class for a triangular part in a sparse matrix.

This class is an abstract base class of class TriangularView, and objects of type TriangularViewImpl cannot be instantiated. It extends class TriangularView with additional methods which are available for sparse expressions only.

See also
class TriangularView, SparseMatrixBase::triangularView()

Definition at line 25 of file SparseTriangularView.h.

Member Typedef Documentation

◆ Base

template<typename MatrixType , unsigned int Mode>
typedef SparseMatrixBase<TriangularViewType> Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::Base
protected

Definition at line 41 of file SparseTriangularView.h.

◆ MatrixTypeNested

template<typename MatrixType , unsigned int Mode>
typedef MatrixType::Nested Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::MatrixTypeNested

Definition at line 46 of file SparseTriangularView.h.

◆ MatrixTypeNestedCleaned

template<typename MatrixType , unsigned int Mode>
typedef internal::remove_all<MatrixTypeNested>::type Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::MatrixTypeNestedCleaned

Definition at line 48 of file SparseTriangularView.h.

◆ MatrixTypeNestedNonRef

template<typename MatrixType , unsigned int Mode>
typedef internal::remove_reference<MatrixTypeNested>::type Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::MatrixTypeNestedNonRef

Definition at line 47 of file SparseTriangularView.h.

◆ TriangularViewType

template<typename MatrixType , unsigned int Mode>
typedef TriangularView<MatrixType,Mode> Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::TriangularViewType
private

Definition at line 35 of file SparseTriangularView.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename MatrixType , unsigned int Mode>
anonymous enum
private
Enumerator
SkipFirst 
SkipLast 
SkipDiag 
HasUnitDiag 

Definition at line 28 of file SparseTriangularView.h.

Member Function Documentation

◆ _solve_impl()

template<typename MatrixType , unsigned int Mode>
template<typename RhsType , typename DstType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::_solve_impl ( const RhsType &  rhs,
DstType &  dst 
) const
inline

Definition at line 52 of file SparseTriangularView.h.

◆ solve()

template<typename MatrixType , unsigned int Mode>
void Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::solve ( ) const
protected

◆ solveInPlace() [1/2]

template<typename MatrixType , unsigned int Mode>
template<typename OtherDerived >
void Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::solveInPlace ( MatrixBase< OtherDerived > &  other) const

Applies the inverse of *this to the dense vector or matrix other, "in-place"

◆ solveInPlace() [2/2]

template<typename MatrixType , unsigned int Mode>
template<typename OtherDerived >
void Eigen::TriangularViewImpl< MatrixType, Mode, Sparse >::solveInPlace ( SparseMatrixBase< OtherDerived > &  other) const

Applies the inverse of *this to the sparse vector or matrix other, "in-place"

The documentation for this class was generated from the following file:

gtsam
Author(s):
autogenerated on Wed May 15 2024 15:30:09