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

Template implementation of function object in one dimension using an external function. More...

#include <JFunctionObject1D.hh>

Inheritance diagram for JTOOLS::JExternalFunction1D< 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
typedef result_type(*	pointerToFunction) (const argument_type)
enum	{ NUMBER_OF_DIMENSIONS = 1 }
typedef JFunctional< JArgument_t, JResult_t >	functional_type
typedef JSupervisor	supervisor_type

Public Member Functions
	JExternalFunction1D (pointerToFunction function)
	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 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 Member Functions
virtual void	do_compile () override
	Function compilation. More...

Protected Attributes
pointerToFunction	__f
JSupervisor	supervisor

Detailed Description

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

Template implementation of function object in one dimension using an external function.

This class implements the JFunction1D interface.

Definition at line 31 of file JFunctionObject1D.hh.

Member Typedef Documentation

function_type

template<class JArgument_t , class JResult_t >

typedef JFunction1D<JArgument_t, JResult_t> JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::function_type

Definition at line 36 of file JFunctionObject1D.hh.

argument_type

template<class JArgument_t , class JResult_t >

typedef function_type::argument_type JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::argument_type

Definition at line 37 of file JFunctionObject1D.hh.

result_type

template<class JArgument_t , class JResult_t >

typedef function_type::result_type JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::result_type

Definition at line 38 of file JFunctionObject1D.hh.

pointerToFunction

template<class JArgument_t , class JResult_t >

typedef result_type(* JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::pointerToFunction) (const argument_type)

Definition at line 40 of file JFunctionObject1D.hh.

functional_type

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.

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

inherited

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 335 of file JFunctional.hh.

{ NUMBER_OF_DIMENSIONS = 1 };

Constructor & Destructor Documentation

JExternalFunction1D()

template<class JArgument_t , class JResult_t >

JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::JExternalFunction1D ( pointerToFunction  function )

inline

Constructor.

Parameters

function

pointer to function

Definition at line 48 of file JFunctionObject1D.hh.

                                                    :
      function_type(),
      __f(function)
    {}

Member Function Documentation

evaluate()

template<class JArgument_t , class JResult_t >

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

inlineoverridevirtual

Function value evaluation.

Parameters

pX	pointer to abscissa values

Returns

function value

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 60 of file JFunctionObject1D.hh.

    {
      return __f(*pX);
    }

do_compile()

template<class JArgument_t , class JResult_t >

virtual void JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::do_compile ( )

inlineoverrideprotectedvirtual

Function compilation.

Definition at line 70 of file JFunctionObject1D.hh.

    {}

operator()()

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

x	argument value

Returns

function value

Definition at line 348 of file JFunctional.hh.

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

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 107 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 121 of file JFunctional.hh.

    {
      return value;
    }

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 281 of file JFunctional.hh.

    {
      return supervisor;
    }

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 292 of file JFunctional.hh.

    {
      return *supervisor;
    }

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

supervisor

supervisor

Definition at line 303 of file JFunctional.hh.

    {
      this->supervisor = supervisor;
    }

Member Data Documentation

__f

template<class JArgument_t , class JResult_t >

pointerToFunction JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >::__f

protected

Definition at line 74 of file JFunctionObject1D.hh.

supervisor

template<class JArgument_t , class JResult_t >

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:

• JFunctionObject1D.hh