The Sparta Modeling Framework
Loading...
Searching...
No Matches
sparta::HistogramStandalone Class Reference
Inheritance diagram for sparta::HistogramStandalone:
Collaboration diagram for sparta::HistogramStandalone:

Public Member Functions

 HistogramStandalone (StatisticSet *sset, const std::string &stat_prefix, uint64_t lower_val, uint64_t upper_val, uint32_t num_vals_per_bin, uint32_t num_max_vals, InstrumentationNode::Visibility bin_vis=InstrumentationNode::VIS_NORMAL, InstrumentationNode::Visibility prob_vis=InstrumentationNode::VIS_NORMAL, InstrumentationNode::Visibility max_vis=InstrumentationNode::VIS_NORMAL)
 
- Public Member Functions inherited from sparta::HistogramBase
void addValue (uint64_t val)
 Add a value to histogram.
 
double getStandardDeviation () const
 Calculate Standard Deviation of counts in bins. This API also takes into account the count in underflow and overflow bins.
 
double getMeanBinCount () const
 Calculate the mean bin count of all the bins. This API also takes into account the count in underflow and overflow bins.
 
const sparta::CountergetAggValues () const
 Return aggregate of this histogram.
 
const std::vector< sparta::Counter > & getRegularBin () const
 Return vector of regular bin counts.
 
const sparta::CountergetUnderflowBin () const
 Return count of underflow bin.
 
const sparta::CountergetOverflowBin () const
 Return count of overflow bin.
 
double getUnderflowProbability () const
 Return underflow probability.
 
double getOverflowProbability () const
 Return overflow probability.
 
const std::vector< double > & recomputeRegularBinProbabilities () const
 Return vector of probabilities regular bins.
 
uint64_t getHistogramUpperValue () const
 
uint64_t getHistogramLowerValue () const
 
uint32_t getNumBins () const
 
uint32_t getNumValuesPerBin () const
 

Additional Inherited Members

- Protected Member Functions inherited from sparta::HistogramBase
 HistogramBase (uint64_t lower_val, uint64_t upper_val, uint32_t num_vals_per_bin)
 HistogramBase constructor.
 
void updateMaxValues_ (uint64_t val)
 
std::string getDisplayStringCumulative_ (const std::string &name) const
 Render the cumulative values of this histogram for use in standalone model.
 
void initializeStats_ (StatisticSet *sset, const std::string &stat_prefix="", InstrumentationNode::Visibility bin_vis=InstrumentationNode::VIS_NORMAL, InstrumentationNode::Visibility prob_vis=InstrumentationNode::VIS_NORMAL, uint32_t num_max_values=0, InstrumentationNode::Visibility max_vis=InstrumentationNode::VIS_SUMMARY)
 

Detailed Description

Definition at line 388 of file Histogram.hpp.

Constructor & Destructor Documentation

◆ HistogramStandalone()

sparta::HistogramStandalone::HistogramStandalone ( StatisticSet sset,
const std::string &  stat_prefix,
uint64_t  lower_val,
uint64_t  upper_val,
uint32_t  num_vals_per_bin,
uint32_t  num_max_vals,
InstrumentationNode::Visibility  bin_vis = InstrumentationNode::VIS_NORMAL,
InstrumentationNode::Visibility  prob_vis = InstrumentationNode::VIS_NORMAL,
InstrumentationNode::Visibility  max_vis = InstrumentationNode::VIS_NORMAL 
)
inline

Create a standalone histogram

Parameters
ssetStatistic set to add this histogram's stats into
stat_prefixString prefix to prepend to all internally generated stat names
lower_valMinimum value in the histogram
upper_valMaximum value in the histogram
num_vals_per_binNumber of values per bin
num_max_valuesTrack the top 'num_max_values' maximum values
bin_visVisbility of the bin / OF / UF / total stats
prob_visVisibility of the probability stats

Definition at line 403 of file Histogram.hpp.

Here is the call graph for this function:

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