Public Types | Public Member Functions | Private Attributes | List of all members
Eigen::internal::MatrixFunctionAtomic< MatrixType > Class Template Reference

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

#include <MatrixFunction.h>

Public Types

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

Public Member Functions

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

Private Attributes

StemFunctionm_f
 

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.

Definition at line 30 of file MatrixFunction.h.

Member Typedef Documentation

◆ Scalar

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

Definition at line 34 of file MatrixFunction.h.

◆ StemFunction

Definition at line 35 of file MatrixFunction.h.

Constructor & Destructor Documentation

◆ MatrixFunctionAtomic()

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

Constructor.

Parameters
[in]fmatrix function to compute.

Definition at line 40 of file MatrixFunction.h.

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

Definition at line 64 of file MatrixFunction.h.

Member Data Documentation

◆ m_f

template<typename MatrixType >
StemFunction* Eigen::internal::MatrixFunctionAtomic< MatrixType >::m_f
private

Definition at line 49 of file MatrixFunction.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:48:41