Public Types | Public Member Functions | Private Attributes | List of all members
Eigen::internal::MatrixExponentialScalingOp< RealScalar > Struct Template Reference

Scaling operator. More...

#include <MatrixExponential.h>

Public Types

typedef std::complex< RealScalarComplexScalar
 

Public Member Functions

 MatrixExponentialScalingOp (int squarings)
 Constructor. More...
 
const RealScalar operator() (const RealScalar &x) const
 Scale a matrix coefficient. More...
 
const ComplexScalar operator() (const ComplexScalar &x) const
 Scale a matrix coefficient. More...
 

Private Attributes

int m_squarings
 

Detailed Description

template<typename RealScalar>
struct Eigen::internal::MatrixExponentialScalingOp< RealScalar >

Scaling operator.

This struct is used by CwiseUnaryOp to scale a matrix by $ 2^{-s} $.

Definition at line 24 of file MatrixExponential.h.

Member Typedef Documentation

◆ ComplexScalar

template<typename RealScalar >
typedef std::complex<RealScalar> Eigen::internal::MatrixExponentialScalingOp< RealScalar >::ComplexScalar

Definition at line 43 of file MatrixExponential.h.

Constructor & Destructor Documentation

◆ MatrixExponentialScalingOp()

template<typename RealScalar >
Eigen::internal::MatrixExponentialScalingOp< RealScalar >::MatrixExponentialScalingOp ( int  squarings)
inline

Constructor.

Parameters
[in]squaringsThe integer $ s $ in this document.

Definition at line 30 of file MatrixExponential.h.

Member Function Documentation

◆ operator()() [1/2]

template<typename RealScalar >
const RealScalar Eigen::internal::MatrixExponentialScalingOp< RealScalar >::operator() ( const RealScalar x) const
inline

Scale a matrix coefficient.

Parameters
[in,out]xThe scalar to be scaled, becoming $ 2^{-s} x $.

Definition at line 37 of file MatrixExponential.h.

◆ operator()() [2/2]

template<typename RealScalar >
const ComplexScalar Eigen::internal::MatrixExponentialScalingOp< RealScalar >::operator() ( const ComplexScalar x) const
inline

Scale a matrix coefficient.

Parameters
[in,out]xThe scalar to be scaled, becoming $ 2^{-s} x $.

Definition at line 49 of file MatrixExponential.h.

Member Data Documentation

◆ m_squarings

template<typename RealScalar >
int Eigen::internal::MatrixExponentialScalingOp< RealScalar >::m_squarings
private

Definition at line 56 of file MatrixExponential.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:44:59