ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1DecayingSample.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

386 lines
21 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::DecayingSample&lt; Window, Clock &gt; Class Template Reference</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="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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1DecayingSample.html">DecayingSample</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1DecayingSample-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::DecayingSample&lt; Window, Clock &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Sampling function using exponential decay to provide a continuous value.
<a href="classripple_1_1DecayingSample.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0ae9c6057c3e868399f8cc1d07bca635" id="r_a0ae9c6057c3e868399f8cc1d07bca635"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a> = typename Clock::duration::rep</td></tr>
<tr class="separator:a0ae9c6057c3e868399f8cc1d07bca635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a901436f0dac882f0d1b53d99bbd77937" id="r_a901436f0dac882f0d1b53d99bbd77937"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> = typename Clock::time_point</td></tr>
<tr class="separator:a901436f0dac882f0d1b53d99bbd77937"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe1d19ee0af1f06ec16bbcb9d72d83fc" id="r_abe1d19ee0af1f06ec16bbcb9d72d83fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#abe1d19ee0af1f06ec16bbcb9d72d83fc">DecayingSample</a> ()=delete</td></tr>
<tr class="separator:abe1d19ee0af1f06ec16bbcb9d72d83fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f7df15dc3181f3043527b4aff1cad7d" id="r_a2f7df15dc3181f3043527b4aff1cad7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a2f7df15dc3181f3043527b4aff1cad7d">DecayingSample</a> (<a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> now)</td></tr>
<tr class="separator:a2f7df15dc3181f3043527b4aff1cad7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50fc616b35ac6589ed3af61baf9e1dec" id="r_a50fc616b35ac6589ed3af61baf9e1dec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a50fc616b35ac6589ed3af61baf9e1dec">add</a> (<a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a> <a class="el" href="classripple_1_1DecayingSample.html#aa592c9a4ac598241e496d8962caaf6f0">value</a>, <a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> now)</td></tr>
<tr class="memdesc:a50fc616b35ac6589ed3af61baf9e1dec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new sample. <br /></td></tr>
<tr class="separator:a50fc616b35ac6589ed3af61baf9e1dec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa592c9a4ac598241e496d8962caaf6f0" id="r_aa592c9a4ac598241e496d8962caaf6f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#aa592c9a4ac598241e496d8962caaf6f0">value</a> (<a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> now)</td></tr>
<tr class="memdesc:aa592c9a4ac598241e496d8962caaf6f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the current value in normalized units. <br /></td></tr>
<tr class="separator:aa592c9a4ac598241e496d8962caaf6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a272fa376fd4d4a876d2ff2f6fdca4ec7" id="r_a272fa376fd4d4a876d2ff2f6fdca4ec7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a272fa376fd4d4a876d2ff2f6fdca4ec7">decay</a> (<a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> now)</td></tr>
<tr class="separator:a272fa376fd4d4a876d2ff2f6fdca4ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ab9d9cd155bd1388fdb683ba35e1cec2a" id="r_ab9d9cd155bd1388fdb683ba35e1cec2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#ab9d9cd155bd1388fdb683ba35e1cec2a">m_value</a></td></tr>
<tr class="separator:ab9d9cd155bd1388fdb683ba35e1cec2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b925abb3876f5e45392bcc96e8511cf" id="r_a6b925abb3876f5e45392bcc96e8511cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1DecayingSample.html#a6b925abb3876f5e45392bcc96e8511cf">m_when</a></td></tr>
<tr class="separator:a6b925abb3876f5e45392bcc96e8511cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;int Window, typename Clock&gt;<br />
class ripple::DecayingSample&lt; Window, Clock &gt;</div><p>Sampling function using exponential decay to provide a continuous value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">The</td><td>number of seconds in the decay window. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00013">13</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0ae9c6057c3e868399f8cc1d07bca635" name="a0ae9c6057c3e868399f8cc1d07bca635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae9c6057c3e868399f8cc1d07bca635">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::value_type = typename Clock::duration::rep</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00016">16</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<a id="a901436f0dac882f0d1b53d99bbd77937" name="a901436f0dac882f0d1b53d99bbd77937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a901436f0dac882f0d1b53d99bbd77937">&#9670;&#160;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::time_point = typename Clock::time_point</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00017">17</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abe1d19ee0af1f06ec16bbcb9d72d83fc" name="abe1d19ee0af1f06ec16bbcb9d72d83fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1d19ee0af1f06ec16bbcb9d72d83fc">&#9670;&#160;</a></span>DecayingSample() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::DecayingSample </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2f7df15dc3181f3043527b4aff1cad7d" name="a2f7df15dc3181f3043527b4aff1cad7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f7df15dc3181f3043527b4aff1cad7d">&#9670;&#160;</a></span>DecayingSample() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::DecayingSample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a>&#160;</td>
<td class="paramname"><em>now</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">now</td><td>Start time of <a class="el" href="classripple_1_1DecayingSample.html" title="Sampling function using exponential decay to provide a continuous value.">DecayingSample</a>. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00024">24</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a50fc616b35ac6589ed3af61baf9e1dec" name="a50fc616b35ac6589ed3af61baf9e1dec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50fc616b35ac6589ed3af61baf9e1dec">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a> <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a>&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a>&#160;</td>
<td class="paramname"><em>now</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new sample. </p>
<p>The value is first aged according to the specified time. </p>
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00032">32</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<a id="aa592c9a4ac598241e496d8962caaf6f0" name="aa592c9a4ac598241e496d8962caaf6f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa592c9a4ac598241e496d8962caaf6f0">&#9670;&#160;</a></span>value()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a> <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a>&#160;</td>
<td class="paramname"><em>now</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current value in normalized units. </p>
<p>The samples are first aged according to the specified time. </p>
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00043">43</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<a id="a272fa376fd4d4a876d2ff2f6fdca4ec7" name="a272fa376fd4d4a876d2ff2f6fdca4ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a272fa376fd4d4a876d2ff2f6fdca4ec7">&#9670;&#160;</a></span>decay()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::decay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a>&#160;</td>
<td class="paramname"><em>now</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00052">52</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab9d9cd155bd1388fdb683ba35e1cec2a" name="ab9d9cd155bd1388fdb683ba35e1cec2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9d9cd155bd1388fdb683ba35e1cec2a">&#9670;&#160;</a></span>m_value</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html#a0ae9c6057c3e868399f8cc1d07bca635">value_type</a> <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::m_value</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00081">81</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
<a id="a6b925abb3876f5e45392bcc96e8511cf" name="a6b925abb3876f5e45392bcc96e8511cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b925abb3876f5e45392bcc96e8511cf">&#9670;&#160;</a></span>m_when</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int Window, typename Clock &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1DecayingSample.html#a901436f0dac882f0d1b53d99bbd77937">time_point</a> <a class="el" href="classripple_1_1DecayingSample.html">ripple::DecayingSample</a>&lt; Window, Clock &gt;::m_when</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="DecayingSample_8h_source.html#l00084">84</a> of file <a class="el" href="DecayingSample_8h_source.html">DecayingSample.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink