JTOOLS::JFunction< JArgument_t, JResult_t > Struct Template Reference

Template definition of function object interface in multidimensions. More...

#include <JFunctional.hh>

Inheritance diagram for JTOOLS::JFunction< JArgument_t, JResult_t >:

Classes
class	JSupervisor
	Place holder for exception handler. More...

Public Types
typedef JFunctional< JArgument_t, JResult_t >	functional_type
typedef functional_type::argument_type	argument_type
typedef functional_type::result_type	result_type
typedef functional_type::JExceptionHandler	JExceptionHandler
typedef JSupervisor	supervisor_type

Public Member Functions
const JSupervisor &	getSupervisor () const
	Get supervisor.
const JExceptionHandler &	getExceptionHandler () const override
	Get exception handler.
void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions.
virtual result_type	evaluate (const argument_type *pX) const =0
	Recursive function value evaluation.

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

Protected Attributes
JSupervisor	__supervisor

Detailed Description

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

Template definition of function object interface in multidimensions.

Definition at line 229 of file JFunctional.hh.

Member Typedef Documentation

functional_type

template<class JArgument_t , class JResult_t >

JFunctional<JArgument_t, JResult_t> JTOOLS::JFunction< JArgument_t, JResult_t >::functional_type

Definition at line 232 of file JFunctional.hh.

argument_type

template<class JArgument_t , class JResult_t >

functional_type::argument_type JTOOLS::JFunction< JArgument_t, JResult_t >::argument_type

Definition at line 233 of file JFunctional.hh.

result_type

template<class JArgument_t , class JResult_t >

functional_type::result_type JTOOLS::JFunction< JArgument_t, JResult_t >::result_type

Definition at line 234 of file JFunctional.hh.

JExceptionHandler

template<class JArgument_t , class JResult_t >

functional_type::JExceptionHandler JTOOLS::JFunction< JArgument_t, JResult_t >::JExceptionHandler

Definition at line 235 of file JFunctional.hh.

supervisor_type

template<class JArgument_t , class JResult_t >

JSupervisor JTOOLS::JFunction< JArgument_t, JResult_t >::supervisor_type

Definition at line 237 of file JFunctional.hh.

Member Function Documentation

getSupervisor()

template<class JArgument_t , class JResult_t >

const JSupervisor & JTOOLS::JFunction< JArgument_t, JResult_t >::getSupervisor ( ) const

inline

Get supervisor.

Returns

supervisor

Definition at line 290 of file JFunctional.hh.

    {
      return __supervisor;
    }

getExceptionHandler()

template<class JArgument_t , class JResult_t >

const JExceptionHandler & JTOOLS::JFunction< JArgument_t, JResult_t >::getExceptionHandler ( ) const

inlineoverridevirtual

Get exception handler.

Returns

exception handler

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 301 of file JFunctional.hh.

    {
      return *__supervisor.handler;
    }

setExceptionHandler()

template<class JArgument_t , class JResult_t >

void JTOOLS::JFunction< JArgument_t, JResult_t >::setExceptionHandler ( const JSupervisor & supervisor )

inline

Set the supervisor for handling of exceptions.

Parameters

supervisor

supervisor

Definition at line 312 of file JFunctional.hh.

    {
      this->__supervisor = supervisor;
    }

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

pX	pointer to abscissa values

Returns

function value

Implemented in JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >, JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >, JTOOLS::JFunctionObject1D< JArgument_t, JResult_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, JResultPDF< 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::JHermiteSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::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, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance< JKey_t > >, and JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance< JKey_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

function	function
pX	pointer to abscissa values

Definition at line 103 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

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

value	result
pX	pointer to abscissa values

Definition at line 117 of file JFunctional.hh.

    {
      return value;
    }

Member Data Documentation

__supervisor

template<class JArgument_t , class JResult_t >

JSupervisor JTOOLS::JFunction< JArgument_t, JResult_t >::__supervisor

protected

Definition at line 318 of file JFunctional.hh.

---

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

• JFunctional.hh