Jpp  19.1.0-rc.1
the software that should make you happy
Public Member Functions | List of all members
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. More...
 
 JMake3Z (const JF1_t &f1)
 Constructor. More...
 
template<class ... Args>
 JMake3Z (const Args &...args)
 Constructor. More...
 
double getValue (const double x, const double y, const double z) const
 Function value. More...
 
const JMake3Z & getGradient (const double x, const double y, const double z) const
 Get gradient. More...
 
double operator() (const Args &...args) const
 Function value. More...
 

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  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.

◆ 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  }
Make 3D function of z from 1D function.
Definition: JMathlib3D.hh:169
const JMake3Z & getGradient(const double x, const double y, const double z) const
Get gradient.
Definition: JMathlib3D.hh:223

◆ operator()()

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