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

General purpose class for multi-dimensional probability density function (PDF). More...

#include <JMultiPDF.hh>

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

Public Types
enum	{ NUMBER_OF_DIMENSIONS = transformablemultifunction_type::NUMBER_OF_DIMENSIONS }
typedef JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >	transformablemultifunction_type
typedef JFunction_t	function_type
typedef transformablemultifunction_type::value_type	value_type
typedef transformablemultifunction_type::argument_type	argument_type
typedef transformablemultifunction_type::supervisor_type	supervisor_type
typedef transformablemultifunction_type::abscissa_type	abscissa_type
typedef transformablemultifunction_type::ordinate_type	ordinate_type
typedef transformablemultifunction_type::result_type	result_type
typedef transformablemultifunction_type::const_iterator	const_iterator
typedef transformablemultifunction_type::const_reverse_iterator	const_reverse_iterator
typedef transformablemultifunction_type::iterator	iterator
typedef transformablemultifunction_type::reverse_iterator	reverse_iterator
typedef transformablemultifunction_type::super_iterator	super_iterator
typedef transformablemultifunction_type::super_const_iterator	super_const_iterator
typedef JMultiMapTransformer< JMapLength< JMaplist_t >::value, argument_type >	transformer_type
typedef transformer_type::array_type	array_type
enum	{ NUMBER_OF_DIMENSIONS = multifunction_type::NUMBER_OF_DIMENSIONS }
typedef JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >	multifunction_type
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

Public Member Functions
	JMultiPDF ()
	Default constructor.
template<class T >
	JMultiPDF (const T &input)
	Constructor.
template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >
void	insert (const JMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > &input)
	Insert multi-dimensional input.
template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >
void	insert (const JTransformableMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > &input)
	Insert multi-dimensional input.
template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.
template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.
const JTransformableMultiFunction &	getTransformableMultiFunction () const
	Get transformable multidimensional function.
JTransformableMultiFunction &	getTransformableMultiFunction ()
	Get transformable 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.
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.
template<class JMultiFunction_t >
void	add (const JMultiFunction_t &input)
	Add function.
template<class ... Args>
result_type	operator() (const Args &...args) const
	Multidimensional interpolation method call.
virtual result_type	evaluate (const argument_type *pX) const override
	Recursive function value evaluation.
virtual void	transform (const transformer_type &transformer) override
	Application of weight function and coordinate transformation.
virtual void	transform (const transformer_type &transformer)=0
	Application of transformation.
const JMultiFunction &	getMultiFunction () const
	Get multidimensional function.
JMultiFunction &	getMultiFunction ()
	Get multidimensional function.
void	compile ()
	Compilation.
void	setExceptionHandler (const typename function_type::supervisor_type &supervisor)
	Set the supervisor for handling of exceptions.
void	load (const char *file_name)
	Load from input file.
void	store (const char *file_name) const
	Store to output file.

Public Attributes
std::shared_ptr< transformer_type >	transformer

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, const double weight)
	Recursive method to insert multi-dimensional histogram at multi-dimensional 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, const double weight)
	Termination method to insert multi-dimensional histogram at multi-dimensional key.

Detailed Description

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

General purpose class for multi-dimensional probability density function (PDF).

This class is a simple wrapper around the JTransformableMultiFunction class to properly convert a multi-dimensional histogram to a multi-dimensional PDF. In this, the histogram contents in each bin are divided by the summed weight of the multi-dimensional histogram and the width (c.q. area) of the multi-dimensional bin.

Definition at line 34 of file JMultiPDF.hh.

Member Typedef Documentation

transformablemultifunction_type

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

JTransformableMultiFunction<JFunction_t, JMaplist_t, JDistance_t> JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::transformablemultifunction_type

Definition at line 42 of file JMultiPDF.hh.

function_type

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

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

Definition at line 46 of file JMultiPDF.hh.

value_type

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

transformablemultifunction_type::value_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::value_type

Definition at line 48 of file JMultiPDF.hh.

argument_type

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

transformablemultifunction_type::argument_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::argument_type

Definition at line 49 of file JMultiPDF.hh.

supervisor_type

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

transformablemultifunction_type::supervisor_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::supervisor_type

Definition at line 50 of file JMultiPDF.hh.

abscissa_type

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

transformablemultifunction_type::abscissa_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::abscissa_type

Definition at line 52 of file JMultiPDF.hh.

ordinate_type

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

transformablemultifunction_type::ordinate_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::ordinate_type

Definition at line 53 of file JMultiPDF.hh.

result_type

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

transformablemultifunction_type::result_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::result_type

Definition at line 54 of file JMultiPDF.hh.

const_iterator

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

transformablemultifunction_type::const_iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::const_iterator

Definition at line 56 of file JMultiPDF.hh.

const_reverse_iterator

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

transformablemultifunction_type::const_reverse_iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::const_reverse_iterator

Definition at line 57 of file JMultiPDF.hh.

iterator

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

transformablemultifunction_type::iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::iterator

Definition at line 58 of file JMultiPDF.hh.

reverse_iterator

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

transformablemultifunction_type::reverse_iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::reverse_iterator

Definition at line 59 of file JMultiPDF.hh.

super_iterator

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

transformablemultifunction_type::super_iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::super_iterator

Definition at line 61 of file JMultiPDF.hh.

super_const_iterator

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

transformablemultifunction_type::super_const_iterator JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::super_const_iterator

Definition at line 62 of file JMultiPDF.hh.

transformer_type

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

JMultiMapTransformer<JMapLength<JMaplist_t>::value, argument_type> JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::transformer_type

Definition at line 64 of file JMultiPDF.hh.

array_type

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

transformer_type::array_type JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::array_type

Definition at line 65 of file JMultiPDF.hh.

multifunction_type

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

JMultiFunction<JFunction_t, JMaplist_t, JDistance_t> JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::multifunction_type

inherited

Definition at line 48 of file JTransformableMultiFunction.hh.

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

inherited

Definition at line 47 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 44 of file JMultiPDF.hh.

{ NUMBER_OF_DIMENSIONS = transformablemultifunction_type::NUMBER_OF_DIMENSIONS };

anonymous enum

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

anonymous enum

inherited

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 50 of file JTransformableMultiFunction.hh.

{ NUMBER_OF_DIMENSIONS = multifunction_type::NUMBER_OF_DIMENSIONS };

anonymous enum

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

anonymous enum

inherited

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

JMultiPDF() [1/2]

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

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

inline

Default constructor.

Definition at line 73 of file JMultiPDF.hh.

    {}

JMultiPDF() [2/2]

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

template<class T >

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

inline

Constructor.

Parameters

input

multi-dimensional input

Definition at line 83 of file JMultiPDF.hh.

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

Member Function Documentation

insert() [1/11]

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

template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >

void JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > & input )

inline

Insert multi-dimensional input.

Parameters

input

multi-dimensional histogram

Definition at line 97 of file JMultiPDF.hh.

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

insert() [2/11]

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

template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >

void JTOOLS::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JTransformableMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > & input )

inline

Insert multi-dimensional input.

Parameters

input

multi-dimensional histogram

Definition at line 109 of file JMultiPDF.hh.

    {
      this->transformer.reset(input.transformer->clone());
 
      this->insert(JMultiKey<0, argument_type>(), input, input.getIntegral());
    }

insert() [3/11]

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::JMultiPDF< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiKey< N, argument_type > & key, const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > & input, const double weight )

inlineprotected

Recursive method to insert multi-dimensional histogram at multi-dimensional key.

Parameters

key	multi-dimensional key
input	multi-dimensional histogram
weight	weight

Definition at line 129 of file JMultiPDF.hh.

    {
      if (input.size() > 1) {
 
        for (typename JHistogramMap<__JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t>::const_iterator j = input.begin(), i = j++; j != input.end(); ++i, ++j) {
          
          const argument_type x = 0.5 * (i->getX() + j->getX());
          const double        w = weight * input.getDistance(i->getX(), j->getX());
 
          insert(JMultiKey<N+1, argument_type>(key, x), i->getY(), w);
        }
      }
    }

insert() [4/11]

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::JMultiPDF< 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, const double weight )

inlineprotected

Termination method to insert multi-dimensional histogram at multi-dimensional key.

Convert one-dimensional histogram to PDF, normalise PDF with given weight and insert result at given multi-dimensional key.

Parameters

key	multi-dimensional key
input	histogram
weight	weight

Definition at line 158 of file JMultiPDF.hh.

    {
      JFunction_t buffer;
      
      makePDF(input, buffer);
      
      buffer.div(weight);
 
      transformablemultifunction_type::insert(key, buffer);
    }    

insert() [5/11]

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::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input

multidimensional function

Definition at line 126 of file JTransformableMultiFunction.hh.

    {
      this->transformer.reset(input.transformer->clone());
 
      multifunction_type::insert(input);
    }

insert() [6/11]

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::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input

multidimensional histogram

Definition at line 140 of file JTransformableMultiFunction.hh.

    {
      this->transformer.reset(input.transformer->clone());
 
      multifunction_type::insert(input);
    }

getTransformableMultiFunction() [1/2]

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

const JTransformableMultiFunction & JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getTransformableMultiFunction ( ) const

inlineinherited

Get transformable multidimensional function.

Returns

this transformable multidimensional function

Definition at line 103 of file JTransformableMultiFunction.hh.

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

getTransformableMultiFunction() [2/2]

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

JTransformableMultiFunction & JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getTransformableMultiFunction ( )

inlineinherited

Get transformable multidimensional function.

Returns

this transformable multidimensional function

Definition at line 114 of file JTransformableMultiFunction.hh.

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

insert() [7/11]

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 )

inlineinherited

Insert multidimensional input.

Parameters

input

multidimensional function

Definition at line 121 of file JMultiFunction.hh.

    {
      copy(input, *this);
    }

insert() [8/11]

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 )

inlineinherited

Insert multidimensional input.

Parameters

input

multidimensional histogram

Definition at line 133 of file JMultiFunction.hh.

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

insert() [9/11]

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 )

inlineinherited

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() [10/11]

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 )

inlineinherited

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() [11/11]

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 )

inlineinherited

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

add()

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

template<class JMultiFunction_t >

void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::add ( const JMultiFunction_t & input )

inlineinherited

Add function.

Note that the summation is made via iteration of the elements in this multidimensional function.

Parameters

input

multidimensional function

Definition at line 156 of file JTransformableMultiFunction.hh.

    {
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
        
        const array_type array = (*i).getKey();
        function_type&   f1    = (*i).getValue();
 
        if (!f1.empty()) {
 
          const JMultiMapGetTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> get(*(this->transformer), array);
          const JMultiMapPutTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> put(*(this->transformer), array);
 
          f1.transform(get);
 
          for (typename function_type::iterator j = f1.begin(); j != f1.end(); ++j) {
 
            const JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer(array, j->getX());
 
            j->getY() += get_value(input.evaluate(buffer.data()));
          }
 
          f1.transform(put);
          f1.compile();
        }
      }
    }

operator()()

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

template<class ... Args>

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

inlineinherited

Multidimensional interpolation method call.

Parameters

args	comma seperated list of abscissa values

Returns

function value

Definition at line 191 of file JTransformableMultiFunction.hh.

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

evaluate()

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

virtual result_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::evaluate ( const argument_type * pX ) const

inlineoverridevirtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns

function value

Definition at line 205 of file JTransformableMultiFunction.hh.

    {
      JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer;
 
      for (int i = 0; i != NUMBER_OF_DIMENSIONS; ++i) {
        buffer[i] = pX[i];
      }
 
      buffer[NUMBER_OF_DIMENSIONS - 1] = transformer->putXn(buffer, buffer[NUMBER_OF_DIMENSIONS - 1]);
 
      const result_type y = multifunction_type::evaluate(buffer.data());
      const double      W = transformer->getWeight(buffer);
 
      return JResultTransformer<result_type>::transform(*transformer, buffer, y) * W;      
    }

transform() [1/2]

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

virtual void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::transform ( const transformer_type & transformer )

inlineoverridevirtualinherited

Application of weight function and coordinate transformation.

Parameters

transformer

function transformer

Definition at line 227 of file JTransformableMultiFunction.hh.

    {
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
 
        const array_type  array    = (*i).getKey();
        function_type&    function = (*i).getValue();
 
        const JMultiMapGetTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> get(*(this->transformer), array);
        const JMultiMapPutTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> put(        transformer,  array);
        
        function.transform(get);
        function.transform(put);
      }
 
      this->transformer.reset(transformer.clone());
      this->compile();
    }

transform() [2/2]

virtual void JTOOLS::JTransformable< N, JFunction_t::argument_type >::transform ( const transformer_type & transformer )

pure virtualinherited

Application of transformation.

Parameters

transformer

function transformer

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

inlineinherited

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

inlineinherited

Get multidimensional function.

Returns

this multidimensional function

Definition at line 109 of file JMultiFunction.hh.

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

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

inlineinherited

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 )

inlineinherited

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

load()

template<class T >

void JIO::JObjectBinaryIO< T >::load ( const char * file_name )

inlineinherited

Load from input file.

Parameters

file_name

file name

Definition at line 29 of file JObjectBinaryIO.hh.

    {
      JLANG::load<JFileStreamReader>(file_name, static_cast<T&>(*this));
    }

store()

template<class T >

void JIO::JObjectBinaryIO< T >::store ( const char * file_name ) const

inlineinherited

Store to output file.

Parameters

file_name

file name

Definition at line 40 of file JObjectBinaryIO.hh.

    {
      JLANG::store<JFileStreamWriter>(file_name, static_cast<const T&>(*this));
    }

Member Data Documentation

transformer

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

std::shared_ptr<transformer_type> JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::transformer

inherited

Definition at line 276 of file JTransformableMultiFunction.hh.

---

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

• JMultiPDF.hh