Gromacs  2021.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::AnalysisHistogramSettings Class Reference

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


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.
int 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.
int findBin (real y) const
 Returns a zero-based bin index for a value, or -1 if not in range.

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:

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