Functional collection with Legendre polynomial interpolation. More...

#include <JPolfit.hh>

Inheritance diagram for JTOOLS::JPolfitFunction< 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 JResultType< ordinate_type >::result_type	data_type

typedef JFunction< abscissa_type, data_type >	function_type

typedef function_type::argument_type	argument_type

typedef function_type::result_type	result_type

typedef function_type::JExceptionHandler	exceptionhandler_type

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

typedef JSupervisor	supervisor_type

Public Member Functions
	JPolfitFunction ()
	Default constructor.

virtual result_type	evaluate (const argument_type *pX) const override
	Recursive interpolation method implementation.

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

JSupervisor	getSupervisor () const
	Get supervisor.

const JExceptionHandler &	getExceptionHandler () const
	Get exception handler.

void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions.

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

Private Member Functions
virtual void	do_compile () override
	Function compilation.

Private Attributes
std::vector< std::pair< abscissa_type, result_type > >	buffer

Detailed Description

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

Functional collection with Legendre polynomial interpolation.

Definition at line 45 of file JPolfit.hh.

Member Typedef Documentation

◆ collection_type

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

JCollection_t<JElement_t, JDistance_t> JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type

Definition at line 52 of file JPolfit.hh.

◆ abscissa_type

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

collection_type::abscissa_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 54 of file JPolfit.hh.

◆ ordinate_type

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

collection_type::ordinate_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 55 of file JPolfit.hh.

◆ value_type

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

collection_type::value_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type

Definition at line 56 of file JPolfit.hh.

◆ distance_type

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

collection_type::distance_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type

Definition at line 57 of file JPolfit.hh.

◆ const_iterator

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

collection_type::const_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator

Definition at line 59 of file JPolfit.hh.

◆ const_reverse_iterator

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

collection_type::const_reverse_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 60 of file JPolfit.hh.

◆ iterator

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

collection_type::iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator

Definition at line 61 of file JPolfit.hh.

◆ reverse_iterator

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

collection_type::reverse_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator

Definition at line 62 of file JPolfit.hh.

◆ data_type

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

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

Definition at line 64 of file JPolfit.hh.

◆ function_type

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

JFunction<abscissa_type, data_type> JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type

Definition at line 65 of file JPolfit.hh.

◆ argument_type

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

function_type::argument_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::argument_type

Definition at line 67 of file JPolfit.hh.

◆ result_type

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

function_type::result_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::result_type

Definition at line 68 of file JPolfit.hh.

◆ exceptionhandler_type

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

function_type::JExceptionHandler JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type

Definition at line 69 of file JPolfit.hh.

◆ functional_type

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 321 of file JFunctional.hh.

◆ supervisor_type

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.

Constructor & Destructor Documentation

◆ JPolfitFunction()

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

JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::JPolfitFunction ( )

inline

Default constructor.

Definition at line 75 of file JPolfit.hh.

    {
      STATIC_CHECK((N > M));
    }

Member Function Documentation

◆ evaluate() [1/2]

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

inlineoverridevirtual

Recursive interpolation method implementation.

Parameters

pX	pointer to abscissa values

Returns: function value

Definition at line 87 of file JPolfit.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const argument_type x = *pX;
 
      if (this->size() <= 1u) {
 
        try {
          return this->getExceptionHandler().action();
        }
        catch (const JException& error) {
 
          std::ostringstream os;
 
          os << __FILE__ << ':' << __LINE__ << " not enough data " << STREAM("?") << x;
        
          throw JFunctionalException(os.str());
        }
      }
 
      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)) {
 
        try {
          return this->getExceptionHandler().action();
        }
        catch (const JException& error) {
 
          std::ostringstream os;
 
          os << __FILE__ << ':' << __LINE__ << " abscissa out of range " 
             << STREAM("?") << x                      << " <> " 
             << STREAM("?") << this->begin() ->getX() << ' '
             << STREAM("?") << this->rbegin()->getX();
          
          throw JValueOutOfRange(os.str());
        }
      }
 
      ++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));
    }

◆ do_compile()

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

virtual void JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::do_compile ( )

inlineoverrideprivatevirtual

Function compilation.

Definition at line 153 of file JPolfit.hh.

154 {}

◆ evaluate() [2/2]

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

◆ getValue() [1/2]

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);
    }

◆ getValue() [2/2]

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;
    }

◆ getSupervisor()

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

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 281 of file JFunctional.hh.

    {
      return supervisor;
    }

◆ getExceptionHandler()

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 292 of file JFunctional.hh.

    {
      return *supervisor;
    }

◆ setExceptionHandler()

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 303 of file JFunctional.hh.

    {
      this->supervisor = supervisor;
    }

Member Data Documentation

◆ buffer

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

std::vector< std::pair<abscissa_type, result_type> > JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::buffer

mutableprivate

Definition at line 156 of file JPolfit.hh.

◆ supervisor

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

protectedinherited

Definition at line 310 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

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ collection_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ data_type

◆ function_type

◆ argument_type

◆ result_type

◆ exceptionhandler_type

◆ functional_type

◆ supervisor_type

Constructor & Destructor Documentation

◆ JPolfitFunction()

Member Function Documentation

◆ evaluate() [1/2]

◆ do_compile()

◆ evaluate() [2/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

Member Data Documentation

◆ buffer

◆ supervisor