Eigen::internal::MatrixExponentialScalingOp< RealScalar > Struct Template Reference

Scaling operator. More...

#include <MatrixExponential.h>

Public Types
typedef std::complex< RealScalar >	ComplexScalar

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} \).

Member Typedef Documentation

ComplexScalar

template<typename RealScalar >

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

Constructor & Destructor Documentation

MatrixExponentialScalingOp()

template<typename RealScalar >

Eigen::internal::MatrixExponentialScalingOp< RealScalar >::MatrixExponentialScalingOp ( int  squarings )

inline

Constructor.

Parameters

[in]

squarings

The integer \( s \) in this document.

: m_squarings(squarings) {}

Member Function Documentation

operator()() [1/2]

template<typename RealScalar >

const ComplexScalar Eigen::internal::MatrixExponentialScalingOp< RealScalar >::operator() ( const ComplexScalar &  x ) const

inline

Scale a matrix coefficient.

Parameters

[in,out]

x

The scalar to be scaled, becoming \( 2^{-s} x \).

                                                                      {
    using std::ldexp;
    return ComplexScalar(ldexp(x.real(), -m_squarings), ldexp(x.imag(), -m_squarings));
  }

References Eigen::internal::MatrixExponentialScalingOp< RealScalar >::m_squarings, and plotDoE::x.

operator()() [2/2]

template<typename RealScalar >

const RealScalar Eigen::internal::MatrixExponentialScalingOp< RealScalar >::operator() ( const RealScalar &  x ) const

inline

Scale a matrix coefficient.

Parameters

[in,out]

x

The scalar to be scaled, becoming \( 2^{-s} x \).

                                                                {
    using std::ldexp;
    return ldexp(x, -m_squarings);
  }

References Eigen::internal::MatrixExponentialScalingOp< RealScalar >::m_squarings, and plotDoE::x.

Member Data Documentation

m_squarings

template<typename RealScalar >

int Eigen::internal::MatrixExponentialScalingOp< RealScalar >::m_squarings

private

Referenced by Eigen::internal::MatrixExponentialScalingOp< RealScalar >::operator()().

---

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

• MatrixExponential.h