Jpp 21.0.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
JMATH::JSub< JF1_t, JF2_t > Struct Template Reference

forward declaration for addition of fuction. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JSub< JF1_t, JF2_t >:
JMATH::JMathlib< JSub< JF1_t, JF2_t > > JMATH::JPair_t< JF1_t, JF2_t > JMATH::JPair< JF1_t, JF2_t, v1, v2 > JMATH::JCalculus< JPair_t< JF1_t, JF2_t > >

Public Member Functions

 JSub ()
 Default constructor.
 
 JSub (const JF1_t &f1, const JF2_t &f2)
 Constructor.
 
template<class ... Args>
double getValue (const Args &...args) const
 Function value.
 
double getDerivative (const double x) const
 Derivative value.
 
template<class ... Args>
JSub getGradient (const Args &...args) 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.
 
JF1_t & negate ()
 Negate function.
 
JF1_t & add (const JF1_t &f1)
 Add function.
 
JF1_t & sub (const JF1_t &f1)
 Subtract function.
 
JF1_t & mul (const double factor)
 Scale function.
 
JF1_t & div (const double factor)
 Scale function.
 

Static Public Attributes

static constexpr parameter_list< JPair, JF1_t::parameters.size()+JF2_t::parameters.size()> parameters = join<JPair>(JF1_t::parameters, JF2_t::parameters)
 

Detailed Description

template<class JF1_t, class JF2_t>
struct JMATH::JSub< JF1_t, JF2_t >

forward declaration for addition of fuction.

Subtraction of two functions.

Definition at line 1173 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JSub() [1/2]

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

Default constructor.

Definition at line 1184 of file JMathlib.hh.

1185 {}

◆ JSub() [2/2]

template<class JF1_t , class JF2_t >
JMATH::JSub< JF1_t, JF2_t >::JSub ( const JF1_t & f1,
const JF2_t & f2 )
inline

Constructor.

Parameters
f1first function
f2second function

Definition at line 1194 of file JMathlib.hh.

1194 :
1195 JPair_t<JF1_t, JF2_t>(f1, f2)
1196 {}
JMATH::JPair_t::JPair_t
JPair_t()
Default constructor.
Definition JMathlib.hh:1077

Member Function Documentation

◆ getValue()

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

Function value.

Parameters
argsabscissa value(s)
Returns
function value

Definition at line 1206 of file JMathlib.hh.

1207 {
1208 return (static_cast<const JF1_t&>(*this).getValue(args...) -
1209 static_cast<const JF2_t&>(*this).getValue(args...));
1210 }
get_convergence_angle.args
args
Definition get_convergence_angle.py:19

◆ getDerivative()

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

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 1219 of file JMathlib.hh.

1220 {
1221 return (static_cast<const JF1_t&>(*this).getDerivative(x) -
1222 static_cast<const JF2_t&>(*this).getDerivative(x));
1223 }

◆ getGradient()

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

Get gradient.

Parameters
argsabscissa value(s)
Returns
gradient

Definition at line 1233 of file JMathlib.hh.

1234 {
1235 JSub gradient;
1236
1237 static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(args...);
1238 static_cast<JF2_t&>(gradient) = static_cast<const JF2_t&>(*this).getGradient(args...);
1239 static_cast<JF2_t&>(gradient).negate();
1240
1241 return gradient;
1242 }
JMATH::JSub::JSub
JSub()
Default constructor.
Definition JMathlib.hh:1184

◆ operator()()

double JMATH::JMathlib< JF1_t >::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< JF1_t >::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< JF1_t >::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()

JF1_t & JMATH::JCalculus< JF1_t >::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()

JF1_t & JMATH::JCalculus< JF1_t >::add ( const JF1_t & 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()

JF1_t & JMATH::JCalculus< JF1_t >::sub ( const JF1_t & 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()

JF1_t & JMATH::JCalculus< JF1_t >::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()

JF1_t & JMATH::JCalculus< JF1_t >::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

template<class JF1_t , class JF2_t , bool v1 = JF1_t::parameters.size() != 0 || std::is_base_of<JPf<>, JF1_t>::value, bool v2 = JF2_t::parameters.size() != 0 || std::is_base_of<JPf<>, JF2_t>::value>
parameter_list<JPair, JF1_t::parameters.size() + JF2_t::parameters.size()> JMATH::JPair< JF1_t, JF2_t, v1, v2 >::parameters = join<JPair>(JF1_t::parameters, JF2_t::parameters)
staticconstexprinherited

Definition at line 969 of file JMathlib.hh.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.12.0