Files
ortools-clone/docs/cpp/classoperations__research_1_1_running_average.html

327 lines
14 KiB
HTML
Raw Normal View History

2020-09-01 16:00:33 +02:00
<!-- 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"/>
2022-01-17 21:42:14 +01:00
<meta name="generator" content="Doxygen 1.9.3"/>
2020-09-01 16:00:33 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: RunningAverage</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
2022-03-04 00:11:33 +01:00
&#160;<span id="projectnumber">9.3</span>
2020-09-01 16:00:33 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2022-01-17 21:42:14 +01:00
<!-- Generated by Doxygen 1.9.3 -->
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
2020-09-01 16:00:33 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2020-09-01 16:00:33 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-17 21:42:14 +01:00
/* @license-end */
</script>
2020-09-01 16:00:33 +02:00
<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">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classoperations__research_1_1_running_average.html',''); initResizable(); });
2020-09-01 16:00:33 +02:00
/* @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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
2020-10-09 12:00:09 +02:00
<a href="classoperations__research_1_1_running_average-members.html">List of all members</a> </div>
2022-01-17 21:42:14 +01:00
<div class="headertitle"><div class="title">RunningAverage</div></div>
2020-09-01 16:00:33 +02:00
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00026">26</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div><table class="memberdecls">
2022-01-17 21:42:14 +01:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
2020-09-01 16:00:33 +02:00
Public Member Functions</h2></td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:afa981bdb0486c0373c864d3f5dbd2aff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#afa981bdb0486c0373c864d3f5dbd2aff">RunningAverage</a> (int window_size=1)</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:afa981bdb0486c0373c864d3f5dbd2aff"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:a7adffacaf51777a81f9d3ff4e95cfd7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#a7adffacaf51777a81f9d3ff4e95cfd7b">Reset</a> (int window_size)</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:a7adffacaf51777a81f9d3ff4e95cfd7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
2022-03-04 00:11:33 +01:00
<tr class="memitem:a925b6233d6cc9970b8f5bba800e9a3eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#a925b6233d6cc9970b8f5bba800e9a3eb">Add</a> (int <a class="el" href="primal__dual__hybrid__gradient_8cc.html#a730b1ea892f1f794d9bd5f16027acb63">value</a>)</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:a925b6233d6cc9970b8f5bba800e9a3eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:abe7238c645e1aeac09a33b1291357486"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#abe7238c645e1aeac09a33b1291357486">GlobalAverage</a> () const</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:abe7238c645e1aeac09a33b1291357486"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:a240c66108d94a6cf475664188437b3b0"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#a240c66108d94a6cf475664188437b3b0">WindowAverage</a> () const</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:a240c66108d94a6cf475664188437b3b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:a9cc27103c6a070bad6dcaea6df83e7ff"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#a9cc27103c6a070bad6dcaea6df83e7ff">IsWindowFull</a> () const</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:a9cc27103c6a070bad6dcaea6df83e7ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-10-09 12:00:09 +02:00
<tr class="memitem:a8b0ef188b9f416aa368e07c94a9dd1af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1_running_average.html#a8b0ef188b9f416aa368e07c94a9dd1af">ClearWindow</a> ()</td></tr>
2020-09-01 16:00:33 +02:00
<tr class="separator:a8b0ef188b9f416aa368e07c94a9dd1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
2022-01-17 21:42:14 +01:00
<a id="afa981bdb0486c0373c864d3f5dbd2aff" name="afa981bdb0486c0373c864d3f5dbd2aff"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#afa981bdb0486c0373c864d3f5dbd2aff">&#9670;&nbsp;</a></span>RunningAverage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2020-10-09 12:00:09 +02:00
<td class="memname"><a class="el" href="classoperations__research_1_1_running_average.html">RunningAverage</a> </td>
2020-09-01 16:00:33 +02:00
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>window_size</em> = <code>1</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00096">96</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
2022-01-17 21:42:14 +01:00
<a id="a925b6233d6cc9970b8f5bba800e9a3eb" name="a925b6233d6cc9970b8f5bba800e9a3eb"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a925b6233d6cc9970b8f5bba800e9a3eb">&#9670;&nbsp;</a></span>Add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Add </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00111">111</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
2022-01-17 21:42:14 +01:00
<a id="a8b0ef188b9f416aa368e07c94a9dd1af" name="a8b0ef188b9f416aa368e07c94a9dd1af"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a8b0ef188b9f416aa368e07c94a9dd1af">&#9670;&nbsp;</a></span>ClearWindow()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ClearWindow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00131">131</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
2022-01-17 21:42:14 +01:00
<a id="abe7238c645e1aeac09a33b1291357486" name="abe7238c645e1aeac09a33b1291357486"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#abe7238c645e1aeac09a33b1291357486">&#9670;&nbsp;</a></span>GlobalAverage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double GlobalAverage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00122">122</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
2022-01-17 21:42:14 +01:00
<a id="a9cc27103c6a070bad6dcaea6df83e7ff" name="a9cc27103c6a070bad6dcaea6df83e7ff"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a9cc27103c6a070bad6dcaea6df83e7ff">&#9670;&nbsp;</a></span>IsWindowFull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsWindowFull </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00136">136</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
2022-01-17 21:42:14 +01:00
<a id="a7adffacaf51777a81f9d3ff4e95cfd7b" name="a7adffacaf51777a81f9d3ff4e95cfd7b"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a7adffacaf51777a81f9d3ff4e95cfd7b">&#9670;&nbsp;</a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Reset </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>window_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00104">104</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
2022-01-17 21:42:14 +01:00
<a id="a240c66108d94a6cf475664188437b3b0" name="a240c66108d94a6cf475664188437b3b0"></a>
2020-09-01 16:00:33 +02:00
<h2 class="memtitle"><span class="permalink"><a href="#a240c66108d94a6cf475664188437b3b0">&#9670;&nbsp;</a></span>WindowAverage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double WindowAverage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="running__stat_8h_source.html#l00126">126</a> of file <a class="el" href="running__stat_8h_source.html">running_stat.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="running__stat_8h_source.html">running_stat.h</a></li>
</ul>
</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>
2020-10-09 12:00:09 +02:00
<li class="navelem"><a class="el" href="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1_running_average.html">RunningAverage</a></li>
2020-09-01 16:00:33 +02:00
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
2022-01-17 21:42:14 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
2020-09-01 16:00:33 +02:00
</ul>
</div>
</body>
</html>