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

Template implementation of function object in one dimension. More...

#include <JFunctionObject1D.hh>

Inheritance diagram for JTOOLS::JFunctionObject1D< 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
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
	JFunctionObject1D ()
	Default constructor.
	JFunctionObject1D (typename JLANG::JClass< result_type >::argument_type y)
	Constructor.
	JFunctionObject1D (result_type(*f)(const argument_type))
	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
JLANG::JSinglePointer< function_type >	function
JSupervisor	__supervisor

Detailed Description

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

Template implementation of function object in one dimension.

This class implements the JFunction1D interface.

Definition at line 84 of file JFunctionObject1D.hh.

Member Typedef Documentation

function_type

template<class JArgument_t , class JResult_t >

JFunction1D<JArgument_t, JResult_t> JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::function_type

Definition at line 90 of file JFunctionObject1D.hh.

argument_type

template<class JArgument_t , class JResult_t >

function_type::argument_type JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::argument_type

Definition at line 91 of file JFunctionObject1D.hh.

result_type

template<class JArgument_t , class JResult_t >

function_type::result_type JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::result_type

Definition at line 92 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.

{ NUMBER_OF_DIMENSIONS = 1 };

Constructor & Destructor Documentation

JFunctionObject1D() [1/3]

template<class JArgument_t , class JResult_t >

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

inline

Default constructor.

Definition at line 98 of file JFunctionObject1D.hh.

                        :
      function_type(),
      function()
    {}

JFunctionObject1D() [2/3]

template<class JArgument_t , class JResult_t >

JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::JFunctionObject1D ( typename JLANG::JClass< result_type >::argument_type y )

inline

Constructor.

Parameters

y	constant value

Definition at line 109 of file JFunctionObject1D.hh.

                                                                        :
      function_type(),
      function(new JConstantFunction1D<JArgument_t, JResult_t>(y))
    {}

JFunctionObject1D() [3/3]

template<class JArgument_t , class JResult_t >

JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::JFunctionObject1D ( result_type(* f )(const argument_type) )

inline

Constructor.

Parameters

f	pointer to external function

Definition at line 120 of file JFunctionObject1D.hh.

                                                             :
      function_type(),
      function(new JExternalFunction1D<JArgument_t, JResult_t>(f))
    {}

Member Function Documentation

evaluate()

template<class JArgument_t , class JResult_t >

virtual result_type JTOOLS::JFunctionObject1D< 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 132 of file JFunctionObject1D.hh.

    {
      return function->evaluate(pX);
    }

do_compile()

template<class JArgument_t , class JResult_t >

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

inlineoverrideprotectedvirtual

Function compilation.

Definition at line 142 of file JFunctionObject1D.hh.

    {
      function->compile();
    }

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

function

template<class JArgument_t , class JResult_t >

JLANG::JSinglePointer<function_type> JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >::function

protected

Definition at line 148 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