BaseHistogram Class Reference

Inheritance diagram for BaseHistogram:

[legend]List of all members.

---

Detailed Description

This is the base for all histogramms.

Author:

Brian Moore, John Schneiderman

Definition at line 34 of file basehistogram.h.

Public Member Functions
virtual void	acquire (const Cluster &cluster)=0
	BaseHistogram (double min, double max, int bins)
void	clear ()
vector< int >	histogramBins () const
int	pullingInterval () const
void	setPullingInterval (int interval)
virtual void	write (int numAtoms, string base_name)=0
Protected Attributes
int	m_bins
vector< int >	m_histogramBin
double	m_max
double	m_min
int	m_numberHistogramsTaken
int	m_pullingInterval

---

Constructor & Destructor Documentation

BaseHistogram::BaseHistogram (  double  min, double  max, int  bins )

A general constructor to generate a histogram. Parameters: min  is the minimum value. max  is the maximum value. bins  is the number of bins for the histogram. Definition at line 22 of file basehistogram.cpp. References m_bins, m_histogramBin, m_max, m_min, and m_numberHistogramsTaken.

---

Member Function Documentation

virtual void BaseHistogram::acquire (  const Cluster &  cluster  )  [pure virtual]

An abstract method to take sample readings from a cluster for a histogram. Parameters: cluster  is the cluster to pull the information from. Implemented in KineticEnergyHistogram, PotentialEnergyHistogram, RadialDensityHistogram, and RadialDistributionFunction.

void BaseHistogram::clear (   )

Clears the base histogram. Definition at line 47 of file basehistogram.cpp. References m_bins, m_histogramBin, and m_numberHistogramsTaken. Referenced by BaseSimulation::clear().

vector< int > BaseHistogram::histogramBins (   )  const

Accessor to the histogram bins. Returns: the histogram bins. Definition at line 32 of file basehistogram.cpp. References m_histogramBin.

int BaseHistogram::pullingInterval (   )  const

Accessor to the pull interval. Returns: how often a histogram is suppose to be taken. Definition at line 37 of file basehistogram.cpp. References m_pullingInterval. Referenced by MDLJ_Simulation::run(), and MCLJ_Simulation::run().

void BaseHistogram::setPullingInterval (  int  interval  )

Modifier for the pull interval. Parameters: interval  sets how often the histogram should be taken. Definition at line 42 of file basehistogram.cpp. References m_pullingInterval.

virtual void BaseHistogram::write (  int  numAtoms, string  base_name )  [pure virtual]

An abstract method for writting the histograms values. Parameters: numAtoms  is the number of atoms in the cluster. base_name  is the base name for the histogram created. Implemented in KineticEnergyHistogram, PotentialEnergyHistogram, RadialDensityHistogram, and RadialDistributionFunction.

---

Member Data Documentation

int BaseHistogram::m_bins [protected]

Parameters: m_bins  is the number of bins in the histogram. Definition at line 91 of file basehistogram.h. Referenced by RadialDistributionFunction::acquire(), RadialDensityHistogram::acquire(), PotentialEnergyHistogram::acquire(), KineticEnergyHistogram::acquire(), BaseHistogram(), clear(), RadialDistributionFunction::write(), RadialDensityHistogram::write(), PotentialEnergyHistogram::write(), and KineticEnergyHistogram::write().

vector<int> BaseHistogram::m_histogramBin [protected]

Parameters: m_histogramBin  is the container for the histograms. Definition at line 79 of file basehistogram.h. Referenced by RadialDistributionFunction::acquire(), RadialDensityHistogram::acquire(), PotentialEnergyHistogram::acquire(), KineticEnergyHistogram::acquire(), BaseHistogram(), clear(), histogramBins(), RadialDistributionFunction::write(), RadialDensityHistogram::write(), PotentialEnergyHistogram::write(), and KineticEnergyHistogram::write().

double BaseHistogram::m_max [protected]

Parameters: m_max  is the maximum value for the histogram. Definition at line 87 of file basehistogram.h. Referenced by RadialDistributionFunction::acquire(), RadialDensityHistogram::acquire(), PotentialEnergyHistogram::acquire(), KineticEnergyHistogram::acquire(), BaseHistogram(), RadialDistributionFunction::write(), RadialDensityHistogram::write(), PotentialEnergyHistogram::write(), and KineticEnergyHistogram::write().

double BaseHistogram::m_min [protected]

Parameters: m_min  is the minimum value for the histogram. Definition at line 83 of file basehistogram.h. Referenced by RadialDistributionFunction::acquire(), RadialDensityHistogram::acquire(), PotentialEnergyHistogram::acquire(), KineticEnergyHistogram::acquire(), BaseHistogram(), RadialDistributionFunction::write(), RadialDensityHistogram::write(), PotentialEnergyHistogram::write(), and KineticEnergyHistogram::write().

int BaseHistogram::m_numberHistogramsTaken [protected]

Parameters: m_numberHistogramsTaken  is the number of histograms taken. Definition at line 95 of file basehistogram.h. Referenced by RadialDistributionFunction::acquire(), RadialDensityHistogram::acquire(), PotentialEnergyHistogram::acquire(), KineticEnergyHistogram::acquire(), BaseHistogram(), clear(), RadialDistributionFunction::write(), RadialDensityHistogram::write(), PotentialEnergyHistogram::write(), and KineticEnergyHistogram::write().

int BaseHistogram::m_pullingInterval [protected]

Parameters: m_pullingInterval  is the interval for how often to take the histogram. Definition at line 99 of file basehistogram.h. Referenced by KineticEnergyHistogram::KineticEnergyHistogram(), PotentialEnergyHistogram::PotentialEnergyHistogram(), pullingInterval(), RadialDensityHistogram::RadialDensityHistogram(), RadialDistributionFunction::RadialDistributionFunction(), and setPullingInterval().

---

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

• histograms/basehistogram.h
• histograms/basehistogram.cpp

---