Jpp  18.4.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
JTOOLS::JFunctionObject1D< JArgument_t, JResult_t > Class Template Reference

Template implementation of function object in one dimension. More...

#include <JFunctionObject1D.hh>

Inheritance diagram for JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >:
JTOOLS::JFunction1D< JArgument_t, JResult_t > JTOOLS::JFunctional< JArgument_t, JResult_t >

Public Types

typedef JFunction1D
< JArgument_t, JResult_t > 
function_type
 
typedef
function_type::argument_type 
argument_type
 
typedef function_type::result_type result_type
 
enum  { NUMBER_OF_DIMENSIONS = 1 }
 
typedef JFunctional
< JArgument_t, JResult_t > 
functional_type
 
typedef JSupervisor supervisor_type
 

Public Member Functions

 JFunctionObject1D ()
 Default constructor. More...
 
 JFunctionObject1D (typename JLANG::JClass< result_type >::argument_type y)
 Constructor. More...
 
 JFunctionObject1D (result_type(*f)(const argument_type))
 Constructor. More...
 
virtual result_type evaluate (const argument_type *pX) const override
 Function value evaluation. More...
 
result_type operator() (const argument_type x) const
 Function value evaluation. More...
 
JSupervisor getSupervisor () const
 Get supervisor. More...
 
const JExceptionHandlergetExceptionHandler () const
 Get exception handler. More...
 
void setExceptionHandler (const JSupervisor &supervisor)
 Set the supervisor for handling of exceptions. More...
 

Static Public Member Functions

static result_type getValue (const JFunctional &function, const argument_type *pX)
 Recursive function value evaluation. More...
 
static JClass< result_type >
::argument_type 
getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
 Termination of recursive function value evaluation. More...
 

Protected Member Functions

virtual void do_compile () override
 Function compilation. More...
 

Protected Attributes

JLANG::JSinglePointer
< function_type
function
 
JSupervisor supervisor
 

Detailed Description

template<class JArgument_t, class JResult_t>
class JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >

Template implementation of function object in one dimension.

This class implements the JFunction1D interface.

Definition at line 84 of file JFunctionObject1D.hh.

Member Typedef Documentation

template<class JArgument_t , class JResult_t >
typedef JFunction1D<JArgument_t, JResult_t> JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::function_type

Definition at line 90 of file JFunctionObject1D.hh.

template<class JArgument_t , class JResult_t >
typedef function_type::argument_type JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::argument_type

Definition at line 91 of file JFunctionObject1D.hh.

template<class JArgument_t , class JResult_t >
typedef function_type::result_type JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::result_type

Definition at line 92 of file JFunctionObject1D.hh.

template<class JArgument_t, class JResult_t>
typedef JFunctional<JArgument_t, JResult_t> JTOOLS::JFunction1D< JArgument_t, JResult_t >::functional_type
inherited

Definition at line 337 of file JFunctional.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>
typedef JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor_type
inherited

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

template<class JArgument_t, class JResult_t>
anonymous enum
inherited
Enumerator
NUMBER_OF_DIMENSIONS 

Definition at line 335 of file JFunctional.hh.

Constructor & Destructor Documentation

template<class JArgument_t , class JResult_t >
JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::JFunctionObject1D ( )
inline

Default constructor.

Definition at line 98 of file JFunctionObject1D.hh.

98  :
99  function_type(),
100  function()
101  {}
JFunction1D< JArgument_t, JResult_t > function_type
template<class JArgument_t , class JResult_t >
JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::JFunctionObject1D ( typename JLANG::JClass< result_type >::argument_type  y)
inline

Constructor.

Parameters
yconstant value

Definition at line 109 of file JFunctionObject1D.hh.

109  :
110  function_type(),
112  {}
JFunction1D< JArgument_t, JResult_t > function_type
Template implementation of function object in one dimension returning a constant value.
template<class JArgument_t , class JResult_t >
JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::JFunctionObject1D ( result_type(*)(const argument_type f)
inline

Constructor.

Parameters
fpointer to external function

Definition at line 120 of file JFunctionObject1D.hh.

120  :
121  function_type(),
123  {}
o $QUALITY_ROOT d $DEBUG!CHECK_EXIT_CODE JPlot1D f
Definition: JDataQuality.sh:76
JFunction1D< JArgument_t, JResult_t > function_type
Template implementation of function object in one dimension using an external function.

Member Function Documentation

template<class JArgument_t , class JResult_t >
virtual result_type JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::evaluate ( const argument_type pX) const
inlineoverridevirtual

Function value evaluation.

Parameters
pXpointer to abscissa values
Returns
function value

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 132 of file JFunctionObject1D.hh.

133  {
134  return function->evaluate(pX);
135  }
template<class JArgument_t , class JResult_t >
virtual void JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::do_compile ( )
inlineoverrideprotectedvirtual

Function compilation.

Definition at line 142 of file JFunctionObject1D.hh.

143  {
144  function->compile();
145  }
template<class JArgument_t, class JResult_t>
result_type JTOOLS::JFunction1D< JArgument_t, JResult_t >::operator() ( const argument_type  x) const
inlineinherited

Function value evaluation.

Parameters
xargument value
Returns
function value

Definition at line 348 of file JFunctional.hh.

349  {
350  return this->evaluate(&x);
351  }
virtual result_type evaluate(const argument_type *pX) const =0
Recursive function value evaluation.
template<class JArgument_t = JNullType, class JResult_t = JNullType>
static result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue ( const JFunctional< JArgument_t, JResult_t > &  function,
const argument_type pX 
)
inlinestaticinherited

Recursive function value evaluation.

Parameters
functionfunction
pXpointer to abscissa values

Definition at line 107 of file JFunctional.hh.

109  {
110  return function.evaluate(pX);
111  }
template<class JArgument_t = JNullType, class JResult_t = JNullType>
static JClass<result_type>::argument_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue ( typename JClass< result_type >::argument_type  value,
const argument_type pX 
)
inlinestaticinherited

Termination of recursive function value evaluation.

Parameters
valueresult
pXpointer to abscissa values

Definition at line 121 of file JFunctional.hh.

123  {
124  return value;
125  }
template<class JArgument_t = JNullType, class JResult_t = JNullType>
JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::getSupervisor ( ) const
inlineinherited

Get supervisor.

Returns
supervisor

Definition at line 281 of file JFunctional.hh.

282  {
283  return supervisor;
284  }
JSupervisor supervisor
Definition: JFunctional.hh:310
template<class JArgument_t = JNullType, class JResult_t = JNullType>
const JExceptionHandler& JTOOLS::JFunctional< JArgument_t, JResult_t >::getExceptionHandler ( ) const
inlineinherited

Get exception handler.

Returns
exception handler

Definition at line 292 of file JFunctional.hh.

293  {
294  return *supervisor;
295  }
JSupervisor supervisor
Definition: JFunctional.hh:310
template<class JArgument_t = JNullType, class JResult_t = JNullType>
void JTOOLS::JFunctional< JArgument_t, JResult_t >::setExceptionHandler ( const JSupervisor supervisor)
inlineinherited

Set the supervisor for handling of exceptions.

Parameters
supervisorsupervisor

Definition at line 303 of file JFunctional.hh.

304  {
305  this->supervisor = supervisor;
306  }
JSupervisor supervisor
Definition: JFunctional.hh:310

Member Data Documentation

template<class JArgument_t , class JResult_t >
JLANG::JSinglePointer<function_type> JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::function
protected

Definition at line 148 of file JFunctionObject1D.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>
JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor
protectedinherited

Definition at line 310 of file JFunctional.hh.


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