Jpp 21.0.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JMATH::JX Struct Reference

x. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JX:
JMATH::JMathlib< JX > JMATH::JCalculus< JX > JMATH::JCos< JF1_t > JMATH::JExp< JF1_t > JMATH::JLog< JF1_t > JMATH::JPow< ID_t, JF1_t > JMATH::JSin< JF1_t > JMATH::JSqrt< JF1_t >

Public Member Functions

 JX ()
 Default constructor.
 
double getValue (const double x) const
 Function value.
 
double getDerivative (const double x) const
 Derivative value.
 
JX getGradient (const double x) const
 Get gradient.
 
double operator() (const Args &...args) const
 Function value.
 
double operator[] (const size_t i) const
 Get value of parameter at given index.
 
double & operator[] (const size_t i)
 Get value of parameter at given index.
 
JXnegate ()
 Negate function.
 
JXadd (const JX &f1)
 Add function.
 
JXsub (const JX &f1)
 Subtract function.
 
JXmul (const double factor)
 Scale function.
 
JXdiv (const double factor)
 Scale function.
 

Static Public Attributes

static constexpr parameter_list< JX, 0 > parameters {}
 

Detailed Description

x.

Definition at line 1499 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JX()

JMATH::JX::JX ( )
inline

Default constructor.

Definition at line 1506 of file JMathlib.hh.

1507 {}

Member Function Documentation

◆ getValue()

double JMATH::JX::getValue ( const double x) const
inline

Function value.

Parameters
xabscissa value
Returns
function value

Definition at line 1516 of file JMathlib.hh.

1517 {
1518 return x;
1519 }

◆ getDerivative()

double JMATH::JX::getDerivative ( const double x) const
inline

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 1528 of file JMathlib.hh.

1529 {
1530 return 1.0;
1531 }

◆ getGradient()

JX JMATH::JX::getGradient ( const double x) const
inline

Get gradient.

Parameters
xabscissa value
Returns
gradient

Definition at line 1540 of file JMathlib.hh.

1541 {
1542 JX gradient;
1543
1544 return gradient;
1545 }
JX()
Default constructor.
Definition JMathlib.hh:1506

◆ operator()()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 331 of file JMathlib.hh.

332 {
333 return static_cast<const JF1_t&>(*this).getValue(args...);
334 }

◆ operator[]() [1/2]

double JMATH::JMathlib< JX >::operator[] ( const size_t i) const
inlineinherited

Get value of parameter at given index.

Parameters
iindex
Returns
value

Definition at line 539 of file JMathlib.hh.

540 {
541 return static_cast<const JF1_t&>(*this).*JF1_t::parameters[i];
542 }

◆ operator[]() [2/2]

double & JMATH::JMathlib< JX >::operator[] ( const size_t i)
inlineinherited

Get value of parameter at given index.

Parameters
iindex
Returns
value

Definition at line 551 of file JMathlib.hh.

552 {
553 return static_cast<JF1_t&>(*this).*JF1_t::parameters[i];
554 }

◆ negate()

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

Negate function.

Returns
this function

Definition at line 169 of file JMathlib.hh.

170 {
171 for (const auto& i : JF1_t::parameters) {
172 static_cast<JF1_t&>(*this).*i = -(static_cast<JF1_t&>(*this).*i);
173 }
174
175 return static_cast<JF1_t&>(*this);
176 }

◆ add()

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

Add function.

Parameters
f1function
Returns
this function

Definition at line 185 of file JMathlib.hh.

186 {
187 for (const auto& i : JF1_t::parameters) {
188 static_cast<JF1_t&>(*this).*i += f1.*i;
189 }
190
191 return static_cast<JF1_t&>(*this);
192 }

◆ sub()

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

Subtract function.

Parameters
f1function
Returns
this function

Definition at line 201 of file JMathlib.hh.

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

◆ mul()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 217 of file JMathlib.hh.

218 {
219 for (const auto& i : JF1_t::parameters) {
220 static_cast<JF1_t&>(*this).*i *= factor;
221 }
222
223 return static_cast<JF1_t&>(*this);
224 }

◆ div()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 233 of file JMathlib.hh.

234 {
235 for (const auto& i : JF1_t::parameters) {
236 static_cast<JF1_t&>(*this).*i /= factor;
237 }
238
239 return static_cast<JF1_t&>(*this);
240 }

Member Data Documentation

◆ parameters

parameter_list<JX, 0> JMATH::JX::parameters {}
staticconstexpr

Definition at line 1547 of file JMathlib.hh.

1547{};

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