Represents a diagonal matrix with its storage. More...

#include <src/eigen/Eigen/src/Core/DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:

Collaboration diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:

Public Types
typedef internal::traits< DiagonalMatrix >::DiagonalVectorType	DiagonalVectorType

typedef const DiagonalMatrix &	Nested

typedef _Scalar	Scalar

typedef internal::traits< DiagonalMatrix >::StorageKind	StorageKind

typedef internal::traits< DiagonalMatrix >::StorageIndex	StorageIndex

enum

typedef DiagonalVectorType::RealScalar	RealScalar

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType

typedef DenseMatrixType	DenseType

typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime >	PlainObject

typedef DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > >	InverseReturnType

typedef Eigen::Index	Index
	The interface type of indices.

Public Member Functions
EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const

EIGEN_DEVICE_FUNC DiagonalVectorType &	diagonal ()

EIGEN_DEVICE_FUNC	DiagonalMatrix ()

EIGEN_DEVICE_FUNC	DiagonalMatrix (Index dim)

EIGEN_DEVICE_FUNC	DiagonalMatrix (const Scalar &x, const Scalar &y)

EIGEN_DEVICE_FUNC	DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DiagonalMatrix (const DiagonalBase< OtherDerived > &other)

	DiagonalMatrix (const DiagonalMatrix &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DiagonalMatrix (const MatrixBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix &	operator= (const DiagonalBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC DiagonalMatrix &	operator= (const DiagonalMatrix &other)

EIGEN_DEVICE_FUNC void	resize (Index size)

EIGEN_DEVICE_FUNC void	setZero ()

EIGEN_DEVICE_FUNC void	setZero (Index size)

EIGEN_DEVICE_FUNC void	setIdentity ()

EIGEN_DEVICE_FUNC void	setIdentity (Index size)

EIGEN_DEVICE_FUNC const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived () const

EIGEN_DEVICE_FUNC DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived ()

EIGEN_DEVICE_FUNC DenseMatrixType	toDenseMatrix () const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC const Product< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, 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 InverseReturnType	inverse () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Index	size () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Attributes
DiagonalVectorType	m_diagonal

Detailed Description

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >

Represents a diagonal matrix with its storage.

Parameters

_Scalar	the type of coefficients
SizeAtCompileTime	the dimension of the matrix, or Dynamic
MaxSizeAtCompileTime	the dimension of the matrix, or Dynamic. This parameter is optional and defaults to SizeAtCompileTime. Most of the time, you do not need to specify it.

See also: class DiagonalWrapper

Member Typedef Documentation

◆ DenseMatrixType

typedef Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime> Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::DenseMatrixType

inherited

◆ DenseType

typedef DenseMatrixType Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::DenseType

inherited

◆ DiagonalVectorType

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalVectorType

◆ Index

template<typename Derived >

typedef Eigen::Index Eigen::EigenBase< Derived >::Index

inherited

The interface type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also: StorageIndex, TopicPreprocessorDirectives.

◆ InverseReturnType

typedef DiagonalWrapper<const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const DiagonalVectorType> > Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::InverseReturnType

inherited

◆ Nested

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef const DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Nested

◆ PlainObject

typedef DiagonalMatrix<Scalar,DiagonalVectorType::SizeAtCompileTime,DiagonalVectorType::MaxSizeAtCompileTime> Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::PlainObject

inherited

◆ RealScalar

typedef DiagonalVectorType::RealScalar Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::RealScalar

inherited

◆ Scalar

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef _Scalar Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Scalar

◆ StorageIndex

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::StorageIndex Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageIndex

◆ StorageKind

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::StorageKind Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageKind

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

         {
      RowsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
      ColsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
      MaxRowsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime,
      MaxColsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime,
      IsVectorAtCompileTime = 0,
      Flags = NoPreferredStorageOrderBit
    };

Constructor & Destructor Documentation

◆ DiagonalMatrix() [1/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( )

inline

Default constructor without initialization

143{}

◆ DiagonalMatrix() [2/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( Index dim )

inlineexplicit

Constructs a diagonal matrix with given dimension

147: m_diagonal(dim) {}

Eigen::DiagonalMatrix::m_diagonal

DiagonalVectorType m_diagonal

Definition DiagonalMatrix.h:130

◆ DiagonalMatrix() [3/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y
	)

inline

2D constructor.

151: m_diagonal(x,y) {}

◆ DiagonalMatrix() [4/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y,
		const Scalar &	z
	)

inline

3D constructor.

155: m_diagonal(x,y,z) {}

◆ DiagonalMatrix() [5/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalBase< OtherDerived > & other )

inline

Copy constructor.

160: m_diagonal(other.diagonal()) {}

◆ DiagonalMatrix() [6/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & other )

inline

copy constructor. prevent a default copy constructor from hiding the other templated constructor

164: m_diagonal(other.diagonal()) {}

◆ DiagonalMatrix() [7/7]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const MatrixBase< OtherDerived > & other )

inlineexplicit

generic constructor from expression of the diagonal coefficients

170 : m_diagonal(other)

171 {}

Member Function Documentation

◆ addTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::addTo ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst += res;
  }

◆ applyThisOnTheLeft()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheLeft ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = this->derived() * dst;
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ applyThisOnTheRight()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheRight ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = dst * this->derived();
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

◆ cols()

EIGEN_DEVICE_FUNC Index Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::cols ( ) const

inlineinherited

56{ return diagonal().size(); }

Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::diagonal

EIGEN_DEVICE_FUNC const DiagonalVectorType & diagonal() const

Definition DiagonalMatrix.h:49

◆ const_cast_derived()

template<typename Derived >

EIGEN_DEVICE_FUNC Derived & Eigen::EigenBase< Derived >::const_cast_derived ( ) const

inlineinherited

52 { return *static_cast<Derived*>(const_cast<EigenBase*>(this)); }

Referenced by Eigen::TriangularViewImpl< _MatrixType, _Mode, Dense >::swap().

Here is the caller graph for this function:

◆ const_derived()

template<typename Derived >

EIGEN_DEVICE_FUNC const Derived & Eigen::EigenBase< Derived >::const_derived ( ) const

inlineinherited

55 { return *static_cast<const Derived*>(this); }

◆ derived() [1/2]

EIGEN_DEVICE_FUNC DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::derived ( )

inlineinherited

43{ return *static_cast<Derived*>(this); }

◆ derived() [2/2]

EIGEN_DEVICE_FUNC const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::derived ( ) const

inlineinherited

41{ return *static_cast<const Derived*>(this); }

◆ diagonal() [1/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC DiagonalVectorType & Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( )

inline

Returns: a reference to the stored vector of diagonal coefficients.

139{ return m_diagonal; }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

◆ diagonal() [2/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC const DiagonalVectorType & Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( ) const

inline

const version of diagonal().

136{ return m_diagonal; }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

Referenced by igl::biharmonic_coordinates(), and Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator=().

Here is the caller graph for this function:

◆ evalTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::evalTo ( Dest & dst ) const

inlineinherited

72 { derived().evalTo(dst); }

Referenced by Eigen::EigenBase< Derived >::subTo().

Here is the caller graph for this function:

◆ inverse()

EIGEN_DEVICE_FUNC const InverseReturnType Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::inverse ( ) const

inlineinherited

    {
      return InverseReturnType(diagonal().cwiseInverse());
    }

◆ operator*() [1/2]

EIGEN_DEVICE_FUNC const Product< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > , MatrixDerived, LazyProduct > Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::operator* ( const MatrixBase< MatrixDerived > & matrix ) const

inlineinherited

    {
      return Product<Derived, MatrixDerived, LazyProduct>(derived(),matrix.derived());
    }

◆ operator*() [2/2]

EIGEN_DEVICE_FUNC const DiagonalWrapper< const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(DiagonalVectorType, Scalar, product) > Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::operator* ( const Scalar & scalar ) const

inlineinherited

    {
      return DiagonalWrapper<const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(DiagonalVectorType,Scalar,product) >(diagonal() * scalar);
    }

◆ operator=() [1/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC DiagonalMatrix & Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalBase< OtherDerived > & other )

inline

Copy operator.

    {
      m_diagonal = other.diagonal();
      return *this;
    }

References Eigen::DiagonalBase< Derived >::diagonal(), and Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC DiagonalMatrix & Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & other )

inline

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

    {
      m_diagonal = other.diagonal();
      return *this;
    }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal(), and Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

Here is the call graph for this function:

◆ resize()

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize ( Index size )

inline

Resizes to given size.

196{ m_diagonal.resize(size); }

Eigen::EigenBase::size

EIGEN_DEVICE_FUNC Index size() const

Definition EigenBase.h:66

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal, and Eigen::EigenBase< Derived >::size().

Here is the call graph for this function:

◆ rows()

EIGEN_DEVICE_FUNC Index Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::rows ( ) const

inlineinherited

54{ return diagonal().size(); }

◆ setIdentity() [1/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( )

inline

Sets this matrix to be the identity matrix of the current size.

205{ m_diagonal.setOnes(); }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

◆ setIdentity() [2/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( Index size )

inline

Sets this matrix to be the identity matrix of the given size.

208{ m_diagonal.setOnes(size); }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal, and Eigen::EigenBase< Derived >::size().

Here is the call graph for this function:

◆ setZero() [1/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( )

inline

Sets all coefficients to zero.

199{ m_diagonal.setZero(); }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

◆ setZero() [2/2]

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( Index size )

inline

Resizes and sets all coefficients to zero.

202{ m_diagonal.setZero(size); }

References Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal, and Eigen::EigenBase< Derived >::size().

Here is the call graph for this function:

◆ size()

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::EigenBase< Derived >::size ( ) const

inlineinherited

Returns: the number of coefficients, which is rows()*cols().

See also: rows(), cols(), SizeAtCompileTime.

66{ return rows() * cols(); }

References Eigen::EigenBase< Derived >::cols(), and Eigen::EigenBase< Derived >::rows().

Referenced by Eigen::PlainObjectBase< Derived >::_resize_to_match(), Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize(), Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity(), and Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::subTo ( Dest & dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst -= res;
  }

References Eigen::EigenBase< Derived >::cols(), Eigen::EigenBase< Derived >::evalTo(), and Eigen::EigenBase< Derived >::rows().

Here is the call graph for this function:

◆ toDenseMatrix()

EIGEN_DEVICE_FUNC DenseMatrixType Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::toDenseMatrix ( ) const

inlineinherited

46{ return derived(); }

Member Data Documentation

◆ m_diagonal

template<typename _Scalar , int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal

protected

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

src/eigen/Eigen/src/Core/DiagonalMatrix.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DenseMatrixType

◆ DenseType

◆ DiagonalVectorType

◆ Index

◆ InverseReturnType

◆ Nested

◆ PlainObject

◆ RealScalar

◆ Scalar

◆ StorageIndex

◆ StorageKind

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DiagonalMatrix() [1/7]

◆ DiagonalMatrix() [2/7]

◆ DiagonalMatrix() [3/7]

◆ DiagonalMatrix() [4/7]

◆ DiagonalMatrix() [5/7]

◆ DiagonalMatrix() [6/7]

◆ DiagonalMatrix() [7/7]

Member Function Documentation

◆ addTo()

◆ applyThisOnTheLeft()

◆ applyThisOnTheRight()

◆ cols()

◆ const_cast_derived()

◆ const_derived()

◆ derived() [1/2]

◆ derived() [2/2]

◆ diagonal() [1/2]

◆ diagonal() [2/2]

◆ evalTo()

◆ inverse()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resize()

◆ rows()

◆ setIdentity() [1/2]

◆ setIdentity() [2/2]

◆ setZero() [1/2]

◆ setZero() [2/2]

◆ size()

◆ subTo()

◆ toDenseMatrix()

Member Data Documentation

◆ m_diagonal