Jpp  19.1.0
the software that should make you happy
Public Member Functions | Private Attributes | List of all members
JMATH::JDiv< JF1_t, double > Struct Template Reference

Division of constant value. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JDiv< JF1_t, double >:
JMATH::JMathlib< JDiv< JF1_t, double > >

Public Member Functions

 JDiv ()
 Default constructor. More...
 
 JDiv (const JF1_t &f1, const double value)
 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 JDivgetGradient (const Args &...args) const
 Get gradient. More...
 
double operator() (const Args &...args) const
 Function value. More...
 

Private Attributes

double value
 

Detailed Description

template<class JF1_t>
struct JMATH::JDiv< JF1_t, double >

Division of constant value.

Definition at line 858 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JDiv() [1/2]

template<class JF1_t >
JMATH::JDiv< JF1_t, double >::JDiv ( )
inline

Default constructor.

Definition at line 868 of file JMathlib.hh.

869  {}

◆ JDiv() [2/2]

template<class JF1_t >
JMATH::JDiv< JF1_t, double >::JDiv ( const JF1_t &  f1,
const double  value 
)
inline

Constructor.

Parameters
f1function
valuevalue

Definition at line 878 of file JMathlib.hh.

878  :
879  JF1_t(f1),
880  value(value)
881  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.

Member Function Documentation

◆ getValue()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 891 of file JMathlib.hh.

892  {
893  return static_cast<const JF1_t&>(*this).getValue(args...) / value;
894  }

◆ getDerivative()

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

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 903 of file JMathlib.hh.

904  {
905  return static_cast<const JF1_t&>(*this).getDerivative(x) / value;
906  }

◆ getGradient()

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

Get gradient.

Parameters
argsabscissa value(s)
Returns
gradient

Definition at line 916 of file JMathlib.hh.

917  {
918  static JDiv gradient;
919 
920  static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
921  static_cast<JF1_t&>(gradient) /= value;
922 
923  return gradient;
924  }
forward declaration for multiplication of fuction.
Definition: JMathlib.hh:1210
const JDiv & getGradient(const Args &...args) const
Get gradient.
Definition: JMathlib.hh:1269

◆ operator()()

double JMATH::JMathlib< JDiv< JF1_t, double > >::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  }

Member Data Documentation

◆ value

template<class JF1_t >
double JMATH::JDiv< JF1_t, double >::value
private

Definition at line 927 of file JMathlib.hh.


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