WPILibC++ 2024.3.2
Eigen::MatrixExponentialReturnValue< Derived > Struct Template Reference

Proxy for the matrix exponential of some matrix (expression). More...

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

Inheritance diagram for Eigen::MatrixExponentialReturnValue< Derived >:

Public Member Functions

 MatrixExponentialReturnValue (const Derived &src)
 Constructor. More...
 
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix exponential. More...
 
Index rows () const
 
Index cols () const
 

Protected Attributes

const internal::ref_selector< Derived >::type m_src
 

Detailed Description

template<typename Derived>
struct Eigen::MatrixExponentialReturnValue< Derived >

Proxy for the matrix exponential of some matrix (expression).

Template Parameters
DerivedType of the argument to the matrix exponential.

This class holds the argument to the matrix exponential 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::exp() and most of the time this is the only way it is used.

Constructor & Destructor Documentation

◆ MatrixExponentialReturnValue()

template<typename Derived >
Eigen::MatrixExponentialReturnValue< Derived >::MatrixExponentialReturnValue ( const Derived &  src)
inline

Constructor.

Parameters
srcMatrix (expression) forming the argument of the matrix exponential.

Member Function Documentation

◆ cols()

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

◆ evalTo()

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

Compute the matrix exponential.

Parameters
resultthe matrix exponential of src in the constructor.

◆ rows()

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

Member Data Documentation

◆ m_src

template<typename Derived >
const internal::ref_selector<Derived>::type Eigen::MatrixExponentialReturnValue< Derived >::m_src
protected

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