gmx::AnalysisHistogramSettings Class Reference

#include <gromacs/analysisdata/modules/histogram.h>

Description

Contains parameters that specify histogram bin locations.

Methods in this class do not throw.

Public Member Functions
	AnalysisHistogramSettings ()
	Initializes undefined parameters.
	AnalysisHistogramSettings (const AnalysisHistogramSettingsInitializer &settings)
	Initializes parameters based on a named parameter object. More...
real	firstEdge () const
	Returns the left edge of the first bin.
real	lastEdge () const
	Returns the right edge of the first bin.
size_t	binCount () const
	Returns the number of bins in the histogram.
real	binWidth () const
	Returns the width of a bin in the histogram.
bool	includeAll () const
	Whether values beyond the edges are mapped to the edge bins.
size_t	findBin (real y) const
	Returns a zero-based bin index for a value, or npos if not in range.

Static Public Attributes
static constexpr size_t	npos = static_cast<size_t>(-1)

Constructor & Destructor Documentation

gmx::AnalysisHistogramSettings::AnalysisHistogramSettings

(

const AnalysisHistogramSettingsInitializer &

settings

)

Initializes parameters based on a named parameter object.

This constructor is not explicit to allow initialization of histograms directly from AnalysisHistogramSettingsInitializer:

  gmx::AnalysisDataSimpleHistogramModule *hist =
          new gmx::AnalysisDataSimpleHistogramModule(
                  histogramFromRange(0.0, 5.0).binWidth(0.5));
* 

---

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

• api/legacy/include/gromacs/analysisdata/modules/histogram.h
• src/gromacs/analysisdata/modules/histogram.cpp