Jpp  16.0.3
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t > Class Template Referenceabstract

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 >:
JTOOLS::JFunction< JElement_t::abscissa_type, JResultType< JElement_t::ordinate_type >::result_type > JTOOLS::JFunctional< JElement_t::abscissa_type, JResultType< JElement_t::ordinate_type >::result_type > 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 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. 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...
 

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

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 44 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 , class JDistance_t >
typedef JCollection_t<JElement_t, JDistance_t> JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type

Definition at line 51 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 collection_type::abscissa_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type

Definition at line 53 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 collection_type::ordinate_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type

Definition at line 54 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 collection_type::value_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type

Definition at line 55 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 collection_type::distance_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type

Definition at line 56 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 collection_type::const_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator

Definition at line 58 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 collection_type::const_reverse_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator

Definition at line 59 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 collection_type::iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator

Definition at line 60 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 collection_type::reverse_iterator JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator

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

Definition at line 63 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 JFunction<abscissa_type, data_type> JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type

Definition at line 64 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 function_type::argument_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::argument_type

Definition at line 66 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 function_type::result_type JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::result_type

Definition at line 67 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 function_type::JExceptionHandler JTOOLS::JPolfitFunction< N, M, JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type

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

Constructor & Destructor Documentation

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 74 of file JPolfit.hh.

75  {
76  STATIC_CHECK((N > M));
77  }
M
do $JPP JMEstimator M
Definition: JMEstimator.sh:37
N
then JShowerPostfit f $INPUT_FILE o $OUTPUT_FILE N
Definition: JShowerPostfit.sh:95
STATIC_CHECK
#define STATIC_CHECK(expr)
Definition: JAssert.hh:31

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
inlineoverridevirtual

Recursive interpolation method implementation.

Parameters
pXpointer to abscissa values
Returns
function value

Definition at line 86 of file JPolfit.hh.

87  {
88  using namespace std;
89  using namespace JPP;
90 
91  if (this->size() <= 1u) {
92  return this->getExceptionHandler().action(JFunctionalException("JPolfitFunction<>::evaluate() not enough data."));
93  }
94 
95  const argument_type x = *pX;
96 
97  const_iterator p = this->lower_bound(x);
98 
99  if ((p == this->begin() && this->getDistance(x, (p++)->getX()) > distance_type::precision) ||
100  (p == this->end() && this->getDistance((--p)->getX(), x) > distance_type::precision)) {
101 
102  return this->getExceptionHandler().action(MAKE_EXCEPTION(JValueOutOfRange, "abscissa out of range "
103  << STREAM("?") << x << " <> "
104  << STREAM("?") << this->begin() ->getX() << ' '
105  << STREAM("?") << this->rbegin()->getX()));
106  }
107 
108  ++pX; // next argument value
109 
110 
111  int n = std::min((int) (N + 1), (int) this->size()); // number of points to interpolate
112 
113  for (int i = n/2; i != 0 && p != this->end(); --i, ++p) {} // move p to begin of data
114  for (int i = n ; i != 0 && p != this->begin(); --i, --p) {}
115 
116  buffer.clear();
117 
118  for (const_iterator q = p; n != 0; ++q, --n) {
119  buffer.push_back(make_pair(this->getDistance(p->getX(), q->getX()), function_type::getValue(q->getY(), pX)));
120  }
121 
122  const JLegendre<result_type, M> g1(buffer.begin(), buffer.end());
123 
124  return g1(this->getDistance(p->getX(), x));
125  }
JTOOLS::JPolfitFunction::const_iterator
collection_type::const_iterator const_iterator
Definition: JPolfit.hh:58
N
then JShowerPostfit f $INPUT_FILE o $OUTPUT_FILE N
Definition: JShowerPostfit.sh:95
JMATH::getDistance
double getDistance(const JFirst_t &first, const JSecond_t &second)
Get distance between objects.
Definition: JMathToolkit.hh:117
JTOOLS::n
const int n
Definition: JPolint.hh:676
JTOOLS::JFunctional::getValue
static result_type getValue(const JFunctional &function, const argument_type *pX)
Recursive function value evaluation.
Definition: JFunctional.hh:107
STREAM
Auxiliary data structure for handling std::ostream.
Definition: JStreamAvailable.hh:81
MAKE_EXCEPTION
#define MAKE_EXCEPTION(JException_t, A)
Make exception.
Definition: JException.hh:687
JTOOLS::JPolfitFunction::buffer
std::vector< std::pair< abscissa_type, result_type > > buffer
Definition: JPolfit.hh:134
JTOOLS::JPolfitFunction::argument_type
function_type::argument_type argument_type
Definition: JPolfit.hh:66
JTOOLS::u
double u[N+1]
Definition: JPolint.hh:755
g1
Double_t g1(const Double_t x)
Function.
Definition: JQuantiles.cc:25
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 131 of file JPolfit.hh.

132  {}
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
pXpointer 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
functionfunction
pXpointer to abscissa values

Definition at line 107 of file JFunctional.hh.

109  {
110  return function.evaluate(pX);
111  }
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
valueresult
pXpointer to abscissa values

Definition at line 121 of file JFunctional.hh.

123  {
124  return value;
125  }
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.

267  {
268  return supervisor;
269  }
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.

278  {
279  return *supervisor;
280  }
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
supervisorsupervisor

Definition at line 288 of file JFunctional.hh.

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

Member Data Documentation

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 134 of file JPolfit.hh.

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

Definition at line 295 of file JFunctional.hh.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5