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

Power of x. More...

#include <JMathlib.hh>

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

Public Member Functions
	JPow ()
	Default constructor. More...
	JPow (const double alpha)
	Constructor. More...
double	getValue (const double x) const
	Function value. More...
double	getDerivative (const double x) const
	Derivative value. More...
const JPow &	getGradient (const double x) const
	Get gradient. More...
double	operator() (const Args &...args) const
	Function value. More...
JPow< ID_t > &	negate ()
	Negate function. More...
JPow< ID_t > &	add (const JPow< ID_t > &f1)
	Add function. More...
JPow< ID_t > &	sub (const JPow< ID_t > &f1)
	Subtract function. More...
JPow< ID_t > &	mul (const double factor)
	Scale function. More...
JPow< ID_t > &	div (const double factor)
	Scale function. More...

Public Attributes
double	alpha
	x^alpha More...

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

Detailed Description

template<int ID_t>
struct JMATH::JPow< ID_t, _vF >

Power of x.

Definition at line 1907 of file JMathlib.hh.

Constructor & Destructor Documentation

JPow() [1/2]

template<int ID_t>

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

inline

Default constructor.

Definition at line 1917 of file JMathlib.hh.

           :
      alpha(0.0)
    {}

JPow() [2/2]

template<int ID_t>

JMATH::JPow< ID_t, _vF >::JPow ( const double  alpha )

inline

Constructor.

Parameters

alpha

value

Definition at line 1927 of file JMathlib.hh.

                             :
      alpha(alpha)
    {}

Member Function Documentation

getValue()

template<int ID_t>

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

inline

Function value.

Parameters

x	abscissa value

Returns

function value

Definition at line 1938 of file JMathlib.hh.

    {
      return pow(x, alpha);
    }

getDerivative()

template<int ID_t>

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

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 1950 of file JMathlib.hh.

    {
      return alpha * pow(x, alpha - 1);
    }

getGradient()

template<int ID_t>

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

inline

Get gradient.

Parameters

x	abscissa value

Returns

gradient

Definition at line 1962 of file JMathlib.hh.

    {
      static JPow gradient;                                   // d(f)/d(a)
 
      gradient.alpha = this->getValue(x) * log(x);
 
      return gradient;
    }

operator()()

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

negate()

JPow< ID_t > & JMATH::JCalculus< JPow< ID_t > >::negate ( )

inlineinherited

Negate function.

Returns

this function

Definition at line 203 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i = -(static_cast<JF1_t&>(*this).*i);
      }
 
      return static_cast<JF1_t&>(*this);
    }

add()

JPow< ID_t > & JMATH::JCalculus< JPow< ID_t > >::add ( const JPow< ID_t > &  f1 )

inlineinherited

Add function.

Parameters

f1

function

Returns

this function

Definition at line 219 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i += f1.*i;
      }
 
      return static_cast<JF1_t&>(*this);
    }

sub()

JPow< ID_t > & JMATH::JCalculus< JPow< ID_t > >::sub ( const JPow< ID_t > &  f1 )

inlineinherited

Subtract function.

Parameters

f1

function

Returns

this function

Definition at line 235 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i -= f1.*i;
      }
 
      return static_cast<JF1_t&>(*this);
    }

mul()

JPow< ID_t > & JMATH::JCalculus< JPow< ID_t > >::mul ( const double  factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 251 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i *= factor;
      }
 
      return static_cast<JF1_t&>(*this);
    }

div()

JPow< ID_t > & JMATH::JCalculus< JPow< ID_t > >::div ( const double  factor )

inlineinherited

Scale function.

Parameters

factor

factor

Returns

this function

Definition at line 267 of file JMathlib.hh.

    {
      for (const auto& i : JF1_t::parameters) {
        static_cast<JF1_t&>(*this).*i /= factor;
      }
 
      return static_cast<JF1_t&>(*this);
    }

Member Data Documentation

ID

template<int ID_t>

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

static

Definition at line 1911 of file JMathlib.hh.

alpha

template<int ID_t>

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

x^alpha

Definition at line 1971 of file JMathlib.hh.

parameters

template<int ID_t>

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

static

parameters

Definition at line 1972 of file JMathlib.hh.

---

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

• JMathlib.hh