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

#include <JPolfit.hh>

Inheritance diagram for JTOOLS::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >:

Public Types
typedef JCollection_t < JElement_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

typedef JResultType < ordinate_type >::result_type	data_type

typedef JFunctional < JElement_t::abscissa_type, JResultType < JElement_t::ordinate_type > ::result_type >	functional_type

typedef JSupervisor	supervisor_type

enum

typedef JFunctional < JElement_t::abscissa_type, JResult_t >	functional_type

typedef JSupervisor	supervisor_type

Public Member Functions
	JPolfitFunction1D ()
	Default contructor. More...

virtual result_type	evaluate (const argument_type *pX) const override
	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...

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

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

JSupervisor	supervisor

Detailed Description

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >

Template class for polynomial interpolation in 1D.

This class implements the JFunction1D interface.

Definition at line 149 of file JPolfit.hh.

Member Typedef Documentation

template<unsigned int N, unsigned int M, 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 JCollection_t<JElement_t, JDistance_t> JTOOLS::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type

Definition at line 155 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 157 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 158 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type

Definition at line 159 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type

Definition at line 160 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator

Definition at line 162 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 163 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator

Definition at line 164 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator

Definition at line 165 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type

Definition at line 167 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::argument_type

Definition at line 169 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::result_type

Definition at line 170 of file JPolfit.hh.

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type

Definition at line 171 of file JPolfit.hh.

template<unsigned int N, unsigned int M, class JElement_t , template< class, class > class JCollection_t, class JResult_t , class JDistance_t >

typedef JResultType<ordinate_type>::result_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::data_type

inherited

Definition at line 63 of file JPolfit.hh.

typedef JFunctional<JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type > JTOOLS::JFunction< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::functional_type

inherited

Definition at line 306 of file JFunctional.hh.

typedef JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

typedef JFunctional<JElement_t::abscissa_type , JResult_t> JTOOLS::JFunction1D< JElement_t::abscissa_type , JResult_t >::functional_type

inherited

Definition at line 322 of file JFunctional.hh.

typedef JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

anonymous enum

inherited

Definition at line 320 of file JFunctional.hh.

320 { NUMBER_OF_DIMENSIONS = 1 };

JTOOLS::JFunction1D< JElement_t::abscissa_type, JResult_t >::NUMBER_OF_DIMENSIONS

Definition: JFunctional.hh:320

Constructor & Destructor Documentation

template<unsigned int N, unsigned int M, 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::JPolfitFunction1D< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::JPolfitFunction1D ( )

inline

Default contructor.

Definition at line 177 of file JPolfit.hh.

178 {}

Member Function Documentation

template<unsigned int N, unsigned int M, class JElement_t , template< class, class > class JCollection_t, class JResult_t , class JDistance_t >

virtual result_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::evaluate ( const argument_type * pX ) const

inlineoverridevirtualinherited

Recursive interpolation method implementation.

Parameters

pX	pointer to abscissa values

Returns: function value

Definition at line 86 of file JPolfit.hh.

     {
       using namespace std;
       using namespace JPP;
 
       if (this->size() <= 1u) {
         return this->getExceptionHandler().action(JFunctionalException("JPolfitFunction<>::evaluate() not enough data."));
       }
 
       const argument_type x = *pX;
 
       const_iterator p = this->lower_bound(x);
 
       if ((p == this->begin() && this->getDistance(x, (p++)->getX()) > distance_type::precision) ||
           (p == this->end()   && this->getDistance((--p)->getX(), x) > distance_type::precision)) {
 
         return this->getExceptionHandler().action(MAKE_EXCEPTION(JValueOutOfRange, "abscissa out of range "
                                                                  << STREAM("?") << x                      << " <> "
                                                                  << STREAM("?") << this->begin() ->getX() << ' '
                                                                  << STREAM("?") << this->rbegin()->getX()));
       }
 
       ++pX;  // next argument value
 
 
       int n = std::min((int) (N + 1), (int) this->size());               // number of points to interpolate      
 
       for (int i = n/2; i != 0 && p != this->end();   --i, ++p) {}       // move p to begin of data
       for (int i = n  ; i != 0 && p != this->begin(); --i, --p) {}
 
       buffer.clear();
 
       for (const_iterator q = p; n != 0; ++q, --n) {
         buffer.push_back(make_pair(this->getDistance(p->getX(), q->getX()), function_type::getValue(q->getY(), pX)));
       }
 
       const JLegendre<result_type, M> g1(buffer.begin(), buffer.end());
 
       return g1(this->getDistance(p->getX(), x));
     }

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

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

static result_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::getValue	(	const JFunctional< JElement_t::abscissa_type, JResultType< JElement_t::ordinate_type >::result_type > &	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);
     }

static JClass<result_type>::argument_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_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 121 of file JFunctional.hh.

     {
       return value;
     }

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 266 of file JFunctional.hh.

     {
       return supervisor;
     }

const JExceptionHandler& JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::getExceptionHandler ( ) const

inlineinherited

Get exception handler.

Returns: exception handler

Definition at line 277 of file JFunctional.hh.

     {
       return *supervisor;
     }

void JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::setExceptionHandler ( const JSupervisor & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 288 of file JFunctional.hh.

     {
       this->supervisor = supervisor;
     }

result_type JTOOLS::JFunction1D< JElement_t::abscissa_type , JResult_t >::operator() ( const argument_type x ) const

inlineinherited

Function value evaluation.

Parameters

x	argument value

Returns: function value

Definition at line 333 of file JFunctional.hh.

     {
       return this->evaluate(&x);
     }

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

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

static result_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getValue	(	const JFunctional< JElement_t::abscissa_type, 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);
     }

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

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 266 of file JFunctional.hh.

     {
       return supervisor;
     }

const JExceptionHandler& JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getExceptionHandler ( ) const

inlineinherited

Get exception handler.

Returns: exception handler

Definition at line 277 of file JFunctional.hh.

     {
       return *supervisor;
     }

void JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::setExceptionHandler ( const JSupervisor & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 288 of file JFunctional.hh.

     {
       this->supervisor = supervisor;
     }

Member Data Documentation

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResultType< JElement_t::ordinate_type >::result_type >::supervisor

protectedinherited

Definition at line 295 of file JFunctional.hh.

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::supervisor

protectedinherited

Definition at line 295 of file JFunctional.hh.

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

JPolfit.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation