Jpp  master_rocky
the software that should make you happy
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t > Class Template Referenceabstract

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

#include <JSpline.hh>

Inheritance diagram for JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >:
JTOOLS::JSplineFunction< JElement_t, JCollection_t, typename JElement_t::ordinate_type, JDistance< typename JElement_t::abscissa_type > > JTOOLS::JFunction1D< JElement_t::abscissa_type, typename JElement_t::ordinate_type > JTOOLS::JFunctional< JArgument_t, JResult_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 JSupervisor supervisor_type
 

Public Member Functions

 JSplineFunction1D ()
 Default contructor. More...
 
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 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 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 735 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>>
typedef JSplineCollection<JElement_t, JCollection_t, JDistance_t> JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type

Definition at line 741 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>>
typedef collection_type::abscissa_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 743 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>>
typedef collection_type::ordinate_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 744 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>>
typedef collection_type::value_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type

Definition at line 745 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>>
typedef collection_type::distance_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type

Definition at line 746 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>>
typedef collection_type::const_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator

Definition at line 748 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>>
typedef collection_type::const_reverse_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 749 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>>
typedef collection_type::iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator

Definition at line 750 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>>
typedef collection_type::reverse_iterator JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator

Definition at line 751 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>>
typedef JFunction1D<abscissa_type, JResult_t> JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type

Definition at line 753 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>>
typedef function_type::argument_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::argument_type

Definition at line 755 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>>
typedef function_type::result_type JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::result_type

Definition at line 756 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>>
typedef function_type::JExceptionHandler JTOOLS::JSplineFunction1D< JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type

Definition at line 757 of file JSpline.hh.

◆ functional_type

typedef 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 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

anonymous enum
inherited

Definition at line 335 of file JFunctional.hh.

335 { NUMBER_OF_DIMENSIONS = 1 };

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 763 of file JSpline.hh.

764  {}

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
xargument value
Returns
function value

Definition at line 348 of file JFunctional.hh.

349  {
350  return this->evaluate(&x);
351  }
JTOOLS::JFunctional::evaluate
virtual result_type evaluate(const argument_type *pX) const =0
Recursive function value evaluation.

◆ evaluate()

template<class JArgument_t , class JResult_t >
virtual result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::evaluate ( const argument_type *  pX) const
pure virtualinherited

Recursive function value evaluation.

Parameters
pXpointer to abscissa values
Returns
function value

Implemented in JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultType< JValue_t >::result_type, JDistance< JKey_t > >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance< JKey_t > >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultType< JValue_t >::result_type, JDistance< JKey_t > >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance< JKey_t > >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, JResultPDF< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JSplineFunction< JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, JResultHesse< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, JResultPolynome< M, typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, JResultPDF< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JPolintFunction< 1, JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JPolintFunction< 0, JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >, JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, typename JElement_t::ordinate_type, JDistance< typename JElement_t::abscissa_type > >, JTOOLS::JHermiteSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, JResultPDF< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, JResultDerivative< typename JResultType< typename JElement_t::ordinate_type >::result_type >, JDistance_t >, JTOOLS::JHermiteSplineFunction< JElement_t, JCollection_t, typename JResultType< typename JElement_t::ordinate_type >::result_type, JDistance_t >, JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >, JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >, and JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >.

◆ 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
functionfunction
pXpointer to abscissa values

Definition at line 107 of file JFunctional.hh.

109  {
110  return function.evaluate(pX);
111  }

◆ 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
valueresult
pXpointer to abscissa values

Definition at line 121 of file JFunctional.hh.

123  {
124  return value;
125  }

◆ 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.

282  {
283  return supervisor;
284  }
JTOOLS::JFunctional::supervisor
JSupervisor supervisor
Definition: JFunctional.hh:310

◆ 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.

293  {
294  return *supervisor;
295  }

◆ 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
supervisorsupervisor

Definition at line 303 of file JFunctional.hh.

304  {
305  this->supervisor = supervisor;
306  }

Member Data Documentation

◆ 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:
Generated by doxygen 1.9.1