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

Subtraction of constant value. More...

#include <JMathlib.hh>

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

Public Member Functions

 JSub ()
 Default constructor. More...
 
 JSub (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 JSubgetGradient (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::JSub< JF1_t, double >

Subtraction of constant value.

Definition at line 705 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JSub() [1/2]

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

Default constructor.

Definition at line 715 of file JMathlib.hh.

716  {}

◆ JSub() [2/2]

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

Constructor.

Parameters
f1function
valuevalue

Definition at line 725 of file JMathlib.hh.

725  :
726  JF1_t(f1),
727  value(value)
728  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.

Member Function Documentation

◆ getValue()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 738 of file JMathlib.hh.

739  {
740  return static_cast<const JF1_t&>(*this).getValue(args...) - value;
741  }

◆ getDerivative()

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

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 750 of file JMathlib.hh.

751  {
752  return static_cast<const JF1_t&>(*this).getDerivative(x);
753  }

◆ getGradient()

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

Get gradient.

Parameters
argsabscissa value(s)
Returns
gradient

Definition at line 763 of file JMathlib.hh.

764  {
765  static JSub gradient;
766 
767  static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
768 
769  return gradient;
770  }
forward declaration for addition of fuction.
Definition: JMathlib.hh:1057
const JSub & getGradient(const Args &...args) const
Get gradient.
Definition: JMathlib.hh:1113

◆ operator()()

double JMATH::JMathlib< JSub< 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::JSub< JF1_t, double >::value
private

Definition at line 773 of file JMathlib.hh.


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