Template class for spline interpolation in 1D. More...

#include <JSpline.hh>

Inheritance diagram for JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >:

Public Types
typedef JSplineCollection< JElement_t, JCollection_t, JDistance_t >	collection_type

typedef collection_type::abscissa_type	abscissa_type

typedef collection_type::ordinate_type	ordinate_type

typedef collection_type::value_type	value_type

typedef collection_type::distance_type	distance_type

typedef collection_type::const_iterator	const_iterator

typedef collection_type::const_reverse_iterator	const_reverse_iterator

typedef collection_type::iterator	iterator

typedef collection_type::reverse_iterator	reverse_iterator

typedef JFunction1D< abscissa_type, JResult_t >	function_type

typedef function_type::argument_type	argument_type

typedef function_type::result_type	result_type

typedef function_type::JExceptionHandler	exceptionhandler_type

enum

typedef JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type >	functional_type

typedef functional_type::JExceptionHandler	JExceptionHandler

typedef JSupervisor	supervisor_type

Public Member Functions
	JSplineFunction1D ()
	Default contructor.

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.

virtual result_type	evaluate (const argument_type *pX) const=0
	Recursive function value evaluation.

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 Attributes
JSupervisor	__supervisor

Detailed Description

template<class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
class JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >

Template class for spline interpolation in 1D.

This class implements the JFunction1D interface.

Definition at line 731 of file JSpline.hh.

Member Typedef Documentation

◆ collection_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JSplineCollection<JElement_t, JCollection_t, JDistance_t> JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type

Definition at line 737 of file JSpline.hh.

◆ abscissa_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::abscissa_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 739 of file JSpline.hh.

◆ ordinate_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::ordinate_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 740 of file JSpline.hh.

◆ value_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::value_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type

Definition at line 741 of file JSpline.hh.

◆ distance_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::distance_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type

Definition at line 742 of file JSpline.hh.

◆ const_iterator

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::const_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator

Definition at line 744 of file JSpline.hh.

◆ const_reverse_iterator

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::const_reverse_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 745 of file JSpline.hh.

◆ iterator

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator

Definition at line 746 of file JSpline.hh.

◆ reverse_iterator

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::reverse_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator

Definition at line 747 of file JSpline.hh.

◆ function_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JFunction1D<abscissa_type, JResult_t> JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type

Definition at line 749 of file JSpline.hh.

◆ argument_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

function_type::argument_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::argument_type

Definition at line 751 of file JSpline.hh.

◆ result_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

function_type::result_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::result_type

Definition at line 752 of file JSpline.hh.

◆ exceptionhandler_type

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

function_type::JExceptionHandler JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type

Definition at line 753 of file JSpline.hh.

◆ functional_type

JFunctional<JElement_t::abscissa_type, typename JElement_t::ordinate_type> JTOOLS::JFunction1D< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::functional_type

inherited

Definition at line 332 of file JFunctional.hh.

◆ JExceptionHandler

functional_type::JExceptionHandler JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::JExceptionHandler

inherited

Definition at line 235 of file JFunctional.hh.

◆ supervisor_type

JSupervisor JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::supervisor_type

inherited

Definition at line 237 of file JFunctional.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Definition at line 330 of file JFunctional.hh.

330{ NUMBER_OF_DIMENSIONS = 1 };

JTOOLS::JFunction1D< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JFunctional.hh:330

Constructor & Destructor Documentation

◆ JSplineFunction1D()

template<class JElement_t , template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::JSplineFunction1D ( )

inline

Default contructor.

Definition at line 759 of file JSpline.hh.

760 {}

Member Function Documentation

◆ operator()()

result_type JTOOLS::JFunction1D< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::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()

const JSupervisor & JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 290 of file JFunctional.hh.

    {
      return __supervisor;
    }

◆ getExceptionHandler()

const JExceptionHandler & JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::getExceptionHandler ( ) const

inlineoverridevirtualinherited

Get exception handler.

Returns: exception handler

Implements JTOOLS::JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type >.

Definition at line 301 of file JFunctional.hh.

    {
      return *__supervisor.handler;
    }

◆ setExceptionHandler()

void JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::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;
    }

◆ evaluate()

virtual result_type JTOOLS::JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::evaluate ( const argument_type * pX ) const

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

◆ getValue() [1/2]

static result_type JTOOLS::JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::getValue	(	const JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type > &	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]

static JClass< result_type >::argument_type JTOOLS::JFunctional< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::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

◆ __supervisor

JSupervisor JTOOLS::JFunction< JElement_t::abscissa_type, typename JElement_t::ordinate_type >::__supervisor

protectedinherited

Definition at line 318 of file JFunctional.hh.

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

JSpline.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ collection_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ function_type

◆ argument_type

◆ result_type

◆ exceptionhandler_type

◆ functional_type

◆ JExceptionHandler

◆ supervisor_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JSplineFunction1D()

Member Function Documentation

◆ operator()()

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

◆ evaluate()

◆ getValue() [1/2]

◆ getValue() [2/2]

Member Data Documentation

◆ __supervisor