Jpp  master_rocky-43-ge265d140c
the software that should make you happy
Public Member Functions | List of all members
JMATH::JExp< JF1_t > Struct Template Reference

Exponent of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JExp< JF1_t >:
JMATH::JMathlib< JExp< JF1_t > >

Public Member Functions

 JExp ()
 Default constructor. More...
 
 JExp (const JF1_t &f1)
 Constructor. More...
 
double getValue (const double x) const
 Function value. More...
 
double getDerivative (const double x) const
 Derivative value. More...
 
const JExpgetGradient (const double x) const
 Get gradient. More...
 
double operator() (const Args &...args) const
 Function value. More...
 

Detailed Description

template<class JF1_t>
struct JMATH::JExp< JF1_t >

Exponent of function.

Definition at line 2403 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JExp() [1/2]

template<class JF1_t >
JMATH::JExp< JF1_t >::JExp ( )
inline

Default constructor.

Definition at line 2413 of file JMathlib.hh.

2413  :
2414  JF1_t()
2415  {}

◆ JExp() [2/2]

template<class JF1_t >
JMATH::JExp< JF1_t >::JExp ( const JF1_t &  f1)
inline

Constructor.

Parameters
f1function

Definition at line 2423 of file JMathlib.hh.

2423  :
2424  JF1_t(f1)
2425  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.

Member Function Documentation

◆ getValue()

template<class JF1_t >
double JMATH::JExp< JF1_t >::getValue ( const double  x) const
inline

Function value.

Parameters
xabscissa value
Returns
function value

Definition at line 2434 of file JMathlib.hh.

2435  {
2436  return exp(static_cast<const JF1_t&>(*this).getValue(x));
2437  }

◆ getDerivative()

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

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 2446 of file JMathlib.hh.

2447  {
2448  return static_cast<const JF1_t&>(*this).getDerivative(x) * getValue(x);
2449  }
double getValue(const double x) const
Function value.
Definition: JMathlib.hh:2434

◆ getGradient()

template<class JF1_t >
const JExp& JMATH::JExp< JF1_t >::getGradient ( const double  x) const
inline

Get gradient.

Parameters
xabscissa value
Returns
gradient

Definition at line 2458 of file JMathlib.hh.

2459  {
2460  static JExp gradient;
2461 
2462  gradient = static_cast<const JF1_t&>(*this).getGradient(x);
2463  gradient *= getValue(x);
2464 
2465  return gradient;
2466  }
Exponent of function.
Definition: JMathlib.hh:2406
const JExp & getGradient(const double x) const
Get gradient.
Definition: JMathlib.hh:2458

◆ operator()()

double JMATH::JMathlib< JExp< 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.

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

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