Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / tomee-9.0 / javadoc / org / apache / openejb / math / stat / descriptive / moment / Mean.html
blob: d5b656075237e0a0db5ec4e59abb5cb17fd958cf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Mean</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Mean";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Kurtosis.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/SecondMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/openejb/math/stat/descriptive/moment/Mean.html" target="_top">Frames</a></li>
<li><a href="Mean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.openejb.math.stat.descriptive.moment</div>
<h2 title="Class Mean" class="title">Class Mean</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">org.apache.openejb.math.stat.descriptive.AbstractUnivariateStatistic</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">org.apache.openejb.math.stat.descriptive.AbstractStorelessUnivariateStatistic</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.math.stat.descriptive.moment.Mean</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html" title="interface in org.apache.openejb.math.stat.descriptive">WeightedEvaluation</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Mean</span>
extends <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a>
implements java.io.Serializable, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html" title="interface in org.apache.openejb.math.stat.descriptive">WeightedEvaluation</a></pre>
<div class="block"><p>Computes the arithmetic mean of a set of values. Uses the definitional
formula:</p>
<p>
mean = sum(x_i) / n
</p>
<p>where <code>n</code> is the number of observations.
</p>
<p>When <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#increment-double-"><code>increment(double)</code></a> is used to add data incrementally from a
stream of (unstored) values, the value of the statistic that
<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#getResult--"><code>getResult()</code></a> returns is computed using the following recursive
updating algorithm: </p>
<ol>
<li>Initialize <code>m = </code> the first value</li>
<li>For each additional value, update using <br>
<code>m = m + (new value - m) / (number of observations)</code></li>
</ol>
<p> If <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#evaluate-double:A-"><code>AbstractStorelessUnivariateStatistic.evaluate(double[])</code></a> is used to compute the mean of an array
of stored values, a two-pass, corrected algorithm is used, starting with
the definitional formula computed using the array of stored values and then
correcting this by adding the mean deviation of the data values from the
arithmetic mean. See, e.g. "Comparison of Several Algorithms for Computing
Sample Means and Variances," Robert F. Ling, Journal of the American
Statistical Association, Vol. 69, No. 348 (Dec., 1974), pp. 859-866. </p>
<p>
Returns <code>Double.NaN</code> if the dataset is empty.
</p>
<strong>Note that this implementation is not synchronized.</strong> If
multiple threads access an instance of this class concurrently, and at least
one of the threads invokes the <code>increment()</code> or
<code>clear()</code> method, it must be synchronized externally.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.openejb.math.stat.descriptive.moment.Mean">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#incMoment">incMoment</a></span></code>
<div class="block">Determines whether or not this statistic can be incremented or cleared.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/FirstMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment">FirstMoment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#moment">moment</a></span></code>
<div class="block">First moment on which this statistic is based.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#Mean--">Mean</a></span>()</code>
<div class="block">Constructs a Mean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#Mean-org.apache.openejb.math.stat.descriptive.moment.FirstMoment-">Mean</a></span>(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/FirstMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment">FirstMoment</a>&nbsp;m1)</code>
<div class="block">Constructs a Mean with an External Moment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#Mean-org.apache.openejb.math.stat.descriptive.moment.Mean-">Mean</a></span>(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;original)</code>
<div class="block">Copy constructor, creates a new <code>Mean</code> identical
to the <code>original</code></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#clear--">clear</a></span>()</code>
<div class="block">Clears the internal state of the Statistic</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#copy--">copy</a></span>()</code>
<div class="block">Returns a copy of the statistic with the same internal state.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#copy-org.apache.openejb.math.stat.descriptive.moment.Mean-org.apache.openejb.math.stat.descriptive.moment.Mean-">copy</a></span>(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;source,
<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;dest)</code>
<div class="block">Copies source to dest.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#evaluate-double:A-double:A-">evaluate</a></span>(double[]&nbsp;values,
double[]&nbsp;weights)</code>
<div class="block">Returns the weighted arithmetic mean of the entries in the input array.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#evaluate-double:A-double:A-int-int-">evaluate</a></span>(double[]&nbsp;values,
double[]&nbsp;weights,
int&nbsp;begin,
int&nbsp;length)</code>
<div class="block">Returns the weighted arithmetic mean of the entries in the specified portion of
the input array, or <code>Double.NaN</code> if the designated subarray
is empty.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#evaluate-double:A-int-int-">evaluate</a></span>(double[]&nbsp;values,
int&nbsp;begin,
int&nbsp;length)</code>
<div class="block">Returns the arithmetic mean of the entries in the specified portion of
the input array, or <code>Double.NaN</code> if the designated subarray
is empty.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#getN--">getN</a></span>()</code>
<div class="block">Returns the number of values that have been added.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#getResult--">getResult</a></span>()</code>
<div class="block">Returns the current value of the Statistic.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html#increment-double-">increment</a></span>(double&nbsp;d)</code>
<div class="block">Updates the internal state of the statistic to reflect the addition of the new value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.math.stat.descriptive.AbstractStorelessUnivariateStatistic">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openejb.math.stat.descriptive.<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></h3>
<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#evaluate-double:A-">evaluate</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#hashCode--">hashCode</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#incrementAll-double:A-">incrementAll</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#incrementAll-double:A-int-int-">incrementAll</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.math.stat.descriptive.AbstractUnivariateStatistic">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openejb.math.stat.descriptive.<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractUnivariateStatistic</a></h3>
<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#test-double:A-double:A-int-int-">test</a>, <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#test-double:A-int-int-">test</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="moment">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moment</h4>
<pre>protected&nbsp;<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/FirstMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment">FirstMoment</a> moment</pre>
<div class="block">First moment on which this statistic is based.</div>
</li>
</ul>
<a name="incMoment">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>incMoment</h4>
<pre>protected&nbsp;boolean incMoment</pre>
<div class="block">Determines whether or not this statistic can be incremented or cleared.
<p>
Statistics based on (constructed from) external moments cannot
be incremented or cleared.</p></div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Mean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mean</h4>
<pre>public&nbsp;Mean()</pre>
<div class="block">Constructs a Mean.</div>
</li>
</ul>
<a name="Mean-org.apache.openejb.math.stat.descriptive.moment.FirstMoment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mean</h4>
<pre>public&nbsp;Mean(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/FirstMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment">FirstMoment</a>&nbsp;m1)</pre>
<div class="block">Constructs a Mean with an External Moment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m1</code> - the moment</dd>
</dl>
</li>
</ul>
<a name="Mean-org.apache.openejb.math.stat.descriptive.moment.Mean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Mean</h4>
<pre>public&nbsp;Mean(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;original)</pre>
<div class="block">Copy constructor, creates a new <code>Mean</code> identical
to the <code>original</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>original</code> - the <code>Mean</code> instance to copy</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="increment-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>increment</h4>
<pre>public&nbsp;void&nbsp;increment(double&nbsp;d)</pre>
<div class="block">Updates the internal state of the statistic to reflect the addition of the new value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html#increment-double-">increment</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#increment-double-">increment</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - the new value.</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block">Clears the internal state of the Statistic</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html#clear--">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#clear--">clear</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></code></dd>
</dl>
</li>
</ul>
<a name="getResult--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResult</h4>
<pre>public&nbsp;double&nbsp;getResult()</pre>
<div class="block">Returns the current value of the Statistic.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html#getResult--">getResult</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#getResult--">getResult</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of the statistic, <code>Double.NaN</code> if it
has been cleared or just instantiated.</dd>
</dl>
</li>
</ul>
<a name="getN--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getN</h4>
<pre>public&nbsp;long&nbsp;getN()</pre>
<div class="block">Returns the number of values that have been added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html#getN--">getN</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of values.</dd>
</dl>
</li>
</ul>
<a name="evaluate-double:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public&nbsp;double&nbsp;evaluate(double[]&nbsp;values,
int&nbsp;begin,
int&nbsp;length)</pre>
<div class="block">Returns the arithmetic mean of the entries in the specified portion of
the input array, or <code>Double.NaN</code> if the designated subarray
is empty.
<p>
Throws <code>IllegalArgumentException</code> if the array is null.</p>
<p>
See <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><code>Mean</code></a> for details on the computing algorithm.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#evaluate-double:A-int-int-">evaluate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#evaluate-double:A-int-int-">evaluate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the input array</dd>
<dd><code>begin</code> - index of the first array element to include</dd>
<dd><code>length</code> - the number of elements to include</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mean of the values or Double.NaN if length = 0</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the array is null or the array index
parameters are not valid</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#evaluate-double:A-int-int-"><code>UnivariateStatistic.evaluate(double[], int, int)</code></a></dd>
</dl>
</li>
</ul>
<a name="evaluate-double:A-double:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public&nbsp;double&nbsp;evaluate(double[]&nbsp;values,
double[]&nbsp;weights,
int&nbsp;begin,
int&nbsp;length)</pre>
<div class="block">Returns the weighted arithmetic mean of the entries in the specified portion of
the input array, or <code>Double.NaN</code> if the designated subarray
is empty.
<p>
Throws <code>IllegalArgumentException</code> if either array is null.</p>
<p>
See <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><code>Mean</code></a> for details on the computing algorithm. The two-pass algorithm
described above is used here, with weights applied in computing both the original
estimate and the correction factor.</p>
<p>
Throws <code>IllegalArgumentException</code> if any of the following are true:
<ul><li>the values array is null</li>
<li>the weights array is null</li>
<li>the weights array does not have the same length as the values array</li>
<li>the weights array contains one or more infinite values</li>
<li>the weights array contains one or more NaN values</li>
<li>the weights array contains negative values</li>
<li>the start and length arguments do not determine a valid array</li>
</ul></p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html#evaluate-double:A-double:A-int-int-">evaluate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html" title="interface in org.apache.openejb.math.stat.descriptive">WeightedEvaluation</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the input array</dd>
<dd><code>weights</code> - the weights array</dd>
<dd><code>begin</code> - index of the first array element to include</dd>
<dd><code>length</code> - the number of elements to include</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mean of the values or Double.NaN if length = 0</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the parameters are not valid</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a name="evaluate-double:A-double:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>public&nbsp;double&nbsp;evaluate(double[]&nbsp;values,
double[]&nbsp;weights)</pre>
<div class="block">Returns the weighted arithmetic mean of the entries in the input array.
<p>
Throws <code>IllegalArgumentException</code> if either array is null.</p>
<p>
See <a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><code>Mean</code></a> for details on the computing algorithm. The two-pass algorithm
described above is used here, with weights applied in computing both the original
estimate and the correction factor.</p>
<p>
Throws <code>IllegalArgumentException</code> if any of the following are true:
<ul><li>the values array is null</li>
<li>the weights array is null</li>
<li>the weights array does not have the same length as the values array</li>
<li>the weights array contains one or more infinite values</li>
<li>the weights array contains one or more NaN values</li>
<li>the weights array contains negative values</li>
</ul></p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html#evaluate-double:A-double:A-">evaluate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/WeightedEvaluation.html" title="interface in org.apache.openejb.math.stat.descriptive">WeightedEvaluation</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - the input array</dd>
<dd><code>weights</code> - the weights array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the mean of the values or Double.NaN if length = 0</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the parameters are not valid</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;copy()</pre>
<div class="block">Returns a copy of the statistic with the same internal state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html#copy--">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/StorelessUnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">StorelessUnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#copy--">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html#copy--">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of the statistic</dd>
</dl>
</li>
</ul>
<a name="copy-org.apache.openejb.math.stat.descriptive.moment.Mean-org.apache.openejb.math.stat.descriptive.moment.Mean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copy</h4>
<pre>public static&nbsp;void&nbsp;copy(<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;source,
<a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Mean.html" title="class in org.apache.openejb.math.stat.descriptive.moment">Mean</a>&nbsp;dest)</pre>
<div class="block">Copies source to dest.
<p>Neither source nor dest can be null.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - Mean to copy</dd>
<dd><code>dest</code> - Mean to copy to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either source or dest is null</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/Kurtosis.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/openejb/math/stat/descriptive/moment/SecondMoment.html" title="class in org.apache.openejb.math.stat.descriptive.moment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/openejb/math/stat/descriptive/moment/Mean.html" target="_top">Frames</a></li>
<li><a href="Mean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>