herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Statistics::Distribution Class Reference

A (one dimensional) distribution. More...

#include <Distribution.h>

Classes

struct  DistributionBin
 A bin in a distribution. More...
 

Public Member Functions

 Distribution ()
 Default constructor.
 
 Distribution (const Histogram &histo, double nPoints)
 Construct from a histogram.
 
virtual ~Distribution ()
 Destructor.
 
const std::string & name () const
 Return the name of the distribution.
 
const std::vector< DistributionBin > & bins () const
 Return the bins in the distribution.
 
bool isCompatible (const Distribution &other) const
 Return true, if this distribution is compatible with another one.
 
Distributionoperator+= (const Distribution &other)
 Add two distributions.
 
Distributionoperator-= (const Distribution &other)
 Subtract two distributions.
 
Distributionoperator*= (const Distribution &other)
 Multiply two distributions.
 
Distributionoperator/= (const Distribution &other)
 Divide two distributions.
 
void fromXML (const XML::Element &)
 Fill distribution data from an XML element.
 
XML::Element toXML () const
 Return an XML element for the data of this distribution.
 
void toMakePlots (const std::string &analysis, const std::string &options="") const
 Write out data ready for make-plots, given an analysis name and plot options.
 
void toMakePlots (const std::string &analysis, const Distribution &lower, const Distribution &upper, const std::string &options="") const
 Write out data ready for make-plots, given an analysis name and plot options.
 
void appendToMakePlots (std::ostream &os, const std::string &analysis, const std::string &options="") const
 Write out data ready for make-plots, given an analysis name and plot options.
 
void appendToMakePlots (std::ostream &os, const std::string &analysis, const Distribution &lower, const Distribution &upper, const std::string &options="") const
 Write out data ready for make-plots, given an analysis name and plot options.
 

Private Attributes

std::string theName
 The name of the distribution.
 
std::vector< DistributionBintheBins
 The bins in the distribution.
 

Detailed Description

A (one dimensional) distribution.

Author
Simon Platzer

Definition at line 21 of file Distribution.h.

Member Function Documentation

◆ bins()

const std::vector< DistributionBin > & Statistics::Distribution::bins ( ) const
inline

Return the bins in the distribution.

Definition at line 117 of file Distribution.h.

References theBins.

◆ name()

const std::string & Statistics::Distribution::name ( ) const
inline

Return the name of the distribution.

Definition at line 112 of file Distribution.h.

References theName.

Member Data Documentation

◆ theBins

std::vector<DistributionBin> Statistics::Distribution::theBins
private

The bins in the distribution.

Definition at line 204 of file Distribution.h.

Referenced by bins().

◆ theName

std::string Statistics::Distribution::theName
private

The name of the distribution.

Definition at line 199 of file Distribution.h.

Referenced by name().


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