JMATH::JPow< ID_t, JF1_t > Struct Template Reference

Power of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JPow< ID_t, JF1_t >:

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

Public Attributes
double	alpha
	f(x)^alpha

Static Public Attributes
static const int	ID = ID_t
static const parameter_list< JPow >	parameters
	parameters

Detailed Description

template<int ID_t, class JF1_t = _vF>
struct JMATH::JPow< ID_t, JF1_t >

Power of function.

Definition at line 1798 of file JMathlib.hh.

Constructor & Destructor Documentation

JPow() [1/2]

template<int ID_t, class JF1_t = _vF>

JMATH::JPow< ID_t, JF1_t >::JPow ( )

inline

Default constructor.

Definition at line 1810 of file JMathlib.hh.

           :
      JF1_t(),
      alpha(0.0)
    {}

JPow() [2/2]

template<int ID_t, class JF1_t = _vF>

JMATH::JPow< ID_t, JF1_t >::JPow ( const JF1_t & f1, const double alpha )

inline

Constructor.

Parameters

f1	function
alpha	value

Definition at line 1822 of file JMathlib.hh.

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

Member Function Documentation

getValue()

template<int ID_t, class JF1_t = _vF>

double JMATH::JPow< ID_t, JF1_t >::getValue ( const double x ) const

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 1834 of file JMathlib.hh.

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

getDerivative()

template<int ID_t, class JF1_t = _vF>

double JMATH::JPow< ID_t, JF1_t >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

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

getGradient()

template<int ID_t, class JF1_t = _vF>

const JPow & JMATH::JPow< ID_t, JF1_t >::getGradient ( const double x ) const

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 1863 of file JMathlib.hh.

    {
      static JPow gradient;                                   // d(f)/d(a)
 
      const double u = static_cast<const JF1_t&>(*this).getValue(x);
      const double w = pow(u, alpha);
 
      gradient.alpha = w * log(u);
 
      static_cast<JF1_t&>(gradient)  = static_cast<const JF1_t&>(*this).getGradient(x);
      static_cast<JF1_t&>(gradient) *= alpha * w / u;
 
      return gradient;
    }

operator()()

double JMATH::JMathlib< JPow< ID_t, _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...);
    }

Member Data Documentation

ID

template<int ID_t, class JF1_t = _vF>

const int JMATH::JPow< ID_t, JF1_t >::ID = ID_t

static

Definition at line 1802 of file JMathlib.hh.

alpha

template<int ID_t, class JF1_t = _vF>

double JMATH::JPow< ID_t, JF1_t >::alpha

f(x)^alpha

Definition at line 1878 of file JMathlib.hh.

parameters

template<int ID_t, class JF1_t >

const parameter_list< JPow< ID_t, JF1_t > > JMATH::JPow< ID_t, JF1_t >::parameters

static

parameters

Set parameters.

Definition at line 1879 of file JMathlib.hh.

---

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

• JMathlib.hh