Optimist::FiniteDifferences::Epsilon< Real > Class Template Reference

#include <FiniteDifferences.hh>

Public Member Functions
Real	epsilon_1 (Real const v) const
Real	epsilon_2 (Real const v) const
Real	epsilon_3 (Real const v) const

Private Attributes
Real	m_epsilon_1 {std::sqrt(EPSILON)}
Real	m_epsilon_2 {std::pow(EPSILON, 0.75)}
Real	m_epsilon_3 {std::pow(EPSILON, 0.25)}

Detailed Description

template<typename Real>
class Optimist::FiniteDifferences::Epsilon< Real >

Helper class for computing finite differences epsilons.

Template Parameters

Real	Scalar number type

Member Function Documentation

epsilon_1()

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::epsilon_1 ( Real const v ) const

inline

Returns \( \epsilon_1 \) scaled by |v|+1.

epsilon_2()

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::epsilon_2 ( Real const v ) const

inline

Returns \( \epsilon_2 \) scaled by |v|+1.

epsilon_3()

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::epsilon_3 ( Real const v ) const

inline

Returns \( \epsilon_3 \) scaled by |v|+1.

Member Data Documentation

m_epsilon_1

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::m_epsilon_1 {std::sqrt(EPSILON)}

private

< Basic constants. Square root of machine epsilon \( \sqrt{\epsilon} \).

m_epsilon_2

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::m_epsilon_2 {std::pow(EPSILON, 0.75)}

private

Epsilon to the power of 3/4.

m_epsilon_3

template<typename Real>

Real Optimist::FiniteDifferences::Epsilon< Real >::m_epsilon_3 {std::pow(EPSILON, 0.25)}

private

Epsilon to the power of 1/4.

---

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

• include/Optimist/FiniteDifferences.hh