I_Histo Class Reference (original) (raw)

This website is no longer maintained. Its content may be obsolete.
Please visit https://home.cern/ for current CERN information.

Main Page Class Hierarchy Compound List File List Compound Members File Members

Interface for histograms. More...

#include <[I_Histo.h](I%5FHisto.h-source.html)>

List of all members.

Public Types
typedef HTL_STD::vector< Index >	I_Bin_Location
typedef HTL_STD::vector< Extra_Index >	I_Extra_Bin_Location
enum	{ UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 }
Public Methods
	H_IID_IMPLEMENT ( I_Histo )
	Very simple RTTI feature.
virtual const char*	name () const = 0
	Name/Title attached to this histogram.
virtual I_Bin&	i_bin ( I_Bin_Location &a_location ) = 0
	In-range bin associated with location a_location.
virtual I_Bin&	i_bin ( I_Bin_Location &a_location ) const = 0
	In-range bin associated with location a_location* (const version).*
virtual I_Bin&	i_extra_bin ( I_Extra_Bin_Location &a_location ) = 0
	Extra bin associated with extra location a_location* If the location is in range, no meaningful extra bin is associated with this value.*
virtual I_Bin&	i_extra_bin ( I_Extra_Bin_Location &a_location ) const = 0
	Extra bin associated with extra location a_location* (const version).* More...
virtual Size	bin_count () const = 0
	Number of in-range bins.
virtual Size	extra_bin_count () const = 0
	Number of extra bins.
virtual Size	dim () const = 0
	Dimension of the histo. i.e. of the problem space.
virtual I_Partition&	i_partition ( Index p = 0 ) = 0
	(Elementary) Partition interface associated with this histo. More...
virtual I_Partition&	i_partition ( Index p = 0 ) const = 0
	(Elementary) Partition interface associated with this histo (const version). More...
virtual void	reset () = 0
	Reset histogram content.
virtual void	start_update () = 0
	Start update. More...
virtual I_Bin&	i_bin ( Index i ) = 0
	Retrieve any bin (in-range or extra) whose index is i Note: this is a linear access. More...
virtual I_Bin&	i_bin ( Index i ) const = 0
	Retrieve any bin (in-range or extra) whose index is i . More...
virtual int	version () const = 0
	Histogram version. More...
virtual I_Bin&	i_any_bin ( I_Bin_Location &a_location ) const = 0
	Any bin associated with location a_location* (const version).* More...
Protected Methods
	I_Histo ()
virtual	~I_Histo ()

Detailed Description

Interface for histograms.

Both transient and persistent histograms inherit from and implement this interface. Most of the features that are provided are for read-access only. The default "interface" for numerical values is double. Other objects types have interfaces that begin with I_ .

Member Typedef Documentation

**typedef HTL_STD::vector<

Index > I_Histo::I_Bin_Location

**typedef HTL_STD::vector<

Extra_Index > I_Histo::I_Extra_Bin_Location

Enumeration Value Documentation

**I_Histo::OVERFLOW_BIN = -1

**I_Histo::UNDERFLOW_BIN = -2

Constructor & Destructor Documentation

**I_Histo::I_Histo () [inline, protected]

**I_Histo::~I_Histo () [inline, protected, virtual]

Member Function Documentation

| I_Histo::H_IID_IMPLEMENT ( | I_Histo) | | --------------------------------- | ------------- |

Very simple RTTI feature.

Size I_Histo::bin_count () const [inline, pure virtual]

Size I_Histo::dim () const [inline, pure virtual]

Dimension of the histo. i.e. of the problem space.

Size I_Histo::extra_bin_count () const [inline, pure virtual]

Any bin associated with location a_location (const version).

Location element can be either bin number or one of the constants: { UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 } according to the AIDA specifications.

| | | |

I_Bin & I_Histo::i_bin (

Index i) const [inline, pure virtual]

Retrieve any bin (in-range or extra) whose index is i .

Const version. Note: this is a linear access. You must know how bins are stored to safely use this method.

| | | |

I_Bin & I_Histo::i_bin (

Index i) [inline, pure virtual]

Retrieve any bin (in-range or extra) whose index is i Note: this is a linear access.

You must know how bins are stored to safely use this method.

In-range bin associated with location a_location (const version).

In-range bin associated with location a_location.

Extra bin associated with extra location a_location (const version).

If the location is in range, no meaningful extra bin is associated with this value.

Extra bin associated with extra location a_location If the location is in range, no meaningful extra bin is associated with this value.

(Elementary) Partition interface associated with this histo (const version).

Parameters:

1st	partition: p = 0
2nd	partition: p = 1 ...

(Elementary) Partition interface associated with this histo.

Parameters:

1st	partition: p = 0
2nd	partition: p = 1 ...

**const char * I_Histo::name () const [inline, pure virtual]

Name/Title attached to this histogram.

**void I_Histo::reset () [inline, pure virtual]

**void I_Histo::start_update () [inline, pure virtual]

Start update.

By default the interface only offers read access to bins and their contents; call this method to enable the later modification of the contents -- via set_value(..), etc.

**int I_Histo::version () const [inline, pure virtual]

Histogram version.

Can either be stored in the histogram or computed

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

I_Histo.h