JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t > Class Template Reference

Histogram in 1D. More...

#include <JHistogram1D.hh>

Inheritance diagram for JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >:

Public Types
enum	{ NUMBER_OF_DIMENSIONS = 1 }
typedef JContainer_t< JElement_t, JDistance_t >	collection_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 JHistogram< abscissa_type, ordinate_type >	histogram_type
typedef histogram_type::contents_type	contents_type
typedef JTOOLS::JRebin< value_type >	JRebin
typedef JTOOLS::JContent< value_type >	JContent

Public Member Functions
	JHistogram1D ()
	Default constructor.
	JHistogram1D (const JAbstractHistogram< abscissa_type > &bounds)
	Constructor.
	JHistogram1D (const JAbstractCollection< abscissa_type > &bounds)
	Constructor.
void	reset ()
	Reset.
virtual void	evaluate (const abscissa_type *pX, typename JClass< contents_type >::argument_type w)
	Fill histogram.
void	fill (typename JClass< abscissa_type >::argument_type x, typename JClass< contents_type >::argument_type w)
	Fill histogram.
template<class JRebin_t >
void	rebin (JRebin_t merge)
	Rebin histogram.
JHistogram1D &	add (const JHistogram1D &histogram)
	Add histogram.
JHistogram1D &	sub (const JHistogram1D &histogram)
	Subtract histogram.
JHistogram1D &	mul (const double value)
	Scale contents.
JHistogram1D &	div (const double value)
	Scale contents.
virtual void	evaluate (const abscissa_type *pX, typename JLANG::JClass< contents_type >::argument_type w)=0
	Histogram filling.
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.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Protected Attributes
contents_type	underflow
contents_type	overflow
contents_type	integral

Friends
JReader &	operator>> (JReader &in, JHistogram1D &object)
	Read histogram from input.
JWriter &	operator<< (JWriter &out, const JHistogram1D &object)
	Write histogram to output.

Detailed Description

template<class JElement_t, template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
class JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >

Histogram in 1D.

This class implements the JHistogram interface.

Definition at line 111 of file JHistogram1D.hh.

Member Typedef Documentation

collection_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JContainer_t<JElement_t, JDistance_t> JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::collection_type

Definition at line 120 of file JHistogram1D.hh.

abscissa_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::abscissa_type JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::abscissa_type

Definition at line 122 of file JHistogram1D.hh.

ordinate_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::ordinate_type JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::ordinate_type

Definition at line 123 of file JHistogram1D.hh.

value_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::value_type JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::value_type

Definition at line 124 of file JHistogram1D.hh.

const_iterator

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::const_iterator JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::const_iterator

Definition at line 126 of file JHistogram1D.hh.

const_reverse_iterator

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::const_reverse_iterator JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::const_reverse_iterator

Definition at line 127 of file JHistogram1D.hh.

iterator

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::iterator JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::iterator

Definition at line 128 of file JHistogram1D.hh.

reverse_iterator

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

collection_type::reverse_iterator JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::reverse_iterator

Definition at line 129 of file JHistogram1D.hh.

histogram_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JHistogram<abscissa_type, ordinate_type> JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::histogram_type

Definition at line 131 of file JHistogram1D.hh.

contents_type

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

histogram_type::contents_type JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::contents_type

Definition at line 133 of file JHistogram1D.hh.

JRebin

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JRebin<value_type> JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::JRebin

Definition at line 135 of file JHistogram1D.hh.

JContent

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JContent<value_type> JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::JContent

Definition at line 136 of file JHistogram1D.hh.

Member Enumeration Documentation

anonymous enum

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

anonymous enum

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 118 of file JHistogram1D.hh.

{ NUMBER_OF_DIMENSIONS = 1 };

Constructor & Destructor Documentation

JHistogram1D() [1/3]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::JHistogram1D ( )

inline

Default constructor.

Definition at line 142 of file JHistogram1D.hh.

    {}

JHistogram1D() [2/3]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::JHistogram1D ( const JAbstractHistogram< abscissa_type > & bounds )

inline

Constructor.

Parameters

bounds

bounds

Definition at line 151 of file JHistogram1D.hh.

    {
      this->configure(bounds);
    }

JHistogram1D() [3/3]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::JHistogram1D ( const JAbstractCollection< abscissa_type > & bounds )

inline

Constructor.

Parameters

bounds

bounds

Definition at line 162 of file JHistogram1D.hh.

    {
      this->configure(bounds);
    }

Member Function Documentation

reset()

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

void JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::reset ( )

inline

Reset.

Definition at line 171 of file JHistogram1D.hh.

    {
      histogram_type::reset();
 
      for (iterator i = this->begin(); i != this->end(); ++i) {
        i->getY() = JMATH::zero;
      }
    }

evaluate() [1/2]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

virtual void JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::evaluate ( const abscissa_type * pX, typename JClass< contents_type >::argument_type w )

inlinevirtual

Fill histogram.

Parameters

pX	pointer to abscissa values
w	weight

Definition at line 187 of file JHistogram1D.hh.

    {
      this->fill(*pX, w);
    }

fill()

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

void JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::fill ( typename JClass< abscissa_type >::argument_type x, typename JClass< contents_type >::argument_type w )

inline

Fill histogram.

Parameters

x	abscissa value
w	weight

Definition at line 200 of file JHistogram1D.hh.

    {
      this->integral  += w;
 
      iterator p = this->lower_bound(x);
        
      if      (p == this->begin())
        this->underflow += w;
      else if (p == this->end())
        this->overflow  += w;
      else
        (--p)->getY()   += w;
    }

rebin()

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

template<class JRebin_t >

void JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::rebin ( JRebin_t merge )

inline

Rebin histogram.

Parameters

merge

rebin evaluator

Definition at line 222 of file JHistogram1D.hh.

    {
      if (this->size() > 1u) {
 
        iterator out = this->begin();
 
        for (const_iterator i = this->begin(); i != this->end(); ) {
 
          *out = *i;
 
          while (++i != this->end() && merge(*out,*i)) {
            out->getY() += i->getY();
          }
 
          ++out;
        }
 
        const_reverse_iterator __rbegin(out);
 
        if (this->getDistance(__rbegin->getX(), this->rbegin()->getX()) > 0.0) {
 
          *out = *(this->rbegin());
 
          ++out;
        }
 
        this->resize(std::distance(this->begin(), out));
      }
    }

add() [1/2]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JHistogram1D & JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::add ( const JHistogram1D< JElement_t, JContainer_t, JDistance_t > & histogram )

inline

Add histogram.

Parameters

histogram

histogram

Returns

this histogram

Definition at line 259 of file JHistogram1D.hh.

    {
      collection_type::add(static_cast<const collection_type&>(histogram));
      histogram_type ::add(static_cast<const histogram_type&> (histogram));
 
      return *this;
    }

sub() [1/2]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JHistogram1D & JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::sub ( const JHistogram1D< JElement_t, JContainer_t, JDistance_t > & histogram )

inline

Subtract histogram.

Parameters

histogram

histogram

Returns

this histogram

Definition at line 274 of file JHistogram1D.hh.

    {
      collection_type::sub(static_cast<const collection_type&>(histogram));
      histogram_type ::sub(static_cast<const histogram_type&> (histogram));
 
      return *this;
    }

mul() [1/2]

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JHistogram1D & JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::mul ( const double value )

inline

Scale contents.

Parameters

value

multiplication factor

Returns

this histogram

Definition at line 289 of file JHistogram1D.hh.

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

div()

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JHistogram1D & JTOOLS::JHistogram1D< JElement_t, JContainer_t, JDistance_t >::div ( const double value )

inline

Scale contents.

Parameters

value

division factor

Returns

this histogram

Definition at line 304 of file JHistogram1D.hh.

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

evaluate() [2/2]

virtual void JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::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

add() [2/2]

JHistogram & JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::add ( const JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_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;
    }

sub() [2/2]

JHistogram & JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::sub ( const JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_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;
    }

getUnderflow()

const contents_type & JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::getUnderflow ( ) const

inlineinherited

Get contents below lower limit.

Returns

contents

Definition at line 143 of file JHistogram.hh.

    {
      return underflow;
    }

getOverflow()

const contents_type & JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::getOverflow ( ) const

inlineinherited

Get contents above upper limit.

Returns

contents

Definition at line 154 of file JHistogram.hh.

    {
      return overflow;
    }

getIntegral()

const contents_type & JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::getIntegral ( ) const

inlineinherited

Get contents above upper limit.

Returns

contents

Definition at line 165 of file JHistogram.hh.

    {
      return integral;
    }

mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Symbol Documentation

operator>>

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JReader & operator>> ( JReader & in, JHistogram1D< JElement_t, JContainer_t, JDistance_t > & object )

friend

Read histogram from input.

Parameters

in	reader
object	histogram

Returns

reader

Definition at line 320 of file JHistogram1D.hh.

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

operator<<

template<class JElement_t , template< class, class > class JContainer_t, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>

JWriter & operator<< ( JWriter & out, const JHistogram1D< JElement_t, JContainer_t, JDistance_t > & object )

friend

Write histogram to output.

Parameters

out	writer
object	histogram

Returns

writer

Definition at line 336 of file JHistogram1D.hh.

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

Member Data Documentation

underflow

contents_type JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::underflow

protectedinherited

Definition at line 206 of file JHistogram.hh.

overflow

contents_type JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::overflow

protectedinherited

Definition at line 207 of file JHistogram.hh.

integral

contents_type JTOOLS::JHistogram< JElement_t::abscissa_type, JElement_t::ordinate_type >::integral

protectedinherited

Definition at line 208 of file JHistogram.hh.

---

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

• JHistogram1D.hh