Eigen::MatrixSquareRootReturnValue< Derived > Class Template Reference

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/unsupported/Eigen/src/MatrixFunctions/MatrixSquareRoot.h>

Inheritance diagram for Eigen::MatrixSquareRootReturnValue< Derived >:

Public Member Functions
	MatrixSquareRootReturnValue (const Derived &src)
	Constructor. More...
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix square root. More...
Index	rows () const
Index	cols () const

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

Protected Attributes
const DerivedNested	m_src

Detailed Description

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

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

Template Parameters

Derived

Type 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.

Member Typedef Documentation

DerivedNested

template<typename Derived >

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

protected

Constructor & Destructor Documentation

MatrixSquareRootReturnValue()

template<typename Derived >

Eigen::MatrixSquareRootReturnValue< Derived >::MatrixSquareRootReturnValue ( const Derived &  src )

inlineexplicit

Constructor.

Parameters

[in]

src

Matrix (expression) forming the argument of the matrix square root.

Member Function Documentation

cols()

template<typename Derived >

Index Eigen::MatrixSquareRootReturnValue< Derived >::cols ( ) const

inline

evalTo()

template<typename Derived >

template<typename ResultType >

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

inline

Compute the matrix square root.

Parameters

[out]

result

the matrix square root of src in the constructor.

rows()

template<typename Derived >

Index Eigen::MatrixSquareRootReturnValue< Derived >::rows ( ) const

inline

Member Data Documentation

m_src

template<typename Derived >

const DerivedNested Eigen::MatrixSquareRootReturnValue< Derived >::m_src

protected

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/unsupported/Eigen/src/MatrixFunctions/MatrixSquareRoot.h