SST  9.0.0
StructuralSimulationToolkit
stataccumulator.h
1 // Copyright 2009-2019 NTESS. Under the terms
2 // of Contract DE-NA0003525 with NTESS, the U.S.
3 // Government retains certain rights in this software.
4 //
5 // Copyright (c) 2009-2019, NTESS
6 // All rights reserved.
7 //
8 // This file is part of the SST software package. For license
9 // information, see the LICENSE file in the top level directory of the
10 // distribution.
11 
12 
13 #ifndef _H_SST_CORE_ACCUMULATOR_STATISTIC_
14 #define _H_SST_CORE_ACCUMULATOR_STATISTIC_
15 
16 #include <cmath>
17 #include <limits>
18 
19 #include <sst/core/sst_types.h>
20 #include <sst/core/warnmacros.h>
21 
22 #include <sst/core/statapi/statbase.h>
23 #include <sst/core/statapi/statoutput.h>
24 
25 namespace SST {
26 namespace Statistics {
27 
28 // NOTE: When calling base class members of classes derived from
29 // a templated base class. The user must use "this->" in
30 // order to call base class members (to avoid a compiler
31 // error) because they are "nondependant named" and the
32 // templated base class is a "dependant named". The
33 // compiler will not look in dependant named base classes
34 // when looking up independent names.
35 // See: http://www.parashift.com/c++-faq-lite/nondependent-name-lookup-members.html
36 
37 /**
38  \class AccumulatorStatistic
39 
40  Allows the online gathering of statistical information about a single quantity. The basic
41  statistics are captured online removing the need to keep a copy of the values of interest.
42 
43  @tparam NumberBase A template for the basic numerical type of values
44 */
45 
46 template <typename NumberBase>
47 class AccumulatorStatistic : public Statistic<NumberBase>
48 {
49 public:
50  SST_ELI_DECLARE_STATISTIC_TEMPLATE(
52  "sst",
53  "AccumulatorStatistic",
54  SST_ELI_ELEMENT_VERSION(1,0,0),
55  "Accumulate all contributions to a statistic",
56  "SST::Statistic<T>")
57 
58  AccumulatorStatistic(BaseComponent* comp, const std::string& statName, const std::string& statSubId, Params& statParams)
59  : Statistic<NumberBase>(comp, statName, statSubId, statParams)
60  {
61  m_sum = static_cast<NumberBase>(0);
62  m_sum_sq = static_cast<NumberBase>(0);
63  m_min = std::numeric_limits<NumberBase>::max();
64  m_max = std::numeric_limits<NumberBase>::min();
65 
66  // Set the Name of this Statistic
67  this->setStatisticTypeName("Accumulator");
68  }
69 
71 
72 protected:
73  /**
74  Present a new value to the class to be included in the statistics.
75  @param value New value to be presented
76  */
77  void addData_impl(NumberBase value) override
78  {
79  m_sum += value;
80  m_sum_sq += (value * value);
81  m_min = ( value < m_min ) ? value : m_min;
82  m_max = ( value > m_max ) ? value : m_max;
83  }
84 
85 public:
86  /**
87  Provides the sum of the values presented so far.
88  @return The sum of values presented to the class so far.
89  */
90  NumberBase getSum()
91  {
92  return m_sum;
93  }
94 
95  /**
96  Provides the maxmimum value presented so far.
97  @return The maximum of values presented to the class so far
98  */
99  NumberBase getMax()
100  {
101  return m_max;
102  }
103 
104  /**
105  Provides the minimum value presented so far.
106  @return The minimum of values presented to the class so far
107  */
108  NumberBase getMin()
109  {
110  return m_min;
111  }
112 
113  /**
114  Provides the sum of each value squared presented to the class so far.
115  @return The sum of squared values presented to the class so far.
116  */
117  NumberBase getSumSquared()
118  {
119  return m_sum_sq;
120  }
121 
122  /**
123  Get the arithmetic mean of the values presented so far
124  @return The arithmetic mean of the values presented so far.
125  */
126  NumberBase getArithmeticMean()
127  {
128  uint64_t count = getCount();
129  return (count > 0) ? (m_sum / (NumberBase) count) : 0;
130  }
131 
132  /**
133  Get the variance of the values presented so far
134  @return The variance of the values presented so far
135  */
136  NumberBase getVariance()
137  {
138  uint64_t count = getCount();
139  return (count > 0) ? (m_sum_sq * count) - (m_sum * m_sum) : 0;
140  }
141 
142  /**
143  Get the standard deviation of the values presented so far
144  @return The standard deviation of the values presented so far
145  */
146  NumberBase getStandardDeviation()
147  {
148  return (NumberBase) std::sqrt( (double) getVariance() );
149  }
150 
151  /**
152  Get a count of the number of elements presented to the statistics collection so far.
153  @return Count the number of values presented to the class.
154  */
155  uint64_t getCount()
156  {
157  return this->getCollectionCount();
158  }
159 
160  void clearStatisticData() override
161  {
162  m_sum = 0;
163  m_sum_sq =0;
164  m_min = std::numeric_limits<NumberBase>::max();
165  m_max = std::numeric_limits<NumberBase>::min();
166  this->setCollectionCount(0);
167  }
168 
169  void registerOutputFields(StatisticOutput* statOutput) override
170  {
171  h_sum = statOutput->registerField<NumberBase>("Sum");
172  h_sumsq = statOutput->registerField<NumberBase>("SumSQ");
173  h_count = statOutput->registerField<uint64_t> ("Count");
174  h_min = statOutput->registerField<NumberBase>("Min");
175  h_max = statOutput->registerField<NumberBase>("Max");
176  }
177 
178  void outputStatisticData(StatisticOutput* statOutput, bool UNUSED(EndOfSimFlag)) override
179  {
180  statOutput->outputField(h_sum, m_sum);
181  statOutput->outputField(h_sumsq, m_sum_sq);
182  statOutput->outputField(h_count, getCount());
183 
184  if( 0 == getCount() ) {
185  statOutput->outputField(h_min, 0);
186  statOutput->outputField(h_max, 0);
187  } else {
188  statOutput->outputField(h_min, m_min);
189  statOutput->outputField(h_max, m_max);
190  }
191  }
192 
193  bool isStatModeSupported(StatisticBase::StatMode_t mode) const override
194  {
195  if (mode == StatisticBase::STAT_MODE_COUNT) {
196  return true;
197  }
198  if (mode == StatisticBase::STAT_MODE_PERIODIC) {
199  return true;
200  }
201  return false;
202  }
203 
204 private:
205  NumberBase m_sum;
206  NumberBase m_sum_sq;
207  NumberBase m_min;
208  NumberBase m_max;
209 
210  StatisticOutput::fieldHandle_t h_sum;
211  StatisticOutput::fieldHandle_t h_sumsq;
212  StatisticOutput::fieldHandle_t h_count;
213  StatisticOutput::fieldHandle_t h_max;
214  StatisticOutput::fieldHandle_t h_min;
215 };
216 
217 
218 } //namespace Statistics
219 } //namespace SST
220 
221 #endif
void addData_impl(NumberBase value) override
Present a new value to the class to be included in the statistics.
Definition: stataccumulator.h:77
NumberBase getMin()
Provides the minimum value presented so far.
Definition: stataccumulator.h:108
void registerOutputFields(StatisticOutput *statOutput) override
Called by the system to tell the Statistic to register its output fields.
Definition: stataccumulator.h:169
Forms the base class for statistics output generation within the SST core.
Definition: statoutput.h:48
fieldHandle_t registerField(const char *fieldName)
Register a field to be output (templated function)
Definition: statoutput.h:89
Allows the online gathering of statistical information about a single quantity.
Definition: stataccumulator.h:47
uint64_t getCollectionCount() const
Return the current collection count.
Definition: statbase.h:149
void clearStatisticData() override
Inform the Statistic to clear its data.
Definition: stataccumulator.h:160
Forms the template defined base class for statistics gathering within SST.
Definition: elementinfo.h:43
NumberBase getMax()
Provides the maxmimum value presented so far.
Definition: stataccumulator.h:99
NumberBase getVariance()
Get the variance of the values presented so far.
Definition: stataccumulator.h:136
NumberBase getSumSquared()
Provides the sum of each value squared presented to the class so far.
Definition: stataccumulator.h:117
virtual void outputField(fieldHandle_t fieldHandle, int32_t data)
Output field data.
Main component object for the simulation.
Definition: baseComponent.h:52
StatMode_t
Statistic collection mode.
Definition: statbase.h:67
Parameter store.
Definition: params.h:45
NumberBase getSum()
Provides the sum of the values presented so far.
Definition: stataccumulator.h:90
uint64_t getCount()
Get a count of the number of elements presented to the statistics collection so far.
Definition: stataccumulator.h:155
virtual void setCollectionCount(uint64_t newCount)
Set the current collection count to a defined value.
Definition: statbase.cc:61
NumberBase getArithmeticMean()
Get the arithmetic mean of the values presented so far.
Definition: stataccumulator.h:126
NumberBase getStandardDeviation()
Get the standard deviation of the values presented so far.
Definition: stataccumulator.h:146