JMATH::JFn< JF1_t > Struct Template Reference

Fixed power of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JFn< JF1_t >:

Public Member Functions
	JFn ()
	Default constructor.
	JFn (const JF1_t &f1, const int N)
	Constructor.
template<class ... Args>
double	getValue (const Args &...args) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
template<class ... Args>
JFn	getGradient (const Args &...args) const
	Get gradient.
double	operator() (const Args &...args) const
	Function value.
double	operator[] (const size_t i) const
	Get value of parameter at given index.
double &	operator[] (const size_t i)
	Get value of parameter at given index.

Private Attributes
int	N

Detailed Description

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

Fixed power of function.

Definition at line 1418 of file JMathlib.hh.

Constructor & Destructor Documentation

JFn() [1/2]

template<class JF1_t >

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

inline

Default constructor.

Definition at line 1430 of file JMathlib.hh.

          :
      JF1_t(),
      N(1)
    {}

JFn() [2/2]

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 1442 of file JMathlib.hh.

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

Member Function Documentation

getValue()

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 1455 of file JMathlib.hh.

    {
      const double u = static_cast<const JF1_t&>(*this).getValue(args...);
 
      return pow(u, N);
    }

getDerivative()

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 1469 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;
    }

getGradient()

template<class JF1_t >

template<class ... Args>

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

inline

Get gradient.

Parameters

args	abscissa value(s)

Returns

gradient

Definition at line 1485 of file JMathlib.hh.

    {
      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;
    }

operator()()

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

inlineinherited

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 330 of file JMathlib.hh.

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

operator[]() [1/2]

double JMATH::JMathlib< JF1_t >::operator[] ( const size_t i ) const

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 538 of file JMathlib.hh.

    {
      return static_cast<const JF1_t&>(*this).*JF1_t::parameters[i];
    }

operator[]() [2/2]

double & JMATH::JMathlib< JF1_t >::operator[] ( const size_t i )

inlineinherited

Get value of parameter at given index.

Parameters

i

index

Returns

value

Definition at line 550 of file JMathlib.hh.

    {
      return static_cast<JF1_t&>(*this).*JF1_t::parameters[i];
    }

Member Data Documentation

N

template<class JF1_t >

int JMATH::JFn< JF1_t >::N

private

Definition at line 1499 of file JMathlib.hh.

---

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

• JMathlib.hh