JMATH::JSqrt< JF1_t > Struct Template Reference

Square root of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSqrt< JF1_t >:

Public Member Functions
	JSqrt ()
	Default constructor. More...
	JSqrt (const JF1_t &f1)
	Constructor. More...
double	getValue (const double x) const
	Function value. More...
double	getDerivative (const double x) const
	Derivative value. More...
const JSqrt &	getGradient (const double x) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...

Detailed Description

template<class JF1_t = _vF>
struct JMATH::JSqrt< JF1_t >

Square root of function.

Definition at line 2055 of file JMathlib.hh.

Constructor & Destructor Documentation

JSqrt() [1/2]

template<class JF1_t = _vF>

JMATH::JSqrt< JF1_t >::JSqrt ( )

inline

Default constructor.

Definition at line 2065 of file JMathlib.hh.

            :
      JF1_t()
    {}

JSqrt() [2/2]

template<class JF1_t = _vF>

JMATH::JSqrt< JF1_t >::JSqrt ( const JF1_t &  f1 )

inline

Constructor.

Parameters

f1

function

Definition at line 2075 of file JMathlib.hh.

                           :
      JF1_t(f1)
    {}

Member Function Documentation

getValue()

template<class JF1_t = _vF>

double JMATH::JSqrt< JF1_t >::getValue ( const double  x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2086 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
 
      return sqrt(u);
    }

getDerivative()

template<class JF1_t = _vF>

double JMATH::JSqrt< JF1_t >::getDerivative ( const double  x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2100 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
      const double v = static_cast<const JF1_t&>(*this).getDerivative(x);
 
      return 0.5 * v / sqrt(u);
    }

getGradient()

template<class JF1_t = _vF>

const JSqrt& JMATH::JSqrt< JF1_t >::getGradient ( const double  x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2115 of file JMathlib.hh.

    {
      static JSqrt gradient;                                  // d(f)/d(a)
 
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
 
      static_cast<JF1_t&>(gradient)  = static_cast<const JF1_t&>(*this).getGradient(x);
      static_cast<JF1_t&>(gradient) *= 0.5 / sqrt(u);
 
      return gradient;
    }

operator()()

double JMATH::JMathlib< JSqrt< _vF > >::operator() ( const Args &...  args ) const

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 362 of file JMathlib.hh.

    {
      return static_cast<const JF1_t&>(*this).getValue(args...);
    }

---

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

• JMathlib.hh