Jpp
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t > Class Template Referenceabstract

Functional map with spline interpolation. More...

#include <JSpline.hh>

Inheritance diagram for JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >:
JTOOLS::JFunction< JKey_t, JResult_t > JTOOLS::JFunctional< JKey_t, JResult_t >

Public Types

typedef JMap_t< JKey_t, JValue_t, JDistance_t > collection_type
 
typedef JFunction< JKey_t, JResult_t > function_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 function_type::argument_type argument_type
 
typedef function_type::result_type result_type
 
typedef function_type::JExceptionHandler exceptionhandler_type
 
typedef JResultType< ordinate_type >::result_type data_type
 
typedef JSplineFunction1D< JSplineElement2D< argument_type, data_type >, JMapCollection< JMap_t >::template collection_type, result_typeJSplineFunction1D_t
 
typedef JFunctional< JKey_t, JResult_t > functional_type
 
typedef JSupervisor supervisor_type
 

Public Member Functions

 JSplineMap ()
 Default constructor. More...
 
virtual result_type evaluate (const argument_type *pX) const
 Recursive interpolation method implementation. 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
 

Private Member Functions

virtual void do_compile ()
 Function compilation. More...
 

Private Attributes

JSplineFunction1D_t buffer
 

Detailed Description

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
class JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >

Functional map with spline interpolation.

Definition at line 698 of file JSpline.hh.

Member Typedef Documentation

◆ collection_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef JMap_t<JKey_t, JValue_t, JDistance_t> JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::collection_type

Definition at line 704 of file JSpline.hh.

◆ function_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef JFunction<JKey_t, JResult_t> JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::function_type

Definition at line 705 of file JSpline.hh.

◆ abscissa_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::abscissa_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 707 of file JSpline.hh.

◆ ordinate_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::ordinate_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 708 of file JSpline.hh.

◆ value_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::value_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::value_type

Definition at line 709 of file JSpline.hh.

◆ distance_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::distance_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::distance_type

Definition at line 710 of file JSpline.hh.

◆ const_iterator

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::const_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::const_iterator

Definition at line 712 of file JSpline.hh.

◆ const_reverse_iterator

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::const_reverse_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 713 of file JSpline.hh.

◆ iterator

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::iterator

Definition at line 714 of file JSpline.hh.

◆ reverse_iterator

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef collection_type::reverse_iterator JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::reverse_iterator

Definition at line 715 of file JSpline.hh.

◆ argument_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef function_type::argument_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::argument_type

Definition at line 717 of file JSpline.hh.

◆ result_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef function_type::result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::result_type

Definition at line 718 of file JSpline.hh.

◆ exceptionhandler_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef function_type::JExceptionHandler JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::exceptionhandler_type

Definition at line 719 of file JSpline.hh.

◆ data_type

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef JResultType<ordinate_type>::result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::data_type

Definition at line 721 of file JSpline.hh.

◆ JSplineFunction1D_t

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
typedef JSplineFunction1D<JSplineElement2D<argument_type, data_type>, JMapCollection<JMap_t>::template collection_type, result_type> JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::JSplineFunction1D_t

Definition at line 724 of file JSpline.hh.

◆ functional_type

typedef JFunctional<JKey_t , JResult_t> JTOOLS::JFunction< JKey_t , JResult_t >::functional_type
inherited

Definition at line 306 of file JFunctional.hh.

◆ supervisor_type

typedef JSupervisor JTOOLS::JFunctional< JKey_t , JResult_t >::supervisor_type
inherited

Definition at line 89 of file JFunctional.hh.

Constructor & Destructor Documentation

◆ JSplineMap()

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::JSplineMap ( )
inline

Default constructor.

Definition at line 730 of file JSpline.hh.

731  {}

Member Function Documentation

◆ evaluate() [1/2]

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
virtual result_type JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::evaluate ( const argument_type pX) const
inlinevirtual

Recursive interpolation method implementation.

Parameters
pXpointer to abscissa values
Returns
function value

Definition at line 740 of file JSpline.hh.

741  {
742  const argument_type x = *pX;
743 
744  ++pX; // next argument value
745 
746  const_iterator p = this->begin();
747 
748  for (typename JSplineFunction1D_t::iterator q = buffer.begin(); q != buffer.end(); ++q, ++p) {
749  q->getY() = JFunction<argument_type, data_type>::getValue(p->getY(), pX);
750  }
751 
752  buffer.compile();
753 
754  return buffer(x);
755  }

◆ do_compile()

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
virtual void JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::do_compile ( )
inlineprivatevirtual

Function compilation.

Definition at line 762 of file JSpline.hh.

763  {
764  buffer.clear();
765 
766  for (iterator i = this->begin(); i != this->end(); ++i) {
767  buffer.put(i->getX(), data_type());
768  }
769  }

◆ evaluate() [2/2]

virtual result_type JTOOLS::JFunctional< JKey_t , JResult_t >::evaluate ( const argument_type pX) const
pure virtualinherited

Recursive function value evaluation.

Parameters
pXpointer to abscissa values
Returns
function value

◆ getValue() [1/2]

static result_type JTOOLS::JFunctional< JKey_t , JResult_t >::getValue ( const JFunctional< JKey_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]

static JClass<result_type>::argument_type JTOOLS::JFunctional< JKey_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()

JSupervisor JTOOLS::JFunctional< JKey_t , JResult_t >::getSupervisor ( ) const
inlineinherited

Get supervisor.

Returns
supervisor

Definition at line 266 of file JFunctional.hh.

267  {
268  return supervisor;
269  }

◆ getExceptionHandler()

const JExceptionHandler& JTOOLS::JFunctional< JKey_t , JResult_t >::getExceptionHandler ( ) const
inlineinherited

Get exception handler.

Returns
exception handler

Definition at line 277 of file JFunctional.hh.

278  {
279  return *supervisor;
280  }

◆ setExceptionHandler()

void JTOOLS::JFunctional< JKey_t , JResult_t >::setExceptionHandler ( const JSupervisor &  supervisor)
inlineinherited

Set the supervisor for handling of exceptions.

Parameters
supervisorsupervisor

Definition at line 288 of file JFunctional.hh.

289  {
290  this->supervisor = supervisor;
291  }

Member Data Documentation

◆ buffer

template<class JKey_t, class JValue_t, template< class, class, class > class JMap_t, class JResult_t, class JDistance_t = JDistance<JKey_t>>
JSplineFunction1D_t JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_t >::buffer
mutableprivate

Definition at line 772 of file JSpline.hh.

◆ supervisor

JSupervisor JTOOLS::JFunctional< JKey_t , JResult_t >::supervisor
protectedinherited

Definition at line 295 of file JFunctional.hh.


The documentation for this class was generated from the following file:
JTOOLS::JFunctional< JKey_t, JResult_t >::supervisor
JSupervisor supervisor
Definition: JFunctional.hh:295
std::iterator
Definition: JSTDTypes.hh:18
JTOOLS::pX
pX
Definition: JPolint.hh:625
JTOOLS::JSplineMap::buffer
JSplineFunction1D_t buffer
Definition: JSpline.hh:772
JTOOLS::JFunctional::getValue
static result_type getValue(const JFunctional &function, const argument_type *pX)
Recursive function value evaluation.
Definition: JFunctional.hh:107
JTOOLS::JSplineMap::const_iterator
collection_type::const_iterator const_iterator
Definition: JSpline.hh:712
JTOOLS::JSplineFunction1D< JSplineElement2D< argument_type, data_type >, JMapCollection< JMap_t >::template collection_type, result_type >::iterator
collection_type::iterator iterator
Definition: JSpline.hh:672
JTOOLS::JSplineMap::argument_type
function_type::argument_type argument_type
Definition: JSpline.hh:717
JTOOLS::JSplineMap::data_type
JResultType< ordinate_type >::result_type data_type
Definition: JSpline.hh:721