JMATH::JFn< JF1_t > Struct Template Reference

forward declaration for division of fuction. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JFn< JF1_t >:

Public Member Functions
	JFn ()
	Default constructor. More...
	JFn (const JF1_t &f1, const int N)
	Constructor. More...
template<class... Args>
double	getValue (const Args &...args) const
	Function value. More...
double	getDerivative (const double x) const
	Derivative value. More...
template<class... Args>
const JFn &	getGradient (const Args &...args) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...

Public Attributes
int	N

Detailed Description

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

forward declaration for division of fuction.

Fixed power of x.

Definition at line 346 of file JMathlib.hh.

Constructor & Destructor Documentation

template<class JF1_t >

JMATH::JFn< JF1_t >::JFn ( )

inline

Default constructor.

Definition at line 1301 of file JMathlib.hh.

          :
      JF1_t(),
      N(1)
    {}

template<class JF1_t >

JMATH::JFn< JF1_t >::JFn ( const JF1_t &  f1, const int  N  )

inline

Constructor.

Parameters

f1	first function
N	power

Definition at line 1313 of file JMathlib.hh.

                                      :
      JF1_t(f1),
      N(N)
    {}

Member Function Documentation

template<class JF1_t >

template<class... Args>

double JMATH::JFn< JF1_t >::getValue ( const Args &...  args ) const

inline

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 1326 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(args...);

      return pow(u, N);
    }

template<class JF1_t >

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

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 1340 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 N * pow(u, N - 1) * v;
    }

template<class JF1_t >

template<class... Args>

const JFn& JMATH::JFn< JF1_t >::getGradient ( const Args &...  args ) const

inline

Get gradient.

Parameters

args	abscissa value(s)

Returns

gradient

Definition at line 1356 of file JMathlib.hh.

    {
      static JFn gradient;

      const double u = static_cast<const JF1_t&>(*this).getValue(args...);
      const double w = N * pow(u, N - 1);

      static_cast<JF1_t&>(gradient)  = static_cast<const JF1_t&>(*this).getGradient(args...);
      static_cast<JF1_t&>(gradient) *= w;

      return gradient;
    }

double JMATH::JMathlib< JFn< 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...);
    }

Member Data Documentation

template<class JF1_t >

int JMATH::JFn< JF1_t >::N

Definition at line 1369 of file JMathlib.hh.

---

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

• JMathlib.hh