Functional map with spline interpolation. More...

#include <JSpline.hh>

Inheritance diagram for JTOOLS::JSplineMap< JKey_t, JValue_t, JMap_t, JResult_t, JDistance_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_type >	JSplineFunction1D_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 override
	Recursive interpolation method implementation. 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 () override
	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 788 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 794 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 795 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 797 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 798 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 799 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 800 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 802 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 803 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 804 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 805 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 807 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 808 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 809 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 811 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 814 of file JSpline.hh.

◆ functional_type

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

inherited

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

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

821 {}

Member Function Documentation

◆ evaluate()

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

inlineoverridevirtual

Recursive interpolation method implementation.

Parameters

pX	pointer to abscissa values

Returns: function value

Implements JTOOLS::JFunctional< JArgument_t, JResult_t >.

Definition at line 830 of file JSpline.hh.

     {
       const argument_type x = *pX;
  
       ++pX;  // next argument value
  
       const_iterator p = this->begin();
  
       for (typename JSplineFunction1D_t::iterator q = buffer.begin(); q != buffer.end(); ++q, ++p) {
         q->getY() = JFunction<argument_type, data_type>::getValue(p->getY(), pX);
       }
  
       buffer.compile();
  
       return buffer(x);
     }

◆ 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 ( )

inlineoverrideprivatevirtual

Function compilation.

Definition at line 852 of file JSpline.hh.

     {
       buffer.clear();
  
       for (iterator i = this->begin(); i != this->end(); ++i) {
         buffer.put(i->getX(), data_type());
       }
     }

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

     {
       return value;
     }

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

     {
       return supervisor;
     }

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

     {
       return *supervisor;
     }

◆ 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

supervisor supervisor

Definition at line 303 of file JFunctional.hh.

     {
       this->supervisor = supervisor;
     }

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

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

JSpline.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

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 >

Member Typedef Documentation

◆ collection_type

◆ function_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ argument_type

◆ result_type

◆ exceptionhandler_type

◆ data_type

◆ JSplineFunction1D_t

◆ functional_type

◆ supervisor_type

Constructor & Destructor Documentation

◆ JSplineMap()

Member Function Documentation

◆ evaluate()

◆ do_compile()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

Member Data Documentation

◆ buffer

◆ supervisor

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 >