Jpp
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
JTOOLS::JFunction1D< JArgument_t, JResult_t > Struct Template Referenceabstract

Template definition of function object interface in one dimension. More...

#include <JFunctional.hh>

Inheritance diagram for JTOOLS::JFunction1D< JArgument_t, JResult_t >:
JTOOLS::JFunction< JArgument_t, JResult_t > JTOOLS::JFunctional< JArgument_t, JResult_t > JTOOLS::JConstantFunction1D< JArgument_t, JResult_t > JTOOLS::JExternalFunction1D< JArgument_t, JResult_t > JTOOLS::JFunctionObject1D< JArgument_t, JResult_t > JTOOLS::JMultiFunction< JConstantFunction1D< JArgument_t, JResult_t >, JMapList< JMap_t >, JDistance_t >

Public Types

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

Public Member Functions

result_type operator() (const argument_type x) const
 Function value evaluation. More...
 
virtual result_type evaluate (const argument_type *pX) const =0
 Recursive function value evaluation. More...
 
JSupervisor getSupervisor () const
 Get supervisor. More...
 
const JExceptionHandler & getExceptionHandler () 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 Attributes

JSupervisor supervisor
 

Detailed Description

template<class JArgument_t, class JResult_t>
struct JTOOLS::JFunction1D< JArgument_t, JResult_t >

Template definition of function object interface in one dimension.

This class provides for the standard function operator ().

Definition at line 317 of file JFunctional.hh.

Member Typedef Documentation

◆ functional_type

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

Definition at line 322 of file JFunctional.hh.

◆ argument_type

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

Definition at line 323 of file JFunctional.hh.

◆ result_type

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

Definition at line 324 of file JFunctional.hh.

◆ supervisor_type

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

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

◆ anonymous enum

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

Definition at line 320 of file JFunctional.hh.

320 { NUMBER_OF_DIMENSIONS = 1 };

Member Function Documentation

◆ operator()()

template<class JArgument_t, class JResult_t>
result_type JTOOLS::JFunction1D< JArgument_t, JResult_t >::operator() ( const argument_type  x) const
inline

Function value evaluation.

Parameters
xargument value
Returns
function value

Definition at line 333 of file JFunctional.hh.

334  {
335  return this->evaluate(&x);
336  }

◆ evaluate()

template<class JArgument_t, class JResult_t>
virtual result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::evaluate ( const argument_type *  pX) const
pure virtualinherited

Recursive function value evaluation.

Parameters
pXpointer to abscissa values
Returns
function value

Implemented in JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultType< JValue_t >::result_type, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultType< JValue_t >::result_type, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, JResultPDF< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, JResultPDF< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >, JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >, and JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >.

◆ getValue() [1/2]

template<class JArgument_t, class JResult_t>
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  }

◆ getValue() [2/2]

template<class JArgument_t, class JResult_t>
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  }

◆ getSupervisor()

template<class JArgument_t, class JResult_t>
JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::getSupervisor ( ) const
inlineinherited

Get supervisor.

Returns
supervisor

Definition at line 266 of file JFunctional.hh.

267  {
268  return supervisor;
269  }

◆ getExceptionHandler()

template<class JArgument_t, class JResult_t>
const JExceptionHandler& JTOOLS::JFunctional< JArgument_t, JResult_t >::getExceptionHandler ( ) const
inlineinherited

Get exception handler.

Returns
exception handler

Definition at line 277 of file JFunctional.hh.

278  {
279  return *supervisor;
280  }

◆ setExceptionHandler()

template<class JArgument_t, class JResult_t>
void JTOOLS::JFunctional< JArgument_t, JResult_t >::setExceptionHandler ( const JSupervisor &  supervisor)
inlineinherited

Set the supervisor for handling of exceptions.

Parameters
supervisorsupervisor

Definition at line 288 of file JFunctional.hh.

289  {
290  this->supervisor = supervisor;
291  }

Member Data Documentation

◆ supervisor

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

Definition at line 295 of file JFunctional.hh.

The documentation for this struct was generated from the following file:
JTOOLS::JFunctional::supervisor
JSupervisor supervisor
Definition: JFunctional.hh:295
JTOOLS::pX
pX
Definition: JPolint.hh:625
JTOOLS::JFunction1D::NUMBER_OF_DIMENSIONS
Definition: JFunctional.hh:320
JTOOLS::JFunctional::evaluate
virtual result_type evaluate(const argument_type *pX) const =0
Recursive function value evaluation.
Generated by   doxygen 1.8.16