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

Power of function. More...

#include <JMathlib.hh>

Inheritance diagram for JMATH::JPow< ID_t, JF1_t >:
JMATH::JMathlib< JPow< ID_t, JX > > JMATH::JX JMATH::JMathlib< JX > JMATH::JCalculus< JX >

Public Member Functions

 JPow ()
 Default constructor.
 
 JPow (const double alpha)
 Constructor.
 
 JPow (const JF1_t &f1, const double alpha)
 Constructor.
 
double getValue (const double x) const
 Function value.
 
double getDerivative (const double x) const
 Derivative value.
 
JPow 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.
 
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.
 
JX & negate ()
 Negate function.
 
JX & add (const JX &f1)
 Add function.
 
JX & sub (const JX &f1)
 Subtract function.
 
JX & mul (const double factor)
 Scale function.
 
JX & div (const double factor)
 Scale function.
 

Static Public Member Functions

static size_t size ()
 Get size of parameter.
 
static size_t size ()
 Get size of parameter.
 

Public Attributes

double alpha
 f(x)^alpha
 

Static Public Attributes

static const int ID = ID_t
 
static constexpr parameter_list< JPow, JF1_t::parameters.size()+1 > parameters = join<JPow>(JF1_t::parameters, &JPow::alpha)
 

Detailed Description

template<int ID_t, class JF1_t = JX>
struct JMATH::JPow< ID_t, JF1_t >

Power of function.

Definition at line 2201 of file JMathlib.hh.

Constructor & Destructor Documentation

◆ JPow() [1/3]

template<int ID_t, class JF1_t = JX>
JMATH::JPow< ID_t, JF1_t >::JPow ( )
inline

Default constructor.

Definition at line 2214 of file JMathlib.hh.

2214 :
2215 JF1_t(),
2216 alpha(0.0)
2217 {}
JMATH::JPow::alpha
double alpha
f(x)^alpha
Definition JMathlib.hh:2293

◆ JPow() [2/3]

template<int ID_t, class JF1_t = JX>
JMATH::JPow< ID_t, JF1_t >::JPow ( const double alpha)
inline

Constructor.

Parameters
alphavalue

Definition at line 2225 of file JMathlib.hh.

2225 :
2226 JF1_t(),
2227 alpha(alpha)
2228 {}

◆ JPow() [3/3]

template<int ID_t, class JF1_t = JX>
JMATH::JPow< ID_t, JF1_t >::JPow ( const JF1_t & f1,
const double alpha )
inline

Constructor.

Parameters
f1function
alphavalue

Definition at line 2237 of file JMathlib.hh.

2237 :
2238 JF1_t(f1),
2239 alpha(alpha)
2240 {}

Member Function Documentation

◆ getValue()

template<int ID_t, class JF1_t = JX>
double JMATH::JPow< ID_t, JF1_t >::getValue ( const double x) const
inline

Function value.

Parameters
xabscissa value
Returns
function value

Definition at line 2249 of file JMathlib.hh.

2250 {
2251 const double u = static_cast<const JF1_t&>(*this).getValue(x);
2252
2253 return pow(u, alpha);
2254 }
JMATH::pow
T pow(const T &x, const double y)
Power .
Definition JMath.hh:97

◆ getDerivative()

template<int ID_t, class JF1_t = JX>
double JMATH::JPow< ID_t, JF1_t >::getDerivative ( const double x) const
inline

Derivative value.

Parameters
xabscissa value
Returns
derivative value

Definition at line 2263 of file JMathlib.hh.

2264 {
2265 const double u = static_cast<const JF1_t&>(*this).getValue(x);
2266 const double v = static_cast<const JF1_t&>(*this).getDerivative(x);
2267
2268 return alpha * pow(u, alpha - 1) * v;
2269 }

◆ getGradient()

template<int ID_t, class JF1_t = JX>
JPow JMATH::JPow< ID_t, JF1_t >::getGradient ( const double x) const
inline

Get gradient.

Parameters
xabscissa value
Returns
gradient

Definition at line 2278 of file JMathlib.hh.

2279 {
2280 JPow gradient;
2281
2282 const double u = static_cast<const JF1_t&>(*this).getValue(x);
2283 const double w = pow(u, alpha);
2284
2285 gradient.alpha = w * log(u);
2286
2287 static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(x);
2288 static_cast<JF1_t&>(gradient) *= alpha * w / u;
2289
2290 return gradient;
2291 }
JMATH::JPow::JPow
JPow()
Default constructor.
Definition JMathlib.hh:2214

◆ operator()() [1/2]

double JMATH::JMathlib< JPow< ID_t, 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 }
get_convergence_angle.args
args
Definition get_convergence_angle.py:19

◆ size() [1/2]

static size_t JMATH::JMathlib< JPow< ID_t, JX > >::size ( )
inlinestaticinherited

Get size of parameter.

Returns
size

Definition at line 538 of file JMathlib.hh.

539 {
540 return JF1_t::parameters.size();
541 }

◆ operator[]() [1/4]

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

Get value of parameter at given index.

Parameters
iindex
Returns
value

Definition at line 550 of file JMathlib.hh.

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

◆ operator[]() [2/4]

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

Get value of parameter at given index.

Parameters
iindex
Returns
value

Definition at line 562 of file JMathlib.hh.

563 {
564 return static_cast<JF1_t&>(*this).*JF1_t::parameters[i];
565 }

◆ operator()() [2/2]

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 }

◆ size() [2/2]

static size_t JMATH::JMathlib< JX >::size ( )
inlinestaticinherited

Get size of parameter.

Returns
size

Definition at line 538 of file JMathlib.hh.

539 {
540 return JF1_t::parameters.size();
541 }

◆ operator[]() [3/4]

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 550 of file JMathlib.hh.

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

◆ operator[]() [4/4]

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

Get value of parameter at given index.

Parameters
iindex
Returns
value

Definition at line 562 of file JMathlib.hh.

563 {
564 return static_cast<JF1_t&>(*this).*JF1_t::parameters[i];
565 }

◆ negate()

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

Negate function.

Returns
this function

Definition at line 170 of file JMathlib.hh.

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

◆ add()

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

Add function.

Parameters
f1function
Returns
this function

Definition at line 186 of file JMathlib.hh.

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

◆ sub()

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

Subtract function.

Parameters
f1function
Returns
this function

Definition at line 202 of file JMathlib.hh.

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

◆ mul()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 218 of file JMathlib.hh.

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

◆ div()

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

Scale function.

Parameters
factorfactor
Returns
this function

Definition at line 234 of file JMathlib.hh.

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

Member Data Documentation

◆ ID

template<int ID_t, class JF1_t = JX>
const int JMATH::JPow< ID_t, JF1_t >::ID = ID_t
static

Definition at line 2205 of file JMathlib.hh.

◆ alpha

template<int ID_t, class JF1_t = JX>
double JMATH::JPow< ID_t, JF1_t >::alpha

f(x)^alpha

Definition at line 2293 of file JMathlib.hh.

◆ parameters

template<int ID_t, class JF1_t = JX>
parameter_list<JPow, JF1_t::parameters.size() + 1> JMATH::JPow< ID_t, JF1_t >::parameters = join<JPow>(JF1_t::parameters, &JPow::alpha)
staticconstexpr

Definition at line 2295 of file JMathlib.hh.

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