Template definition of histogram object interface. More...

#include <JHistogram.hh>

Inheritance diagram for JTOOLS::JHistogram< JAbscissa_t, JContents_t >:

Public Types
typedef JAbscissa_t	abscissa_type

typedef JContents_t	contents_type

Public Member Functions
virtual	~JHistogram ()
	Virtual destructor. 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 Member Functions
	JHistogram ()
	Default constructor. More...

Protected Attributes
contents_type	underflow

contents_type	overflow

contents_type	integral

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

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

Detailed Description

template<class JAbscissa_t, class JContents_t>
class JTOOLS::JHistogram< JAbscissa_t, JContents_t >

Template definition of histogram object interface.

This class also comprises auxiliary data.

Definition at line 27 of file JHistogram.hh.

Member Typedef Documentation

◆ abscissa_type

template<class JAbscissa_t , class JContents_t >

typedef JAbscissa_t JTOOLS::JHistogram< JAbscissa_t, JContents_t >::abscissa_type

Definition at line 42 of file JHistogram.hh.

◆ contents_type

template<class JAbscissa_t , class JContents_t >

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

Definition at line 43 of file JHistogram.hh.

Constructor & Destructor Documentation

◆ JHistogram()

template<class JAbscissa_t , class JContents_t >

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

inlineprotected

Default constructor.

Definition at line 33 of file JHistogram.hh.

                  :
       underflow(JMATH::zero),
       overflow (JMATH::zero),
       integral (JMATH::zero)
     {}

◆ ~JHistogram()

template<class JAbscissa_t , class JContents_t >

virtual JTOOLS::JHistogram< JAbscissa_t, JContents_t >::~JHistogram ( )

inlinevirtual

Virtual destructor.

Definition at line 49 of file JHistogram.hh.

50 {}

Member Function Documentation

◆ reset()

template<class JAbscissa_t , class JContents_t >

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

inline

Reset.

Definition at line 56 of file JHistogram.hh.

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

◆ evaluate()

template<class JAbscissa_t , class JContents_t >

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

pure virtual

Histogram filling.

Parameters

pX	pointer to abscissa values
w	weight

Implemented in JTOOLS::JHistogramMap< JKey_t, JHistogram_t, JMap, JDistance< JKey_t > >, and JTOOLS::JHistogram1D< JBin2D< JAbscissa_t, JContents_t >, JContainer_t, JDistance_t >.

◆ add()

template<class JAbscissa_t , class JContents_t >

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

inline

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

◆ sub()

template<class JAbscissa_t , class JContents_t >

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

inline

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

◆ mul()

template<class JAbscissa_t , class JContents_t >

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

inline

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

◆ div()

template<class JAbscissa_t , class JContents_t >

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

inline

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

◆ getUnderflow()

template<class JAbscissa_t , class JContents_t >

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

inline

Get contents below lower limit.

Returns: contents

Definition at line 143 of file JHistogram.hh.

     {
       return underflow;
     }

◆ getOverflow()

template<class JAbscissa_t , class JContents_t >

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

inline

Get contents above upper limit.

Returns: contents

Definition at line 154 of file JHistogram.hh.

     {
       return overflow;
     }

◆ getIntegral()

template<class JAbscissa_t , class JContents_t >

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

inline

Get contents above upper limit.

Returns: contents

Definition at line 165 of file JHistogram.hh.

     {
       return integral;
     }

Friends And Related Function Documentation

◆ operator>>

template<class JAbscissa_t , class JContents_t >

JReader& operator>>	(	JReader &	in,
		JHistogram< JAbscissa_t, JContents_t > &	object
	)

friend

Read histogram from input.

Parameters

in	reader
object	histogram

Returns: reader

Definition at line 178 of file JHistogram.hh.

     {
       in >> object.underflow;
       in >> object.overflow;
       in >> object.integral;
  
       return in;
     }

◆ operator<<

template<class JAbscissa_t , class JContents_t >

JWriter& operator<<	(	JWriter &	out,
		const JHistogram< JAbscissa_t, JContents_t > &	object
	)

friend

Write histogram to output.

Parameters

out	writer
object	histogram

Returns: writer

Definition at line 195 of file JHistogram.hh.

     {
       out << object.underflow;
       out << object.overflow;
       out << object.integral;
  
       return out;
     }

Member Data Documentation

◆ underflow

template<class JAbscissa_t , class JContents_t >

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

protected

Definition at line 206 of file JHistogram.hh.

◆ overflow

template<class JAbscissa_t , class JContents_t >

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

protected

Definition at line 207 of file JHistogram.hh.

◆ integral

template<class JAbscissa_t , class JContents_t >

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

protected

Definition at line 208 of file JHistogram.hh.

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

JHistogram.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class JAbscissa_t, class JContents_t> class JTOOLS::JHistogram< JAbscissa_t, JContents_t >

Member Typedef Documentation

◆ abscissa_type

◆ contents_type

Constructor & Destructor Documentation

◆ JHistogram()

◆ ~JHistogram()

Member Function Documentation

◆ reset()

◆ evaluate()

◆ add()

◆ sub()

◆ mul()

◆ div()

◆ getUnderflow()

◆ getOverflow()

◆ getIntegral()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ underflow

◆ overflow

◆ integral

template<class JAbscissa_t, class JContents_t>
class JTOOLS::JHistogram< JAbscissa_t, JContents_t >