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

Subtraction of two functions. 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>
JSub	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.
const JF1_t &	f1 () const
JF1_t &	f1 ()
const JF2_t &	f2 () const
JF2_t &	f2 ()
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 Member Functions
static size_t	size ()
	Get size of parameter.

Static Public Attributes
static constexpr parameter_list< JPair, JF1_t::parameters.size()+JF2_t::parameters.size()>	parameters = join<JPair>(JF1_t::parameters, JF2_t::parameters)

Detailed Description

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

Subtraction of two functions.

Definition at line 1225 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 1236 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 1246 of file JMathlib.hh.

                                           :
      JPair_t<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 1258 of file JMathlib.hh.

    {
      return (this->f1().getValue(args...)  - 
              this->f2().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 1271 of file JMathlib.hh.

    {
      return (this->f1().getDerivative(x)  - 
              this->f2().getDerivative(x));
    }

getGradient()

template<class JF1_t , class JF2_t >

template<class ... Args>

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

    {
      JSub gradient;
 
      gradient.f1() = this->f1().getGradient(args...);
      gradient.f2() = this->f2().getGradient(args...);
      gradient.f2().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 331 of file JMathlib.hh.

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

size()

static size_t JMATH::JMathlib< JF1_t >::size ( )

inlinestaticinherited

Get size of parameter.

Returns

size

Definition at line 538 of file JMathlib.hh.

    {
      return JF1_t::parameters.size();
    }

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

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

f1() [1/2]

template<class JF1_t , class JF2_t , bool vf1 = JF1_t::parameters.size() != 0, bool vf2 = JF2_t::parameters.size() != 0>

const JF1_t & JMATH::JPair< JF1_t, JF2_t, vf1, vf2 >::f1 ( ) const

inlineinherited

Definition at line 981 of file JMathlib.hh.

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

f1() [2/2]

template<class JF1_t , class JF2_t , bool vf1 = JF1_t::parameters.size() != 0, bool vf2 = JF2_t::parameters.size() != 0>

JF1_t & JMATH::JPair< JF1_t, JF2_t, vf1, vf2 >::f1 ( )

inlineinherited

Definition at line 984 of file JMathlib.hh.

{ return static_cast<JF1_t&>(*this); }

f2() [1/2]

template<class JF1_t , class JF2_t , bool vf1 = JF1_t::parameters.size() != 0, bool vf2 = JF2_t::parameters.size() != 0>

const JF2_t & JMATH::JPair< JF1_t, JF2_t, vf1, vf2 >::f2 ( ) const

inlineinherited

Definition at line 982 of file JMathlib.hh.

{ return static_cast<const JF2_t&>(*this); }

f2() [2/2]

template<class JF1_t , class JF2_t , bool vf1 = JF1_t::parameters.size() != 0, bool vf2 = JF2_t::parameters.size() != 0>

JF2_t & JMATH::JPair< JF1_t, JF2_t, vf1, vf2 >::f2 ( )

inlineinherited

Definition at line 985 of file JMathlib.hh.

{ return static_cast<JF2_t&>(*this); }

negate()

JF1_t & JMATH::JCalculus< JF1_t >::negate ( )

inlineinherited

Negate function.

Returns

this function

Definition at line 170 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 186 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 202 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 218 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 234 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 , bool vf1 = JF1_t::parameters.size() != 0, bool vf2 = JF2_t::parameters.size() != 0>

parameter_list<JPair, JF1_t::parameters.size() + JF2_t::parameters.size()> JMATH::JPair< JF1_t, JF2_t, vf1, vf2 >::parameters = join<JPair>(JF1_t::parameters, JF2_t::parameters)

staticconstexprinherited

Definition at line 988 of file JMathlib.hh.

---

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

• JMathlib.hh