always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
33ac01904cf71f34a4bb46bb160fb5eb0b168556
ortools-clone/docs/cpp/running__stat_8h_source.html
Mizux Seiha 17edcf0e25 Update doc
2021-09-30 01:28:18 +02:00

319 lines
44 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: running_stat.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('running__stat_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle"><div class="title">running_stat.h</div></div>
</div><!--header-->
<div class="contents">
<a href="running__stat_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_UTIL_RUNNING_STAT_H_</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_UTIL_RUNNING_STAT_H_</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;deque&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &quot;<a class="code" href="base_2logging_8h.html">ortools/base/logging.h</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &quot;<a class="code" href="macros_8h.html">ortools/base/macros.h</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">// Simple class to compute the average over a fixed size window of an integer</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">// stream.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html"> 26</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1_running_average.html">RunningAverage</a> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Initialize the class with the maximum window size.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// It must be positive (this is CHECKed).</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#afa981bdb0486c0373c864d3f5dbd2aff">RunningAverage</a>(<span class="keywordtype">int</span> window_size = 1);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Resets the class to the exact same state as if it was just constructed with</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// the given window size.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a7adffacaf51777a81f9d3ff4e95cfd7b">Reset</a>(<span class="keywordtype">int</span> window_size);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Adds the next integer of the stream.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a925b6233d6cc9970b8f5bba800e9a3eb">Add</a>(<span class="keywordtype">int</span> <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// Returns the average of all the values added so far or zero if no values</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// where added.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#abe7238c645e1aeac09a33b1291357486">GlobalAverage</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Returns the average of the values in the current window or zero if the</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// current window is empty.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a240c66108d94a6cf475664188437b3b0">WindowAverage</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// Returns true iff the current window size is equal to the one specified in</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// the constructor.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a9cc27103c6a070bad6dcaea6df83e7ff">IsWindowFull</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Clears the current window.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af">ClearWindow</a>();</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">int</span> window_size_;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">int</span> num_adds_;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">double</span> global_sum_;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">double</span> local_sum_;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::deque&lt;int&gt; values_;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> DISALLOW_COPY_AND_ASSIGN(<a class="code hl_class" href="classoperations__research_1_1_running_average.html">RunningAverage</a>);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>};</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">// Simple class to compute efficiently the maximum over a fixed size window</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">// of a numeric stream. This works in constant average amortized time.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Number = <span class="keywordtype">double</span>&gt;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_max.html"> 67</a></span><span class="keyword">class </span><a class="code hl_class" href="classoperations__research_1_1_running_max.html">RunningMax</a> {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// Takes the size of the running window. The size must be positive.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classoperations__research_1_1_running_max.html#a63a56975bcedbeedab335b57120ba347">RunningMax</a>(<span class="keywordtype">int</span> window_size);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// Processes a new element from the stream.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_max.html#a1ed075521e3d3b2244477ff951d5f3d0">Add</a>(Number <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// Returns the current maximum element in the window.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// An element must have been added before calling this function.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> Number <a class="code hl_function" href="classoperations__research_1_1_running_max.html#a41a56fe5e55123cb36aae1a4d0f709c4">GetCurrentMax</a>();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">const</span> <span class="keywordtype">int</span> window_size_;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Values in the current window.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> std::vector&lt;Number&gt; values_;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// Index of the last added element in the window.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">int</span> last_index_;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// Index of the current maximum element.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">int</span> max_index_;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> DISALLOW_COPY_AND_ASSIGN(<a class="code hl_class" href="classoperations__research_1_1_running_max.html">RunningMax</a>);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>};</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment">// ################## Implementations below #####################</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#afa981bdb0486c0373c864d3f5dbd2aff"> 96</a></span><span class="keyword">inline</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#afa981bdb0486c0373c864d3f5dbd2aff">RunningAverage::RunningAverage</a>(<span class="keywordtype">int</span> window_size)</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> : window_size_(window_size),</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> num_adds_(0),</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> global_sum_(0.0),</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> local_sum_(0.0) {</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_define" href="base_2logging_8h.html#a7e03ec13560fa94a8fea569960d7efc6">CHECK_GT</a>(window_size_, 0);</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>}</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#a7adffacaf51777a81f9d3ff4e95cfd7b"> 104</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a7adffacaf51777a81f9d3ff4e95cfd7b">RunningAverage::Reset</a>(<span class="keywordtype">int</span> window_size) {</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> window_size_ = window_size;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> num_adds_ = 0;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> global_sum_ = 0.0;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af">ClearWindow</a>();</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>}</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#a925b6233d6cc9970b8f5bba800e9a3eb"> 111</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a925b6233d6cc9970b8f5bba800e9a3eb">RunningAverage::Add</a>(<span class="keywordtype">int</span> <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>) {</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> ++num_adds_;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> global_sum_ += <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> local_sum_ += <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> values_.push_back(<a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordflow">if</span> (values_.size() &gt; window_size_) {</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> local_sum_ -= values_.front();</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> values_.pop_front();</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> }</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>}</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#abe7238c645e1aeac09a33b1291357486"> 122</a></span><span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#abe7238c645e1aeac09a33b1291357486">RunningAverage::GlobalAverage</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keywordflow">return</span> num_adds_ == 0 ? 0.0 : global_sum_ / <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(num_adds_);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span>}</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#a240c66108d94a6cf475664188437b3b0"> 126</a></span><span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a240c66108d94a6cf475664188437b3b0">RunningAverage::WindowAverage</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">return</span> values_.empty() ? 0.0</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> : local_sum_ / <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(values_.size());</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>}</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af"> 131</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af">RunningAverage::ClearWindow</a>() {</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> local_sum_ = 0.0;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> values_.clear();</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>}</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_average.html#a9cc27103c6a070bad6dcaea6df83e7ff"> 136</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classoperations__research_1_1_running_average.html#a9cc27103c6a070bad6dcaea6df83e7ff">RunningAverage::IsWindowFull</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordflow">return</span> values_.size() == window_size_;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>}</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Number&gt;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_max.html#a63a56975bcedbeedab335b57120ba347"> 141</a></span><a class="code hl_function" href="classoperations__research_1_1_running_max.html#a63a56975bcedbeedab335b57120ba347">RunningMax&lt;Number&gt;::RunningMax</a>(<span class="keywordtype">int</span> window_size)</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> : window_size_(window_size), values_(), last_index_(0), max_index_(0) {</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <a class="code hl_define" href="base_2logging_8h.html#ab4f56aa24c4c9cddc47a6abd2d747f9a">DCHECK_GT</a>(window_size, 0);</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span>}</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Number&gt;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_max.html#a1ed075521e3d3b2244477ff951d5f3d0"> 147</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classoperations__research_1_1_running_max.html#a1ed075521e3d3b2244477ff951d5f3d0">RunningMax&lt;Number&gt;::Add</a>(Number <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>) {</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keywordflow">if</span> (values_.size() &lt; window_size_) {</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="comment">// Starting phase until values_ reaches its final size.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <span class="comment">// Note that last_index_ stays at 0 during this phase.</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordflow">if</span> (values_.empty() || <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> &gt;= GetCurrentMax()) {</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> max_index_ = values_.size();</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> }</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> values_.push_back(<a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>);</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> }</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="comment">// We are in the steady state.</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <a class="code hl_define" href="base_2logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0">DCHECK_EQ</a>(values_.size(), window_size_);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <span class="comment">// Note the use of &gt;= instead of &gt; to get the O(1) behavior in presence of</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <span class="comment">// many identical values.</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a> &gt;= GetCurrentMax()) {</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> max_index_ = last_index_;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> values_[last_index_] = <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>;</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> values_[last_index_] = <a class="code hl_variable" href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a>;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keywordflow">if</span> (last_index_ == max_index_) {</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="comment">// We need to recompute the max.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="comment">// Note that this happens only if value was strictly lower than</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="comment">// GetCurrentMax() in the last window_size_ updates.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> max_index_ = 0;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> Number max_value = values_[max_index_];</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i &lt; values_.size(); ++i) {</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keywordflow">if</span> (values_[i] &gt; max_value) {</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> max_value = values_[i];</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> max_index_ = i;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> }</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> }</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> }</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> }</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keywordflow">if</span> (++last_index_ == window_size_) {</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> last_index_ = 0;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> }</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span>}</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Number&gt;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classoperations__research_1_1_running_max.html#a41a56fe5e55123cb36aae1a4d0f709c4"> 186</a></span>Number <a class="code hl_function" href="classoperations__research_1_1_running_max.html#a41a56fe5e55123cb36aae1a4d0f709c4">RunningMax&lt;Number&gt;::GetCurrentMax</a>() {</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <a class="code hl_define" href="base_2logging_8h.html#ae17f8119c108cf3070bad3449c7e0006">DCHECK</a>(!values_.empty());</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">return</span> values_[max_index_];</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>}</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span>} <span class="comment">// namespace operations_research</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_UTIL_RUNNING_STAT_H_</span></div>
<div class="ttc" id="abase_2logging_8h_html"><div class="ttname"><a href="base_2logging_8h.html">logging.h</a></div></div>
<div class="ttc" id="abase_2logging_8h_html_a7e03ec13560fa94a8fea569960d7efc6"><div class="ttname"><a href="base_2logging_8h.html#a7e03ec13560fa94a8fea569960d7efc6">CHECK_GT</a></div><div class="ttdeci">#define CHECK_GT(val1, val2)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00703">base/logging.h:703</a></div></div>
<div class="ttc" id="abase_2logging_8h_html_ab4f56aa24c4c9cddc47a6abd2d747f9a"><div class="ttname"><a href="base_2logging_8h.html#ab4f56aa24c4c9cddc47a6abd2d747f9a">DCHECK_GT</a></div><div class="ttdeci">#define DCHECK_GT(val1, val2)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00891">base/logging.h:891</a></div></div>
<div class="ttc" id="abase_2logging_8h_html_ae17f8119c108cf3070bad3449c7e0006"><div class="ttname"><a href="base_2logging_8h.html#ae17f8119c108cf3070bad3449c7e0006">DCHECK</a></div><div class="ttdeci">#define DCHECK(condition)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00885">base/logging.h:885</a></div></div>
<div class="ttc" id="abase_2logging_8h_html_ae89df3243bbb8341130c7b3f44145ea0"><div class="ttname"><a href="base_2logging_8h.html#ae89df3243bbb8341130c7b3f44145ea0">DCHECK_EQ</a></div><div class="ttdeci">#define DCHECK_EQ(val1, val2)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00886">base/logging.h:886</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html"><div class="ttname"><a href="classoperations__research_1_1_running_average.html">operations_research::RunningAverage</a></div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00026">running_stat.h:26</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_a240c66108d94a6cf475664188437b3b0"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#a240c66108d94a6cf475664188437b3b0">operations_research::RunningAverage::WindowAverage</a></div><div class="ttdeci">double WindowAverage() const</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00126">running_stat.h:126</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_a7adffacaf51777a81f9d3ff4e95cfd7b"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#a7adffacaf51777a81f9d3ff4e95cfd7b">operations_research::RunningAverage::Reset</a></div><div class="ttdeci">void Reset(int window_size)</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00104">running_stat.h:104</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_a8b0ef188b9f416aa368e07c94a9dd1af"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af">operations_research::RunningAverage::ClearWindow</a></div><div class="ttdeci">void ClearWindow()</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00131">running_stat.h:131</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_a925b6233d6cc9970b8f5bba800e9a3eb"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#a925b6233d6cc9970b8f5bba800e9a3eb">operations_research::RunningAverage::Add</a></div><div class="ttdeci">void Add(int value)</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00111">running_stat.h:111</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_a9cc27103c6a070bad6dcaea6df83e7ff"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#a9cc27103c6a070bad6dcaea6df83e7ff">operations_research::RunningAverage::IsWindowFull</a></div><div class="ttdeci">bool IsWindowFull() const</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00136">running_stat.h:136</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_abe7238c645e1aeac09a33b1291357486"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#abe7238c645e1aeac09a33b1291357486">operations_research::RunningAverage::GlobalAverage</a></div><div class="ttdeci">double GlobalAverage() const</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00122">running_stat.h:122</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_average_html_afa981bdb0486c0373c864d3f5dbd2aff"><div class="ttname"><a href="classoperations__research_1_1_running_average.html#afa981bdb0486c0373c864d3f5dbd2aff">operations_research::RunningAverage::RunningAverage</a></div><div class="ttdeci">RunningAverage(int window_size=1)</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00096">running_stat.h:96</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_max_html"><div class="ttname"><a href="classoperations__research_1_1_running_max.html">operations_research::RunningMax</a></div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00067">running_stat.h:67</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_max_html_a1ed075521e3d3b2244477ff951d5f3d0"><div class="ttname"><a href="classoperations__research_1_1_running_max.html#a1ed075521e3d3b2244477ff951d5f3d0">operations_research::RunningMax::Add</a></div><div class="ttdeci">void Add(Number value)</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00147">running_stat.h:147</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_max_html_a41a56fe5e55123cb36aae1a4d0f709c4"><div class="ttname"><a href="classoperations__research_1_1_running_max.html#a41a56fe5e55123cb36aae1a4d0f709c4">operations_research::RunningMax::GetCurrentMax</a></div><div class="ttdeci">Number GetCurrentMax()</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00186">running_stat.h:186</a></div></div>
<div class="ttc" id="aclassoperations__research_1_1_running_max_html_a63a56975bcedbeedab335b57120ba347"><div class="ttname"><a href="classoperations__research_1_1_running_max.html#a63a56975bcedbeedab335b57120ba347">operations_research::RunningMax::RunningMax</a></div><div class="ttdeci">RunningMax(int window_size)</div><div class="ttdef"><b>Definition:</b> <a href="running__stat_8h_source.html#l00141">running_stat.h:141</a></div></div>
<div class="ttc" id="ademon__profiler_8cc_html_ac072af30c4ffbc834bb4c681f6ecb514"><div class="ttname"><a href="demon__profiler_8cc.html#ac072af30c4ffbc834bb4c681f6ecb514">value</a></div><div class="ttdeci">int64_t value</div><div class="ttdef"><b>Definition:</b> <a href="demon__profiler_8cc_source.html#l00044">demon_profiler.cc:44</a></div></div>
<div class="ttc" id="amacros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div></div>
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="running__stat_8h.html">running_stat.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink