Histogram map. More...

#include <JHistogramMap.hh>

Inheritance diagram for JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_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
	JHistogramMap ()
	Default constructor. More...

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

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

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

void	reset ()
	Reset. More...

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

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

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

JHistogram &	mul (const double value)
	Scale histogram. More...

JHistogram &	div (double value)
	Scale histogram. More...

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

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

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

Protected Attributes
contents_type	underflow

contents_type	overflow

contents_type	integral

Friends
JReader &	operator>> (JReader &in, JHistogramMap &object)
	Read histogram map from input. More...

JWriter &	operator<< (JWriter &out, const JHistogramMap &object)
	Write histogram map to output. More...

Detailed Description

template<class JAbscissa_t, class JContents_t, template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>
class JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >

Histogram map.

This class implements the JHistogram interface.

Definition at line 28 of file JHistogramMap.hh.

Member Typedef Documentation

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

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

Definition at line 34 of file JHistogramMap.hh.

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

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

Definition at line 35 of file JHistogramMap.hh.

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

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

Definition at line 37 of file JHistogramMap.hh.

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

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

Definition at line 38 of file JHistogramMap.hh.

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

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

Definition at line 39 of file JHistogramMap.hh.

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

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

Definition at line 41 of file JHistogramMap.hh.

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

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

Definition at line 42 of file JHistogramMap.hh.

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

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

Definition at line 43 of file JHistogramMap.hh.

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

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

Definition at line 44 of file JHistogramMap.hh.

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

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

Definition at line 47 of file JHistogramMap.hh.

Constructor & Destructor Documentation

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

JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >::JHistogramMap ( )

inline

Default constructor.

Definition at line 53 of file JHistogramMap.hh.

54 {}

Member Function Documentation

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
	)

inlinevirtual

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

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 )

inline

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

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 )

inline

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

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

inlineinherited

Reset.

Definition at line 56 of file JHistogram.hh.

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

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

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 80 of file JHistogram.hh.

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

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 96 of file JHistogram.hh.

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

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

inlineinherited

Scale histogram.

Parameters

value multiplication factor

Returns: this histogram

Definition at line 112 of file JHistogram.hh.

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

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

inlineinherited

Scale histogram.

Parameters

value division factor

Returns: this histogram

Definition at line 128 of file JHistogram.hh.

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

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

inlineinherited

Get contents below lower limit.

Returns: contents

Definition at line 143 of file JHistogram.hh.

     {
       return underflow;
     }

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

inlineinherited

Get contents above upper limit.

Returns: contents

Definition at line 154 of file JHistogram.hh.

     {
       return overflow;
     }

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

inlineinherited

Get contents above upper limit.

Returns: contents

Definition at line 165 of file JHistogram.hh.

     {
       return integral;
     }

Friends And Related Function Documentation

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

JReader& operator>>	(	JReader &	in,
		JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t > &	object
	)

friend

Read histogram map from input.

Parameters

in	reader
object	histogram map

Returns: reader

Definition at line 118 of file JHistogramMap.hh.

     {
       in >> static_cast<histogram_type&> (object);
       in >> static_cast<collection_type&>(object);
 
       return in;
     }

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

JWriter& operator<<	(	JWriter &	out,
		const JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t > &	object
	)

friend

Write histogram map to output.

Parameters

out	writer
object	histogram map

Returns: writer

Definition at line 134 of file JHistogramMap.hh.

     {
       out << static_cast<const histogram_type&> (object);
       out << static_cast<const collection_type&>(object);
 
       return out;
     }

Member Data Documentation

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

protectedinherited

Definition at line 206 of file JHistogram.hh.

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

protectedinherited

Definition at line 207 of file JHistogram.hh.

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

protectedinherited

Definition at line 208 of file JHistogram.hh.

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

JHistogramMap.hh

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

template<class JAbscissa_t, class JContents_t, template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>> class JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class JAbscissa_t, class JContents_t, template< class, class, class > class JMap_t, class JDistance_t = JDistance<JAbscissa_t>>
class JTOOLS::JHistogramMap< JAbscissa_t, JContents_t, JMap_t, JDistance_t >