<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:43 CET 2013 -->
<title>WindowedMean (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WindowedMean (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/WindowedMean.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li>Next Class
</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/WindowedMean.html" target="_top">Frames
</a></li>
<li><a href="WindowedMean.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.math
</div>
<h2 title="Class WindowedMean" class="title">Class WindowedMean
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.math.WindowedMean
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class
<span class="strong">WindowedMean
</span>
extends java.lang.Object
</pre>
<div class="block">A simple class keeping track of the mean of a stream of values within a certain window. the WindowedMean will only return a
value in case enough data has been sampled. After enough data has been sampled the oldest sample will be replaced by the newest
in case a new sample is added.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>badlogicgames@gmail.com
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#WindowedMean(int)">WindowedMean
</a></strong>(int
window_size)
</code>
<div class="block">constructor, window_size specifies the number of samples we will continuously get the mean and variance from.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#addValue(float)">addValue
</a></strong>(float
value)
</code>
<div class="block">adds a new sample to this mean.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#clear()">clear
</a></strong>()
</code>
<div class="block">clears this WindowedMean.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#getLatest()">getLatest
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#getMean()">getMean
</a></strong>()
</code>
<div class="block">returns the mean of the samples added to this instance.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#getOldest()">getOldest
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#hasEnoughData()">hasEnoughData
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/math/WindowedMean.html#standardDeviation()">standardDeviation
</a></strong>()
</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="WindowedMean(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WindowedMean
</h4>
<pre>public
WindowedMean(int
window_size)
</pre>
<div class="block">constructor, window_size specifies the number of samples we will continuously get the mean and variance from. the class will
only return meaning full values if at least window_size values have been added.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>window_size
</code> - size of the sample window
</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="hasEnoughData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasEnoughData
</h4>
<pre>public
boolean
hasEnoughData()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>whether the value returned will be meaningfull
</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear
</h4>
<pre>public
void
clear()
</pre>
<div class="block">clears this WindowedMean. The class will only return meaningfull values after enough data has been added again.
</div>
</li>
</ul>
<a name="addValue(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValue
</h4>
<pre>public
void
addValue(float
value)
</pre>
<div class="block">adds a new sample to this mean. in case the window is full the oldest value will be replaced by this new value.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>value
</code> - The value to add
</dd></dl>
</li>
</ul>
<a name="getMean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMean
</h4>
<pre>public
float
getMean()
</pre>
<div class="block">returns the mean of the samples added to this instance. only returns meaningfull results when at least window_size samples
as specified in the constructor have been added.
</div>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the mean
</dd></dl>
</li>
</ul>
<a name="getOldest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOldest
</h4>
<pre>public
float
getOldest()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the oldest value in the window
</dd></dl>
</li>
</ul>
<a name="getLatest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLatest
</h4>
<pre>public
float
getLatest()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>the value last added
</dd></dl>
</li>
</ul>
<a name="standardDeviation()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>standardDeviation
</h4>
<pre>public
float
standardDeviation()
</pre>
<dl><dt><span class="strong">Returns:
</span></dt><dd>The standard deviation
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/WindowedMean.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math"><span class="strong">Prev Class
</span></a></li>
<li>Next Class
</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/math/WindowedMean.html" target="_top">Frames
</a></li>
<li><a href="WindowedMean.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>