JMATH::JSub< JF1_t, JF2_t > Struct Template Reference

forward declaration for addition of fuction. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSub< JF1_t, JF2_t >:

Public Member Functions
	JSub ()
	Default constructor.
	JSub (const JF1_t &f1, const JF2_t &f2)
	Constructor.
template<class ... Args>
double	getValue (const Args &...args) const
	Function value.
double	getDerivative (const double x) const
	Derivative value.
template<class ... Args>
const JSub &	getGradient (const Args &...args) const
	Get gradient.
double	operator() (const Args &...args) const
	Function value.
JF1_t &	negate ()
	Negate function.
JF1_t &	add (const JF1_t &f1)
	Add function.
JF1_t &	sub (const JF1_t &f1)
	Subtract function.
JF1_t &	mul (const double factor)
	Scale function.
JF1_t &	div (const double factor)
	Scale function.

Static Public Attributes
static const parameter_list< JPair >	parameters
	parameters

Detailed Description

template<class JF1_t, class JF2_t>
struct JMATH::JSub< JF1_t, JF2_t >

forward declaration for addition of fuction.

Subtraction of two functions.

Definition at line 1054 of file JMathlib.hh.

Constructor & Destructor Documentation

JSub() [1/2]

template<class JF1_t , class JF2_t >

JMATH::JSub< JF1_t, JF2_t >::JSub ( )

inline

Default constructor.

Definition at line 1064 of file JMathlib.hh.

    {}

JSub() [2/2]

template<class JF1_t , class JF2_t >

JMATH::JSub< JF1_t, JF2_t >::JSub ( const JF1_t & f1, const JF2_t & f2 )

inline

Constructor.

Parameters

f1	first function
f2	second function

Definition at line 1074 of file JMathlib.hh.

                                           :
      JPair<JF1_t, JF2_t>(f1, f2)
    {}

Member Function Documentation

getValue()

template<class JF1_t , class JF2_t >

template<class ... Args>

double JMATH::JSub< JF1_t, JF2_t >::getValue ( const Args &... args ) const

inline

Function value.

Parameters

args	abscissa value(s)

Returns

function value

Definition at line 1086 of file JMathlib.hh.

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

getDerivative()

template<class JF1_t , class JF2_t >

double JMATH::JSub< JF1_t, JF2_t >::getDerivative ( const double x ) const

inline

Derivative value.

Parameters

x	abscissa value

Returns

derivative value

Definition at line 1099 of file JMathlib.hh.

    {
      return (static_cast<const JF1_t&>(*this).getDerivative(x)  - 
              static_cast<const JF2_t&>(*this).getDerivative(x));
    }

getGradient()

template<class JF1_t , class JF2_t >

template<class ... Args>

const JSub & JMATH::JSub< JF1_t, JF2_t >::getGradient ( const Args &... args ) const

inline

Get gradient.

Parameters

args	abscissa value(s)

Returns

gradient

Definition at line 1113 of file JMathlib.hh.

    {
      static JSub gradient;
 
      static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
      static_cast<JF2_t&>(gradient) = static_cast<const JF2_t&>(*this).getGradient(args...);
      static_cast<JF2_t&>(gradient).negate();
 
      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 362 of file JMathlib.hh.

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

negate()

JF1_t & JMATH::JCalculus< JF1_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()

JF1_t & JMATH::JCalculus< JF1_t >::add ( const JF1_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()

JF1_t & JMATH::JCalculus< JF1_t >::sub ( const JF1_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()

JF1_t & JMATH::JCalculus< JF1_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()

JF1_t & JMATH::JCalculus< JF1_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

parameters

template<class JF1_t , class JF2_t >

const parameter_list< JPair< JF1_t, JF2_t > > JMATH::JPair< JF1_t, JF2_t >::parameters

staticinherited

parameters

Set parameters.

Definition at line 965 of file JMathlib.hh.

---

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

• JMathlib.hh