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 functional_type::JExceptionHandler	JExceptionHandler

typedef JSupervisor	supervisor_type

Public Member Functions
	JExternalFunction1D (pointerToFunction function)
	Constructor.

virtual result_type	evaluate (const argument_type *pX) const override
	Function value evaluation.

result_type	operator() (const argument_type x) const
	Function value evaluation.

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.

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 Member Functions
virtual void	do_compile () override
	Function compilation.

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 >

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 >

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 >

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 >

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 >

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

inherited

Definition at line 332 of file JFunctional.hh.

◆ JExceptionHandler

template<class JArgument_t , class JResult_t >

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

inherited

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

inherited

Definition at line 237 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 330 of file JFunctional.hh.

330{ NUMBER_OF_DIMENSIONS = 1 };

JTOOLS::JFunction1D::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JFunctional.hh:330

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.

71 {}

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

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

◆ getSupervisor()

template<class JArgument_t , class JResult_t >

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

inlineinherited

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

inlineoverridevirtualinherited

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 )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 312 of file JFunctional.hh.

    {
      this->__supervisor = supervisor;
    }

◆ 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

◆ __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::JFunction< JArgument_t, JResult_t >::__supervisor

protectedinherited

Definition at line 318 of file JFunctional.hh.

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

JFunctionObject1D.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ function_type

◆ argument_type

◆ result_type

◆ pointerToFunction

◆ functional_type

◆ JExceptionHandler

◆ supervisor_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JExternalFunction1D()

Member Function Documentation

◆ evaluate()

◆ do_compile()

◆ operator()()

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

◆ getValue() [1/2]

◆ getValue() [2/2]

Member Data Documentation

◆ __f

◆ __supervisor