Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::DiagonalWrapper< _DiagonalVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:
Inheritance graph
[legend]

Public Types

typedef _DiagonalVectorType DiagonalVectorType
 
typedef DiagonalWrapper Nested
 
- Public Types inherited from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >
enum  
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTimeDenseMatrixType
 
typedef DenseMatrixType DenseType
 
typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::DiagonalVectorType DiagonalVectorType
 
typedef DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > > InverseReturnType
 
typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime > PlainObject
 
typedef DiagonalVectorType::RealScalar RealScalar
 
typedef DiagonalVectorType::Scalar Scalar
 
typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::StorageIndex StorageIndex
 
typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::StorageKind StorageKind
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

EIGEN_DEVICE_FUNC const DiagonalVectorTypediagonal () const
 
EIGEN_DEVICE_FUNC DiagonalWrapper (DiagonalVectorType &a_diagonal)
 
- Public Member Functions inherited from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC const DiagonalWrapper< _DiagonalVectorType > & derived () const
 
EIGEN_DEVICE_FUNC DiagonalWrapper< _DiagonalVectorType > & derived ()
 
EIGEN_DEVICE_FUNC const DiagonalVectorTypediagonal () const
 
EIGEN_DEVICE_FUNC DiagonalVectorTypediagonal ()
 
EIGEN_DEVICE_FUNC const InverseReturnType inverse () const
 
EIGEN_DEVICE_FUNC const Product< DiagonalWrapper< _DiagonalVectorType >, MatrixDerived, LazyProduct > operator* (const MatrixBase< MatrixDerived > &matrix) const
 
EIGEN_DEVICE_FUNC const DiagonalWrapper< const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(DiagonalVectorType, Scalar, product) > operator* (const Scalar &scalar) const
 
EIGEN_DEVICE_FUNC const DiagonalWrapper< const EIGEN_CWISE_BINARY_RETURN_TYPE(DiagonalVectorType, typename OtherDerived::DiagonalVectorType, sum) > operator+ (const DiagonalBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const DiagonalWrapper< const EIGEN_CWISE_BINARY_RETURN_TYPE(DiagonalVectorType, typename OtherDerived::DiagonalVectorType, difference) > operator- (const DiagonalBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC Index rows () const
 
EIGEN_DEVICE_FUNC DenseMatrixType toDenseMatrix () const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Protected Attributes

DiagonalVectorType::Nested m_diagonal
 

Detailed Description

template<typename _DiagonalVectorType>
class Eigen::DiagonalWrapper< _DiagonalVectorType >

Expression of a diagonal matrix.

Parameters
_DiagonalVectorTypethe type of the vector of diagonal coefficients

This class is an expression of a diagonal matrix, but not storing its own vector of diagonal coefficients, instead wrapping an existing vector expression. It is the return type of MatrixBase::asDiagonal() and most of the time this is the only way that it is used.

See also
class DiagonalMatrix, class DiagonalBase, MatrixBase::asDiagonal()

Definition at line 293 of file DiagonalMatrix.h.

Member Typedef Documentation

◆ DiagonalVectorType

template<typename _DiagonalVectorType >
typedef _DiagonalVectorType Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalVectorType

Definition at line 298 of file DiagonalMatrix.h.

◆ Nested

template<typename _DiagonalVectorType >
typedef DiagonalWrapper Eigen::DiagonalWrapper< _DiagonalVectorType >::Nested

Definition at line 299 of file DiagonalMatrix.h.

Constructor & Destructor Documentation

◆ DiagonalWrapper()

template<typename _DiagonalVectorType >
EIGEN_DEVICE_FUNC Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper ( DiagonalVectorType a_diagonal)
inlineexplicit

Constructor from expression of diagonal coefficients to wrap.

Definition at line 304 of file DiagonalMatrix.h.

Member Function Documentation

◆ diagonal()

template<typename _DiagonalVectorType >
EIGEN_DEVICE_FUNC const DiagonalVectorType& Eigen::DiagonalWrapper< _DiagonalVectorType >::diagonal ( ) const
inline
Returns
a const reference to the wrapped expression of diagonal coefficients.

Definition at line 308 of file DiagonalMatrix.h.

Member Data Documentation

◆ m_diagonal

template<typename _DiagonalVectorType >
DiagonalVectorType::Nested Eigen::DiagonalWrapper< _DiagonalVectorType >::m_diagonal
protected

Definition at line 311 of file DiagonalMatrix.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:37