JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t > Class Template Reference

Multidimensional interpolation method. More...

#include <JMultiFunction.hh>

Inheritance diagram for JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >:

Public Types
enum	{ NUMBER_OF_DIMENSIONS = JMapLength<JMaplist_t>::value + JFunction_t::NUMBER_OF_DIMENSIONS }
typedef JMultiMap< typename JFunction_t::argument_type, JFunction_t, JMaplist_t, JDistance_t >	multimap_type
typedef JFunction_t	function_type
typedef function_type::value_type	value_type
typedef function_type::argument_type	argument_type
typedef multimap_type::abscissa_type	abscissa_type
typedef multimap_type::ordinate_type	ordinate_type
typedef multimap_type::result_type	result_type
typedef multimap_type::const_iterator	const_iterator
typedef multimap_type::const_reverse_iterator	const_reverse_iterator
typedef multimap_type::iterator	iterator
typedef multimap_type::reverse_iterator	reverse_iterator
typedef multimap_type::super_iterator	super_iterator
typedef multimap_type::super_const_iterator	super_const_iterator

Public Member Functions
	JMultiFunction ()
	Default constructor.
template<class T >
	JMultiFunction (const T &input)
	Constructor.
const JMultiFunction &	getMultiFunction () const
	Get multidimensional function.
JMultiFunction &	getMultiFunction ()
	Get multidimensional function.
template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.
template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.
void	compile ()
	Compilation.
void	setExceptionHandler (const typename function_type::supervisor_type &supervisor)
	Set the supervisor for handling of exceptions.
template<class ... Args>
result_type	operator() (const Args &...args) const
	Multi-dimensional interpolation method call.

Protected Member Functions
template<unsigned int N, class __JAbscissa_t , class __JContents_t , template< class, class, class > class __JMap_t, class __JDistance_t >
void	insert (const JMultiKey< N, argument_type > &key, const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > &input)
	Insert multidimensional histogram at multidimensional key.
template<class __JElement_t , template< class, class > class __JContainer_t, class __JDistance_t >
void	insert (const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > &key, const JHistogram1D< __JElement_t, __JContainer_t, __JDistance_t > &input)
	Convert one-dimensional histogram to PDF and insert result at given multidimensional key.
template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > &key, const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Convert multidimensional histogram to PDF and insert result at given multidimensional key.

Detailed Description

template<class JFunction_t, class JMaplist_t, class JDistance_t = JDistance<typename JFunction_t::argument_type>>
class JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >

Multidimensional interpolation method.

The template parameters respectively refer to:

1. function object used for the lowest dimension(s);
2. list of functional maps used for the higher dimension(s); and
   
3. distance operator.

The number of dimensions of this function object is equal to the length of the given map list plus the extra dimensions of the first function object. When converting a multidimensional histogram to a multidimensional function for subsequent interpolations, the function object used for the lowest dimension(s) is treated as a probability density function.

Definition at line 39 of file JMultiFunction.hh.

Member Typedef Documentation

multimap_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

JMultiMap<typename JFunction_t::argument_type, JFunction_t, JMaplist_t, JDistance_t> JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::multimap_type

Definition at line 47 of file JMultiFunction.hh.

function_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

JFunction_t JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::function_type

Definition at line 51 of file JMultiFunction.hh.

value_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

function_type::value_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::value_type

Definition at line 53 of file JMultiFunction.hh.

argument_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

function_type::argument_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::argument_type

Definition at line 54 of file JMultiFunction.hh.

abscissa_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::abscissa_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::abscissa_type

Definition at line 56 of file JMultiFunction.hh.

ordinate_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::ordinate_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::ordinate_type

Definition at line 57 of file JMultiFunction.hh.

result_type

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::result_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::result_type

Definition at line 58 of file JMultiFunction.hh.

const_iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::const_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_iterator

Definition at line 60 of file JMultiFunction.hh.

const_reverse_iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::const_reverse_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_reverse_iterator

Definition at line 61 of file JMultiFunction.hh.

iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::iterator

Definition at line 62 of file JMultiFunction.hh.

reverse_iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::reverse_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::reverse_iterator

Definition at line 63 of file JMultiFunction.hh.

super_iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::super_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::super_iterator

Definition at line 65 of file JMultiFunction.hh.

super_const_iterator

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

multimap_type::super_const_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::super_const_iterator

Definition at line 66 of file JMultiFunction.hh.

Member Enumeration Documentation

anonymous enum

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

anonymous enum

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 49 of file JMultiFunction.hh.

{ NUMBER_OF_DIMENSIONS = JMapLength<JMaplist_t>::value + JFunction_t::NUMBER_OF_DIMENSIONS };

Constructor & Destructor Documentation

JMultiFunction() [1/2]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::JMultiFunction ( )

inline

Default constructor.

Definition at line 75 of file JMultiFunction.hh.

    {}

JMultiFunction() [2/2]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class T >

JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::JMultiFunction ( const T & input )

inline

Constructor.

Parameters

input

multidimensional input

Definition at line 85 of file JMultiFunction.hh.

    {
      insert(input);
 
      this->compile();
    }

Member Function Documentation

getMultiFunction() [1/2]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

const JMultiFunction & JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getMultiFunction ( ) const

inline

Get multidimensional function.

Returns

this multidimensional function

Definition at line 98 of file JMultiFunction.hh.

    {
      return static_cast<const JMultiFunction&>(*this);
    }

getMultiFunction() [2/2]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

JMultiFunction & JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getMultiFunction ( )

inline

Get multidimensional function.

Returns

this multidimensional function

Definition at line 109 of file JMultiFunction.hh.

    {
      return static_cast<JMultiFunction&>(*this);
    }

insert() [1/5]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input

multidimensional function

Definition at line 121 of file JMultiFunction.hh.

    {
      copy(input, *this);
    }

insert() [2/5]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input

multidimensional histogram

Definition at line 133 of file JMultiFunction.hh.

    {
      this->insert(JMultiKey<0, argument_type>(), input);
    }

compile()

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::compile ( )

inline

Compilation.

Definition at line 142 of file JMultiFunction.hh.

    {
      this->for_each(compiler);
 
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
        (*i).getValue().compile();
      }
    }

setExceptionHandler()

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::setExceptionHandler ( const typename function_type::supervisor_type & supervisor )

inline

Set the supervisor for handling of exceptions.

Parameters

supervisor

supervisor

Definition at line 157 of file JMultiFunction.hh.

    {
      this->for_each(supervisor);
 
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
        (*i).getValue().setExceptionHandler(supervisor);
      }
    }

operator()()

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class ... Args>

result_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::operator() ( const Args &... args ) const

inline

Multi-dimensional interpolation method call.

Parameters

args	comma seperated list of abscissa values

Returns

function value

Definition at line 174 of file JMultiFunction.hh.

    {
      const JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer(args...);
 
      return this->evaluate(buffer.data());
    }

insert() [3/5]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<unsigned int N, class __JAbscissa_t , class __JContents_t , template< class, class, class > class __JMap_t, class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiKey< N, argument_type > & key, const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > & input )

inlineprotected

Insert multidimensional histogram at multidimensional key.

Parameters

key	multidimensional key
input	multidimensional histogram

Definition at line 194 of file JMultiFunction.hh.

    {
      if (input.size() > 1) {
 
        for (auto j = input.begin(), i = j++; j != input.end(); ++i, ++j) {
          
          const argument_type x = 0.5 * (i->getX() + j->getX());
 
          insert(JMultiKey<N+1, argument_type>(key, x), i->getY());
        }
      }
    }

insert() [4/5]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class __JElement_t , template< class, class > class __JContainer_t, class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > & key, const JHistogram1D< __JElement_t, __JContainer_t, __JDistance_t > & input )

inlineprotected

Convert one-dimensional histogram to PDF and insert result at given multidimensional key.

Parameters

key	multidimensional key
input	histogram

Definition at line 216 of file JMultiFunction.hh.

    {
      JFunction_t buffer;
      
      makePDF(input, buffer);
      
      multimap_type::insert(key, buffer);
    }    

insert() [5/5]

template<class JFunction_t , class JMaplist_t , class JDistance_t = JDistance<typename JFunction_t::argument_type>>

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > & key, const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > & input )

inlineprotected

Convert multidimensional histogram to PDF and insert result at given multidimensional key.

Parameters

key	multidimensional key
input	multidimensional histogram

Definition at line 235 of file JMultiFunction.hh.

    {
      JFunction_t buffer;
      
      makePDF(input, buffer);
      
      multimap_type::insert(key, buffer);
    }    

---

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

• JMultiFunction.hh