JMATH::JCos< JF1_t > Struct Template Reference

Cosine of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JCos< JF1_t >:

Public Member Functions
	JCos ()
	Default constructor. More...
	JCos (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 JCos &	getGradient (const double x) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...

Detailed Description

template<class JF1_t>
struct JMATH::JCos< JF1_t >

Cosine of function.

Definition at line 2312 of file JMathlib.hh.

Constructor & Destructor Documentation

JCos() [1/2]

template<class JF1_t >

JMATH::JCos< JF1_t >::JCos ( )

inline

Default constructor.

Definition at line 2322 of file JMathlib.hh.

           :
      JF1_t()
    {}

JCos() [2/2]

template<class JF1_t >

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

inline

Constructor.

Parameters

f1

function

Definition at line 2332 of file JMathlib.hh.

                          :
      JF1_t(f1)
    {}

Member Function Documentation

getValue()

template<class JF1_t >

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

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 2343 of file JMathlib.hh.

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

getDerivative()

template<class JF1_t >

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

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 2357 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 v * -sin(u);
    }

getGradient()

template<class JF1_t >

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

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 2372 of file JMathlib.hh.

    {
      static JCos 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) *= -sin(u);
 
      return gradient;
    }

operator()()

double JMATH::JMathlib< JCos< JF1_t > >::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