Jpp  19.1.0-rc.1
the software that should make you happy
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. More...
 
 JMul (const JF1_t &f1, const JF2_t &f2)
 Constructor. More...
 
template<class ... Args>
double getValue (const Args &...args) const
 Function value. More...
 
double getDerivative (const double x) const
 Derivative value. More...
 
template<class ... Args>
const JMulgetGradient (const Args &...args) const
 Get gradient. More...
 
double operator() (const Args &...args) const
 Function value. More...
 
JPair< JF1_t, JF2_t > & negate ()
 Negate function. More...
 
JPair< JF1_t, JF2_t > & add (const JPair< JF1_t, JF2_t > &f1)
 Add function. More...
 
JPair< JF1_t, JF2_t > & sub (const JPair< JF1_t, JF2_t > &f1)
 Subtract function. More...
 
JPair< JF1_t, JF2_t > & mul (const double factor)
 Scale function. More...
 
JPair< JF1_t, JF2_t > & div (const double factor)
 Scale function. More...
 

Static Public Attributes

static const parameter_list< JPairparameters
 parameters More...
 

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  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.
Auxiliary data structure for pair of functions.
Definition: JMathlib.hh:939

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  }
forward declaration for subtraction of fuction.
Definition: JMathlib.hh:1133
double getValue(const Args &...args) const
Function value.
Definition: JMathlib.hh:1162
const JMul & getGradient(const Args &...args) const
Get gradient.
Definition: JMathlib.hh:1189

◆ operator()()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 362 of file JMathlib.hh.

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

◆ negate()

JPair< JF1_t, JF2_t > & JMATH::JCalculus< JPair< JF1_t, JF2_t > >::negate ( )
inlineinherited

Negate function.

Returns
this function

Definition at line 203 of file JMathlib.hh.

204  {
205  for (const auto& i : JF1_t::parameters) {
206  static_cast<JF1_t&>(*this).*i = -(static_cast<JF1_t&>(*this).*i);
207  }
208 
209  return static_cast<JF1_t&>(*this);
210  }

◆ add()

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

Add function.

Parameters
f1function
Returns
this function

Definition at line 219 of file JMathlib.hh.

220  {
221  for (const auto& i : JF1_t::parameters) {
222  static_cast<JF1_t&>(*this).*i += f1.*i;
223  }
224 
225  return static_cast<JF1_t&>(*this);
226  }

◆ sub()

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

Subtract function.

Parameters
f1function
Returns
this function

Definition at line 235 of file JMathlib.hh.

236  {
237  for (const auto& i : JF1_t::parameters) {
238  static_cast<JF1_t&>(*this).*i -= f1.*i;
239  }
240 
241  return static_cast<JF1_t&>(*this);
242  }

◆ mul()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 251 of file JMathlib.hh.

252  {
253  for (const auto& i : JF1_t::parameters) {
254  static_cast<JF1_t&>(*this).*i *= factor;
255  }
256 
257  return static_cast<JF1_t&>(*this);
258  }

◆ div()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 267 of file JMathlib.hh.

268  {
269  for (const auto& i : JF1_t::parameters) {
270  static_cast<JF1_t&>(*this).*i /= factor;
271  }
272 
273  return static_cast<JF1_t&>(*this);
274  }

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: