Jpp 21.0.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JMATH::JMake3Z< JF1_t > Struct Template Reference

Make 3D function of z from 1D function. More...

#include <JMathlib3D.hh>

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

Public Member Functions

 JMake3Z ()
 Default constructor.
 
 JMake3Z (const JF1_t &f1)
 Constructor.
 
template<class ... Args>
 JMake3Z (const Args &...args)
 Constructor.
 
double getValue (const double x, const double y, const double z) const
 Function value.
 
const JMake3ZgetGradient (const double x, const double y, const double z) 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.
 

Detailed Description

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

Make 3D function of z from 1D function.

Definition at line 166 of file JMathlib3D.hh.

Constructor & Destructor Documentation

◆ JMake3Z() [1/3]

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

Default constructor.

Definition at line 176 of file JMathlib3D.hh.

177 {}

◆ JMake3Z() [2/3]

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

Constructor.

Parameters
f1function

Definition at line 185 of file JMathlib3D.hh.

185 :
186 JF1_t(f1)
187 {}

◆ JMake3Z() [3/3]

template<class JF1_t >
template<class ... Args>
JMATH::JMake3Z< JF1_t >::JMake3Z ( const Args &... args)
inline

Constructor.

Parameters
argslist of values

Definition at line 196 of file JMathlib3D.hh.

196 :
197 JF1_t(args...)
198 {}

Member Function Documentation

◆ getValue()

template<class JF1_t >
double JMATH::JMake3Z< JF1_t >::getValue ( const double x,
const double y,
const double z ) const
inline

Function value.

Parameters
xabscissa value
yabscissa value
zabscissa value
Returns
function value

Definition at line 209 of file JMathlib3D.hh.

210 {
211 return static_cast<const JF1_t&>(*this).getValue(z);
212 }

◆ getGradient()

template<class JF1_t >
const JMake3Z & JMATH::JMake3Z< JF1_t >::getGradient ( const double x,
const double y,
const double z ) const
inline

Get gradient.

Parameters
xabscissa value
yabscissa value
zabscissa value
Returns
gradient

Definition at line 223 of file JMathlib3D.hh.

224 {
225 static JMake3Z gradient;
226
227 static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(z);
228
229 return gradient;
230 }
JMake3Z()
Default constructor.

◆ 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 }

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