gem5  v21.1.0.2
Histogram.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef __MEM_RUBY_COMMON_HISTOGRAM_HH__
30 #define __MEM_RUBY_COMMON_HISTOGRAM_HH__
31 
32 #include <iostream>
33 #include <vector>
34 
36 
37 namespace gem5
38 {
39 
40 namespace ruby
41 {
42 
43 class Histogram
44 {
45  public:
46  Histogram(int binsize = 1, uint32_t bins = 50);
47  ~Histogram();
48 
49  void add(int64_t value);
50  void add(Histogram& hist);
51  void doubleBinSize();
52 
53  void clear() { clear(m_data.size()); }
54  void clear(uint32_t bins);
55  void clear(int binsize, uint32_t bins);
56 
57  uint64_t size() const { return m_count; }
58  uint32_t getBins() const { return m_data.size(); }
59  int getBinSize() const { return m_binsize; }
60  int64_t getTotal() const { return m_sumSamples; }
61  uint64_t getSquaredTotal() const { return m_sumSquaredSamples; }
62  uint64_t getData(int index) const { return m_data[index]; }
63  int64_t getMax() const { return m_max; }
64 
65  void printWithMultiplier(std::ostream& out, double multiplier) const;
66  void printPercent(std::ostream& out) const;
67  void print(std::ostream& out) const;
68 
69 private:
71  int64_t m_max; // the maximum value seen so far
72  uint64_t m_count; // the number of elements added
73  int m_binsize; // the size of each bucket
74  uint32_t m_largest_bin; // the largest bin used
75 
76  int64_t m_sumSamples; // the sum of all samples
77  uint64_t m_sumSquaredSamples; // the sum of the square of all samples
78 
79  double getStandardDeviation() const;
80 };
81 
82 bool node_less_then_eq(const Histogram* n1, const Histogram* n2);
83 
84 inline std::ostream&
85 operator<<(std::ostream& out, const Histogram& obj)
86 {
87  obj.print(out);
88  out << std::flush;
89  return out;
90 }
91 
92 } // namespace ruby
93 } // namespace gem5
94 
95 #endif // __MEM_RUBY_COMMON_HISTOGRAM_HH__
gem5::ruby::Histogram::m_largest_bin
uint32_t m_largest_bin
Definition: Histogram.hh:74
gem5::ruby::Histogram::clear
void clear()
Definition: Histogram.hh:53
gem5::ruby::Histogram::getTotal
int64_t getTotal() const
Definition: Histogram.hh:60
gem5::ruby::Histogram::m_data
std::vector< uint64_t > m_data
Definition: Histogram.hh:70
gem5::ruby::Histogram::m_count
uint64_t m_count
Definition: Histogram.hh:72
gem5::MipsISA::index
Bitfield< 30, 0 > index
Definition: pra_constants.hh:47
gem5::ruby::operator<<
std::ostream & operator<<(std::ostream &os, const BoolVec &myvector)
Definition: BoolVec.cc:49
gem5::ruby::Histogram::add
void add(int64_t value)
Definition: Histogram.cc:93
gem5::ruby::Histogram::m_max
int64_t m_max
Definition: Histogram.hh:71
std::vector< uint64_t >
gem5::ruby::Histogram::getStandardDeviation
double getStandardDeviation() const
Definition: Histogram.cc:181
gem5::ruby::Histogram::m_sumSquaredSamples
uint64_t m_sumSquaredSamples
Definition: Histogram.hh:77
gem5::ruby::Histogram::getBinSize
int getBinSize() const
Definition: Histogram.hh:59
gem5::ruby::Histogram::printWithMultiplier
void printWithMultiplier(std::ostream &out, double multiplier) const
Definition: Histogram.cc:209
gem5::ruby::Histogram::m_binsize
int m_binsize
Definition: Histogram.hh:73
gem5::ruby::Histogram::getData
uint64_t getData(int index) const
Definition: Histogram.hh:62
gem5::ruby::Histogram::printPercent
void printPercent(std::ostream &out) const
Definition: Histogram.cc:199
gem5::ruby::Histogram::m_sumSamples
int64_t m_sumSamples
Definition: Histogram.hh:76
TypeDefines.hh
gem5::ruby::Histogram::getMax
int64_t getMax() const
Definition: Histogram.hh:63
gem5::ruby::Histogram::doubleBinSize
void doubleBinSize()
Definition: Histogram.cc:77
gem5::ruby::Histogram
Definition: Histogram.hh:43
gem5::ruby::Histogram::~Histogram
~Histogram()
Definition: Histogram.cc:49
gem5::ruby::Histogram::Histogram
Histogram(int binsize=1, uint32_t bins=50)
Definition: Histogram.cc:43
gem5::ruby::Histogram::getBins
uint32_t getBins() const
Definition: Histogram.hh:58
gem5::ruby::Histogram::size
uint64_t size() const
Definition: Histogram.hh:57
gem5::ruby::node_less_then_eq
bool node_less_then_eq(const Histogram *n1, const Histogram *n2)
Definition: Histogram.cc:239
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ruby::Histogram::print
void print(std::ostream &out) const
Definition: Histogram.cc:193
gem5::ruby::Histogram::getSquaredTotal
uint64_t getSquaredTotal() const
Definition: Histogram.hh:61

Generated on Tue Sep 21 2021 12:25:37 for gem5 by doxygen 1.8.17