WPILibC++ 2024.3.2
Eigen::internal::MatrixFunctionAtomic< MatrixType > Class Template Reference

Helper class for computing matrix functions of atomic matrices. More...

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

Public Types

typedef MatrixType::Scalar Scalar
 
typedef stem_function< Scalar >::type StemFunction
 

Public Member Functions

 MatrixFunctionAtomic (StemFunction f)
 Constructor. More...
 
MatrixType compute (const MatrixType &A)
 Compute matrix function of atomic matrix. More...
 

Detailed Description

template<typename MatrixType>
class Eigen::internal::MatrixFunctionAtomic< MatrixType >

Helper class for computing matrix functions of atomic matrices.

Here, an atomic matrix is a triangular matrix whose diagonal entries are close to each other.

Member Typedef Documentation

◆ Scalar

template<typename MatrixType >
typedef MatrixType::Scalar Eigen::internal::MatrixFunctionAtomic< MatrixType >::Scalar

◆ StemFunction

template<typename MatrixType >
typedef stem_function<Scalar>::type Eigen::internal::MatrixFunctionAtomic< MatrixType >::StemFunction

Constructor & Destructor Documentation

◆ MatrixFunctionAtomic()

template<typename MatrixType >
Eigen::internal::MatrixFunctionAtomic< MatrixType >::MatrixFunctionAtomic ( StemFunction  f)
inline

Constructor.

Parameters
[in]fmatrix function to compute.

Member Function Documentation

◆ compute()

template<typename MatrixType >
MatrixType Eigen::internal::MatrixFunctionAtomic< MatrixType >::compute ( const MatrixType &  A)

Compute matrix function of atomic matrix.

Parameters
[in]Aargument of matrix function, should be upper triangular and atomic
Returns
f(A), the matrix function evaluated at the given matrix

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