JTOOLS::JFunctional< JArgument_t, JResult_t > Class Template Reference

Template definition of function object interface. More...

#include <JFunctional.hh>

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

Classes
struct	JDefaultResult
	Exception handler for functional object using default result. More...
struct	JExceptionHandler
	Exception handler for functional object. More...
class	JSupervisor
	Place holder for exception handler. More...

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

Public Member Functions
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 result_type	getValue (typename JClass< result_type >::argument_type y, const argument_type *pX)
	Termination of recursive function value evaluation. More...

Protected Member Functions
	JFunctional ()
	Default constructor. More...

Protected Attributes
JSupervisor	supervisor

Detailed Description

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

Template definition of function object interface.

Template definition of recursive function value evaluation.

Definition at line 31 of file JFunctional.hh.

Member Typedef Documentation

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JArgument_t JTOOLS::JFunctional< JArgument_t, JResult_t >::argument_type

Definition at line 83 of file JFunctional.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JResult_t JTOOLS::JFunctional< JArgument_t, JResult_t >::result_type

Definition at line 86 of file JFunctional.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JFunctional<argument_type, result_type> JTOOLS::JFunctional< JArgument_t, JResult_t >::functional_type

Definition at line 87 of file JFunctional.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor_type

Definition at line 88 of file JFunctional.hh.

Constructor & Destructor Documentation

template<class JArgument_t = JNullType, class JResult_t = JNullType>

JTOOLS::JFunctional< JArgument_t, JResult_t >::JFunctional ( )

inlineprotected

Default constructor.

Definition at line 76 of file JFunctional.hh.

                  :
      JFunctional<JNullType, JNullType>(),
      supervisor(JSupervisor::getInstance())
    {}

Member Function Documentation

template<class JArgument_t = JNullType, class JResult_t = JNullType>

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

pure virtual

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns

function value

Implemented in JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultHesse< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, 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, JMap, JResultHesse< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >, JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >, and JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >.

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  )

inlinestatic

Recursive function value evaluation.

Parameters

function	function
pX	pointer to abscissa values

Definition at line 106 of file JFunctional.hh.

    {
      return function.evaluate(pX);
    }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

static result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue ( typename JClass< result_type >::argument_type  y, const argument_type *  pX  )

inlinestatic

Termination of recursive function value evaluation.

Parameters

y	result
pX	pointer to abscissa values

Definition at line 119 of file JFunctional.hh.

    {
      return y;
    }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

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

inline

Get supervisor.

Returns

supervisor

Definition at line 264 of file JFunctional.hh.

    {
      return supervisor;
    }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

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

inline

Get exception handler.

Returns

exception handler

Definition at line 275 of file JFunctional.hh.

    {
      return *supervisor;
    }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

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

inline

Set the supervisor for handling of exceptions.

Parameters

supervisor

supervisor

Definition at line 286 of file JFunctional.hh.

    {
      this->supervisor = supervisor;
    }

Member Data Documentation

template<class JArgument_t = JNullType, class JResult_t = JNullType>

JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor

protected

Definition at line 293 of file JFunctional.hh.

---

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

• JFunctional.hh