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

Proxy for the matrix square root of some matrix (expression). More...

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixSquareRootReturnValue< Derived >:
Inheritance graph
[legend]

Public Member Functions

Index cols () const
 
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix square root. More...
 
 MatrixSquareRootReturnValue (const Derived &src)
 Constructor. More...
 
Index rows () const
 
- Public Member Functions inherited from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >
const Unusablecoeff (Index) const
 
const Unusablecoeff (Index, Index) const
 
UnusablecoeffRef (Index)
 
UnusablecoeffRef (Index, Index)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 

Protected Types

typedef internal::ref_selector< Derived >::type DerivedNested
 

Protected Attributes

const DerivedNested m_src
 

Additional Inherited Members

- Public Types inherited from Eigen::ReturnByValue< MatrixSquareRootReturnValue< Derived > >
typedef internal::dense_xpr_base< ReturnByValue >::type Base
 
typedef internal::traits< MatrixSquareRootReturnValue< Derived > >::ReturnType ReturnType
 

Detailed Description

template<typename Derived>
class Eigen::MatrixSquareRootReturnValue< Derived >

Proxy for the matrix square root of some matrix (expression).

Template Parameters
DerivedType of the argument to the matrix square root.

This class holds the argument to the matrix square root until it is assigned or evaluated for some other reason (so the argument should not be changed in the meantime). It is the return type of MatrixBase::sqrt() and most of the time this is the only way it is used.

Definition at line 306 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ DerivedNested

template<typename Derived >
typedef internal::ref_selector<Derived>::type Eigen::MatrixSquareRootReturnValue< Derived >::DerivedNested
protected

Definition at line 320 of file MatrixSquareRoot.h.

Constructor & Destructor Documentation

◆ MatrixSquareRootReturnValue()

template<typename Derived >
Eigen::MatrixSquareRootReturnValue< Derived >::MatrixSquareRootReturnValue ( const Derived &  src)
inlineexplicit

Constructor.

Parameters
[in]srcMatrix (expression) forming the argument of the matrix square root.

Definition at line 328 of file MatrixSquareRoot.h.

Member Function Documentation

◆ cols()

template<typename Derived >
Index Eigen::MatrixSquareRootReturnValue< Derived >::cols ( void  ) const
inline

Definition at line 345 of file MatrixSquareRoot.h.

◆ evalTo()

template<typename Derived >
template<typename ResultType >
void Eigen::MatrixSquareRootReturnValue< Derived >::evalTo ( ResultType &  result) const
inline

Compute the matrix square root.

Parameters
[out]resultthe matrix square root of src in the constructor.

Definition at line 336 of file MatrixSquareRoot.h.

◆ rows()

template<typename Derived >
Index Eigen::MatrixSquareRootReturnValue< Derived >::rows ( void  ) const
inline

Definition at line 344 of file MatrixSquareRoot.h.

Member Data Documentation

◆ m_src

template<typename Derived >
const DerivedNested Eigen::MatrixSquareRootReturnValue< Derived >::m_src
protected

Definition at line 348 of file MatrixSquareRoot.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:42:13