Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

P_Histo1DVar Class Reference

Inheritance diagram for P_Histo1DVar:

P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition > P_I_Histo_1D P_I_Histo List of all members.

Detailed Description

Values stored in the bins are `double'.

Definition at line 198 of file P_Histograms_1D.ddl.

Public Types

typedef P_Histo1DVar Like_Current
 Convenience typedef to current type.


Public Methods

 H_IID_IMPLEMENT (P_Histo1DVar)
 Very simple RTTI feature.

typedef H_P_REF (Like_Current) Ref_Like_Current
 Convenience typedef to reference to current type.

 P_Histo1DVar (const char *a_title, HTL_STD::vector< float > &some_points, End_Point_Convention epc=RIGHT_OPEN)
 Create a 1D histo with Gravity_Bin_1D and variable partition.

 P_Histo1DVar (const char *a_title, HTL_STD::vector< double > &some_points, End_Point_Convention epc=RIGHT_OPEN)
 The same but now using a vector<double> e.g.

 P_Histo1DVar (I_Histo &a_histo, int copy_data=1)
 Copy constructor.

 P_Histo1DVar (const I_Histo &a_histo, int copy_data=1)
 Copy constructor taking const reference.

virtual ~P_Histo1DVar ()
 Destructor.

void fill (double x, double w=1.0)
 Fill histo with datapoint x and weight w.

double bin_center (Index i)
 Center of the bin indexed by i .

double mean ()
 Return histogram mean.

double rms ()
 Return histogram RMS (Root Mean Square).

Ref_Like_Current clone (int copy_data=1)
 Clone the histogram.

Ref_Like_Current clone (H_P_CLUSTER1(a_place), int copy_data=1)
 Clone the histogram.

Ref_Like_Current add (const Ref_Like_Current &other)
 Add another histogram of the same type to this one.

void add (const I_Histo &other)
 Add another histogram to this one using the abstract interface.

Ref_Like_Current sub (const Ref_Like_Current &other)
 Subtract another histogram of the same type from this one.

void sub (const I_Histo &other)
 Subtract another histogram from this one using the abstract interface.

Ref_Like_Current mul (const Ref_Like_Current &other)
 Multiply another histogram of the same type to this one.

void mul (const I_Histo &other)
 Multiply another histogram to this one using the abstract interface.

Ref_Like_Current div (const Ref_Like_Current &other)
 Divide this histogram by another of the same type.

void div (const I_Histo &other)
 Divide this histogram by another one using the abstract interface.

void add (double x)
 Add a scalar to this histogram.

void sub (double x)
 Sutract a scalar from this histogram.

void mul (double x)
 Multiply by a scalar this histogram.

void div (double x)
 Divide by scalar this histogram.


Protected Methods

virtual P_REF_I_Histo clone_ (int copy_data=1)
virtual P_REF_I_Histo clone_ (H_P_CLUSTER1(a_place), int copy_data=1)


Member Typedef Documentation

typedef P_Histo1DVar P_Histo1DVar::Like_Current
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 204 of file P_Histograms_1D.ddl.

Referenced by clone().


Constructor & Destructor Documentation

P_Histo1DVar::P_Histo1DVar const char *    a_title,
HTL_STD::vector< float > &    some_points,
End_Point_Convention    epc = RIGHT_OPEN
[inline]
 

Parameters:
a_title:  title of the histo
some_points:  vector of points that delimit the intervals
epc:  global endpoint convention (RIGHT_OPEN or LEFT_OPEN) E.g. to define 100 points: vector<float> my_points(100);

Definition at line 216 of file P_Histograms_1D.ddl.

References End_Point_Convention, H_H1D_U_EP, and RIGHT_OPEN.

P_Histo1DVar::P_Histo1DVar const char *    a_title,
HTL_STD::vector< double > &    some_points,
End_Point_Convention    epc = RIGHT_OPEN
[inline]
 

to define 100 points: vector<double> my_points(100);

Definition at line 225 of file P_Histograms_1D.ddl.

References End_Point_Convention, H_H1D_U_EP, and RIGHT_OPEN.

P_Histo1DVar::P_Histo1DVar I_Histo   a_histo,
int    copy_data = 1
[inline]
 

If copy_data == 1 the content of the histogram is copied as well, otherwise the copy is empty.

Definition at line 233 of file P_Histograms_1D.ddl.

P_Histo1DVar::P_Histo1DVar const I_Histo   a_histo,
int    copy_data = 1
[inline]
 

If copy_data == 1 the content of the histogram is copied as well, otherwise the copy is empty.

Definition at line 240 of file P_Histograms_1D.ddl.

virtual P_Histo1DVar::~P_Histo1DVar   [inline, virtual]
 

Definition at line 245 of file P_Histograms_1D.ddl.


Member Function Documentation

void P_Histo1DVar::add double    x [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 356 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::add_().

void P_Histo1DVar::add const I_Histo   other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 306 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::add_().

Ref_Like_Current P_Histo1DVar::add const Ref_Like_Current &    other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 293 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bin_count(), P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bins_, P_I_Histo_1D::extra_bin_count(), H_BIN_UPDATE, H_P_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), and P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::partition().

double P_Histo1DVar::bin_center Index    i [inline]
 

Definition at line 263 of file P_Histograms_1D.ddl.

References H_Bin_Helper::bin_center(), I_Histo::I_Bin_Location, and Index.

Ref_Like_Current P_Histo1DVar::clone H_P_CLUSTER1(a_place)   ,
int    copy_data = 1
[inline]
 

The first parameter is a clustering hint. If copy_data is zero the clone is empty.

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 282 of file P_Histograms_1D.ddl.

References H_P_NEW_CLUSTER1, and Like_Current.

Ref_Like_Current P_Histo1DVar::clone int    copy_data = 1 [inline]
 

If copy_data is zero the clone is empty.

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 273 of file P_Histograms_1D.ddl.

References H_P_NEW_CLUSTER0, and Like_Current.

Referenced by clone_().

virtual P_REF_I_Histo P_Histo1DVar::clone_ H_P_CLUSTER1(a_place)   ,
int    copy_data = 1
[inline, protected, virtual]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 288 of file P_Histograms_1D.ddl.

References clone().

virtual P_REF_I_Histo P_Histo1DVar::clone_ int    copy_data = 1 [inline, protected, virtual]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 286 of file P_Histograms_1D.ddl.

References clone().

void P_Histo1DVar::div double    x [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 362 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::div_().

void P_Histo1DVar::div const I_Histo   other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 354 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::div_().

Ref_Like_Current P_Histo1DVar::div const Ref_Like_Current &    other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 340 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bin_count(), P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bins_, P_I_Histo_1D::extra_bin_count(), H_BIN_UPDATE, H_P_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), and P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::partition().

void P_Histo1DVar::fill double    x,
double    w = 1.0
[inline]
 

Definition at line 249 of file P_Histograms_1D.ddl.

References HTLlimits::classify(), HTLlimits::isFinite(), P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::mapped_bin(), and Gravity_Bin_1D::put().

P_Histo1DVar::H_IID_IMPLEMENT P_Histo1DVar   
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

typedef P_Histo1DVar::H_P_REF Like_Current   
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

double P_Histo1DVar::mean   [inline]
 

Definition at line 266 of file P_Histograms_1D.ddl.

References H_Statistics::mean().

Referenced by rms().

void P_Histo1DVar::mul double    x [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 360 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::mul_().

void P_Histo1DVar::mul const I_Histo   other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 338 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::mul_().

Ref_Like_Current P_Histo1DVar::mul const Ref_Like_Current &    other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 324 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bin_count(), P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bins_, P_I_Histo_1D::extra_bin_count(), H_BIN_UPDATE, H_P_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), and P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::partition().

double P_Histo1DVar::rms   [inline]
 

Definition at line 268 of file P_Histograms_1D.ddl.

References mean(), and H_Statistics::rms().

void P_Histo1DVar::sub double    x [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 358 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::sub_().

void P_Histo1DVar::sub const I_Histo   other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 322 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::sub_().

Ref_Like_Current P_Histo1DVar::sub const Ref_Like_Current &    other [inline]
 

Reimplemented from P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >.

Definition at line 308 of file P_Histograms_1D.ddl.

References P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bin_count(), P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::bins_, P_I_Histo_1D::extra_bin_count(), H_BIN_UPDATE, H_P_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), and P_Histo_1D< P_Lifetime< Gravity_Bin_1D >, Gravity_Bin_1D, P_Uneven_Partition >::partition().


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

Anaphe documentation generated by Doxygen (www.doxygen.org)