Jpp  19.1.0-rc.1
the software that should make you happy
Public Member Functions | List of all members
JMATH::JMake3Y< JF1_t > Struct Template Reference

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

#include <JMathlib3D.hh>

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

Public Member Functions

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

Make 3D function of y from 1D function.

Definition at line 94 of file JMathlib3D.hh.

Constructor & Destructor Documentation

◆ JMake3Y() [1/3]

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

Default constructor.

Definition at line 104 of file JMathlib3D.hh.

105  {}

◆ JMake3Y() [2/3]

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

Constructor.

Parameters
f1function

Definition at line 113 of file JMathlib3D.hh.

113  :
114  JF1_t(f1)
115  {}
const JPolynome f1(1.0, 2.0, 3.0)
Function.

◆ JMake3Y() [3/3]

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

Constructor.

Parameters
argslist of values

Definition at line 124 of file JMathlib3D.hh.

124  :
125  JF1_t(args...)
126  {}

Member Function Documentation

◆ getValue()

template<class JF1_t >
double JMATH::JMake3Y< 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 137 of file JMathlib3D.hh.

138  {
139  return static_cast<const JF1_t&>(*this).getValue(y);
140  }

◆ getGradient()

template<class JF1_t >
const JMake3Y& JMATH::JMake3Y< 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 151 of file JMathlib3D.hh.

152  {
153  static JMake3Y gradient;
154 
155  static_cast<JF1_t&>(gradient) = static_cast<const JF1_t&>(*this).getGradient(y);
156 
157  return gradient;
158  }
Make 3D function of y from 1D function.
Definition: JMathlib3D.hh:97
const JMake3Y & getGradient(const double x, const double y, const double z) const
Get gradient.
Definition: JMathlib3D.hh:151

◆ operator()()

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