Jpp 20.0.0-27-g39925593c-D
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
JMATH::JMul< JF1_t, JF2_t > Struct Template Reference

forward declaration for subtraction of fuction. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JMul< JF1_t, JF2_t >:
JMATH::JMathlib< JMul< JF1_t, JF2_t > > JMATH::JPair< JF1_t, JF2_t > JMATH::JCalculus< JPair< JF1_t, JF2_t > >

Public Member Functions

 JMul ()
 Default constructor.
 
 JMul (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 JMulgetGradient (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< JPairparameters
 parameters
 

Detailed Description

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

forward declaration for subtraction of fuction.

Multiplication of two functions.

Definition at line 1130 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JMul() [1/2]

template<class JF1_t , class JF2_t >
JMATH::JMul< JF1_t, JF2_t >::JMul ( )
inline

Default constructor.

Definition at line 1140 of file JMathlib.hh.

1141 {}

◆ JMul() [2/2]

template<class JF1_t , class JF2_t >
JMATH::JMul< JF1_t, JF2_t >::JMul ( const JF1_t & f1,
const JF2_t & f2 )
inline

Constructor.

Parameters
f1first function
f2second function

Definition at line 1150 of file JMathlib.hh.

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

Member Function Documentation

◆ getValue()

template<class JF1_t , class JF2_t >
template<class ... Args>
double JMATH::JMul< JF1_t, JF2_t >::getValue ( const Args &... args) const
inline

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 1162 of file JMathlib.hh.

1163 {
1164 return (static_cast<const JF1_t&>(*this).getValue(args...) *
1165 static_cast<const JF2_t&>(*this).getValue(args...));
1166 }

◆ getDerivative()

template<class JF1_t , class JF2_t >
double JMATH::JMul< JF1_t, JF2_t >::getDerivative ( const double x) const
inline

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 1175 of file JMathlib.hh.

1176 {
1177 return (static_cast<const JF1_t&>(*this).getDerivative(x) * static_cast<const JF2_t&>(*this).getValue(x) +
1178 static_cast<const JF1_t&>(*this).getValue(x) * static_cast<const JF2_t&>(*this).getDerivative(x));
1179 }

◆ getGradient()

template<class JF1_t , class JF2_t >
template<class ... Args>
const JMul & JMATH::JMul< JF1_t, JF2_t >::getGradient ( const Args &... args) const
inline

Get gradient.

Parameters
argsabscissa value(s)
Returns
gradient

Definition at line 1189 of file JMathlib.hh.

1190 {
1191 static JMul gradient;
1192
1193 static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
1194 static_cast<JF1_t&>(gradient) *= static_cast<const JF2_t&>(*this).getValue(args...);
1195 static_cast<JF2_t&>(gradient) = static_cast<const JF2_t&>(*this).getGradient(args...);
1196 static_cast<JF2_t&>(gradient) *= static_cast<const JF1_t&>(*this).getValue(args...);
1197
1198 return gradient;
1199 }
JMul()
Default constructor.
Definition JMathlib.hh:1140

◆ operator()()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 362 of file JMathlib.hh.

◆ negate()

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

Negate function.

Returns
this function

Definition at line 203 of file JMathlib.hh.

◆ add()

JF1_t & JMATH::JCalculus< JF1_t >::add ( const JF1_t & f1)
inlineinherited

Add function.

Parameters
f1function
Returns
this function

Definition at line 219 of file JMathlib.hh.

◆ sub()

JF1_t & JMATH::JCalculus< JF1_t >::sub ( const JF1_t & f1)
inlineinherited

Subtract function.

Parameters
f1function
Returns
this function

Definition at line 235 of file JMathlib.hh.

◆ mul()

JF1_t & JMATH::JCalculus< JF1_t >::mul ( const double factor)
inlineinherited

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 251 of file JMathlib.hh.

◆ div()

JF1_t & JMATH::JCalculus< JF1_t >::div ( const double factor)
inlineinherited

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 267 of file JMathlib.hh.

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: