Type definition of a JHistogramMap based on JMap implementation. More...

#include <JHistogramMap_t.hh>

Inheritance diagram for JTOOLS::JHistogramMap_t< JKey_t, JHistogram_t, JDistance_t >:

Public Types
typedef JMap_t< JAbscissa_t, JContents_t, JDistance_t >	collection_type

typedef JHistogram< JAbscissa_t, typename JContents_t::contents_type >	histogram_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::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 histogram_type::contents_type	contents_type

Public Member Functions
virtual void	evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)
	Fill histogram.

virtual void	evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)=0
	Histogram filling.

JHistogramMap &	mul (typename JLANG::JClass< contents_type >::argument_type factor)
	Scale contents.

JHistogram &	mul (const double value)
	Scale histogram.

JHistogramMap &	div (typename JLANG::JClass< contents_type >::argument_type factor)
	Scale contents.

JHistogram &	div (double value)
	Scale histogram.

void	reset ()
	Reset.

JHistogram &	add (const JHistogram &histogram)
	Add histogram.

JHistogram &	sub (const JHistogram &histogram)
	Subtract histogram.

const contents_type &	getUnderflow () const
	Get contents below lower limit.

const contents_type &	getOverflow () const
	Get contents above upper limit.

const contents_type &	getIntegral () const
	Get contents above upper limit.

Protected Attributes
contents_type	underflow

contents_type	overflow

contents_type	integral

Detailed Description

template<class JKey_t, class JHistogram_t, class JDistance_t = JDistance<JKey_t>>
struct JTOOLS::JHistogramMap_t< JKey_t, JHistogram_t, JDistance_t >

Type definition of a JHistogramMap based on JMap implementation.

Definition at line 25 of file JHistogramMap_t.hh.

Member Typedef Documentation

◆ collection_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

JMap_t<JAbscissa_t, JContents_t, JDistance_t> JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::collection_type

inherited

Definition at line 34 of file JHistogramMap.hh.

◆ histogram_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

JHistogram<JAbscissa_t, typename JContents_t::contents_type> JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::histogram_type

inherited

Definition at line 35 of file JHistogramMap.hh.

◆ abscissa_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::abscissa_type JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::abscissa_type

inherited

Definition at line 37 of file JHistogramMap.hh.

◆ ordinate_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::ordinate_type JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::ordinate_type

inherited

Definition at line 38 of file JHistogramMap.hh.

◆ value_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::value_type JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::value_type

inherited

Definition at line 39 of file JHistogramMap.hh.

◆ const_iterator

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::const_iterator JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::const_iterator

inherited

Definition at line 41 of file JHistogramMap.hh.

◆ const_reverse_iterator

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::const_reverse_iterator JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::const_reverse_iterator

inherited

Definition at line 42 of file JHistogramMap.hh.

◆ iterator

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::iterator JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::iterator

inherited

Definition at line 43 of file JHistogramMap.hh.

◆ reverse_iterator

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

collection_type::reverse_iterator JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::reverse_iterator

inherited

Definition at line 44 of file JHistogramMap.hh.

◆ contents_type

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

histogram_type::contents_type JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::contents_type

inherited

Definition at line 47 of file JHistogramMap.hh.

Member Function Documentation

◆ evaluate() [1/2]

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

virtual void JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::evaluate	(	const abscissa_type *	pX,
		typename JLANG::JClass< contents_type >::argument_type	w )

inlinevirtualinherited

Fill histogram.

Parameters

pX	pointer to abscissa values
w	weight

Definition at line 63 of file JHistogramMap.hh.

    {
      const abscissa_type x = *pX;
 
      iterator p = this->lower_bound(x);
 
      this->integral  += w;
 
      if      (p == this->begin()) 
        this->underflow += w;
      else if (p == this->end()) 
        this->overflow  += w;
      else 
        (--p)->getY().evaluate(++pX, w);
    }    

◆ evaluate() [2/2]

virtual void JTOOLS::JHistogram< JAbscissa_t, JContents_t >::evaluate	(	const abscissa_type *	pX,
		typename JLANG::JClass< contents_type >::argument_type	w )

pure virtualinherited

Histogram filling.

Parameters

pX	pointer to abscissa values
w	weight

◆ mul() [1/2]

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

JHistogramMap & JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::mul ( typename JLANG::JClass< contents_type >::argument_type factor )

inlineinherited

Scale contents.

Parameters

factor multiplication factor

Returns: this histogram

Definition at line 87 of file JHistogramMap.hh.

    {
      collection_type::mul(factor);
      histogram_type ::mul(factor);
 
      return *this;
    }

◆ mul() [2/2]

JHistogram & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::mul ( const double value )

inlineinherited

Scale histogram.

Parameters

value multiplication factor

Returns: this histogram

Definition at line 120 of file JHistogram.hh.

    {
      this->underflow *= value;
      this->overflow  *= value;
      this->integral  *= value;
 
      return *this;
    }

◆ div() [1/2]

template<class JAbscissa_t , class JContents_t , template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>

JHistogramMap & JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::div ( typename JLANG::JClass< contents_type >::argument_type factor )

inlineinherited

Scale contents.

Parameters

factor division factor

Returns: this histogram

Definition at line 102 of file JHistogramMap.hh.

    {
      collection_type::div(factor);
      histogram_type ::div(factor);
 
      return *this;
    }

◆ div() [2/2]

JHistogram & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::div ( double value )

inlineinherited

Scale histogram.

Parameters

value division factor

Returns: this histogram

Definition at line 136 of file JHistogram.hh.

    {
      this->underflow /= value;
      this->overflow  /= value;
      this->integral  /= value;
 
      return *this;
    }

◆ reset()

void JTOOLS::JHistogram< JAbscissa_t, JContents_t >::reset ( )

inlineinherited

Reset.

Definition at line 64 of file JHistogram.hh.

    {
      this->underflow = JMATH::zero;
      this->overflow  = JMATH::zero;
      this->integral  = JMATH::zero;
    }

◆ add()

JHistogram & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::add ( const JHistogram< JAbscissa_t, JContents_t::contents_type > & histogram )

inlineinherited

Add histogram.

Parameters

histogram histogram

Returns: this histogram

Definition at line 88 of file JHistogram.hh.

    {
      this->underflow += histogram.underflow;
      this->overflow  += histogram.overflow;
      this->integral  += histogram.integral;
 
      return *this;
    }

◆ sub()

JHistogram & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::sub ( const JHistogram< JAbscissa_t, JContents_t::contents_type > & histogram )

inlineinherited

Subtract histogram.

Parameters

histogram histogram

Returns: this histogram

Definition at line 104 of file JHistogram.hh.

    {
      this->underflow -= histogram.underflow;
      this->overflow  -= histogram.overflow;
      this->integral  -= histogram.integral;
 
      return *this;
    }

◆ getUnderflow()

const contents_type & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::getUnderflow ( ) const

inlineinherited

Get contents below lower limit.

Returns: contents

Definition at line 151 of file JHistogram.hh.

    {
      return underflow;
    }

◆ getOverflow()

const contents_type & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::getOverflow ( ) const

inlineinherited

Get contents above upper limit.

Returns: contents

Definition at line 162 of file JHistogram.hh.

    {
      return overflow;
    }

◆ getIntegral()

const contents_type & JTOOLS::JHistogram< JAbscissa_t, JContents_t >::getIntegral ( ) const

inlineinherited

Get contents above upper limit.

Returns: contents

Definition at line 173 of file JHistogram.hh.

    {
      return integral;
    }

Member Data Documentation

◆ underflow

contents_type JTOOLS::JHistogram< JAbscissa_t, JContents_t >::underflow

protectedinherited

Definition at line 223 of file JHistogram.hh.

◆ overflow

contents_type JTOOLS::JHistogram< JAbscissa_t, JContents_t >::overflow

protectedinherited

Definition at line 224 of file JHistogram.hh.

◆ integral

contents_type JTOOLS::JHistogram< JAbscissa_t, JContents_t >::integral

protectedinherited

Definition at line 225 of file JHistogram.hh.

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

JHistogramMap_t.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ collection_type

◆ histogram_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ contents_type

Member Function Documentation

◆ evaluate() [1/2]

◆ evaluate() [2/2]

◆ mul() [1/2]

◆ mul() [2/2]

◆ div() [1/2]

◆ div() [2/2]

◆ reset()

◆ add()

◆ sub()

◆ getUnderflow()

◆ getOverflow()

◆ getIntegral()

Member Data Documentation

◆ underflow

◆ overflow

◆ integral