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

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

#include <JFunctional.hh>

Inheritance diagram for JTOOLS::JFunction1D< JArgument_t, JResult_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 result_type	getValue (typename JClass< result_type >::argument_type y, 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 JFunction<>::() operator.

Definition at line 317 of file JFunctional.hh.

Member Typedef Documentation

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.

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.

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.

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

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

inherited

Definition at line 88 of file JFunctional.hh.

Member Enumeration Documentation

template<class JArgument_t, class JResult_t>

anonymous enum

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 320 of file JFunctional.hh.

{ NUMBER_OF_DIMENSIONS = 1 };

Member Function Documentation

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

x	argument value

Returns

function value

Definition at line 333 of file JFunctional.hh.

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

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 virtualinherited

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  )

inlinestaticinherited

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  )

inlinestaticinherited

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

inlineinherited

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

inlineinherited

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 )

inlineinherited

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

protectedinherited

Definition at line 293 of file JFunctional.hh.

---

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

• JFunctional.hh