diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html | 1332 |
1 files changed, 1332 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html new file mode 100644 index 0000000..8da9559 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html @@ -0,0 +1,1332 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DescriptiveStatistics (Apache Commons Math 3.6.1 API)</title> +<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="DescriptiveStatistics (Apache Commons Math 3.6.1 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/DescriptiveStatistics.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><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AggregateSummaryStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/descriptive/MultivariateSummaryStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" target="_top">Frames</a></li> +<li><a href="DescriptiveStatistics.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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">org.apache.commons.math3.stat.descriptive</div> +<h2 title="Class DescriptiveStatistics" class="title">Class DescriptiveStatistics</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.stat.descriptive.DescriptiveStatistics</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/stat/descriptive/SynchronizedDescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">SynchronizedDescriptiveStatistics</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DescriptiveStatistics</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">Maintains a dataset of values of a single variable and computes descriptive + statistics based on stored data. The <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getWindowSize()"><code>windowSize</code></a> + property sets a limit on the number of values that can be stored in the + dataset. The default value, INFINITE_WINDOW, puts no limit on the size of + the dataset. This value should be used with caution, as the backing store + will grow without bound in this case. For very large datasets, + <a href="../../../../../../org/apache/commons/math3/stat/descriptive/SummaryStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><code>SummaryStatistics</code></a>, which does not store the dataset, should be used + instead of this class. If <code>windowSize</code> is not INFINITE_WINDOW and + more values are added than can be stored in the dataset, new values are + added in a "rolling" manner, with new values replacing the "oldest" values + in the dataset. + + <p>Note: this class is not threadsafe. Use + <a href="../../../../../../org/apache/commons/math3/stat/descriptive/SynchronizedDescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><code>SynchronizedDescriptiveStatistics</code></a> if concurrent access from multiple + threads is required.</p></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../serialized-form.html#org.apache.commons.math3.stat.descriptive.DescriptiveStatistics">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#INFINITE_WINDOW">INFINITE_WINDOW</a></strong></code> +<div class="block">Represents an infinite window size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#windowSize">windowSize</a></strong></code> +<div class="block">hold the window size</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="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="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#DescriptiveStatistics()">DescriptiveStatistics</a></strong>()</code> +<div class="block">Construct a DescriptiveStatistics instance with an infinite window</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#DescriptiveStatistics(org.apache.commons.math3.stat.descriptive.DescriptiveStatistics)">DescriptiveStatistics</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> original)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#DescriptiveStatistics(double[])">DescriptiveStatistics</a></strong>(double[] initialDoubleArray)</code> +<div class="block">Construct a DescriptiveStatistics instance with an infinite window + and the initial data values in double[] initialDoubleArray.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#DescriptiveStatistics(int)">DescriptiveStatistics</a></strong>(int window)</code> +<div class="block">Construct a DescriptiveStatistics instance with the specified window</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="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#addValue(double)">addValue</a></strong>(double v)</code> +<div class="block">Adds the value to the dataset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#apply(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">apply</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> stat)</code> +<div class="block">Apply the given statistic to the data associated with this set of statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#clear()">clear</a></strong>()</code> +<div class="block">Resets all statistics and storage</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#copy()">copy</a></strong>()</code> +<div class="block">Returns a copy of this DescriptiveStatistics instance with the same internal state.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#copy(org.apache.commons.math3.stat.descriptive.DescriptiveStatistics,%20org.apache.commons.math3.stat.descriptive.DescriptiveStatistics)">copy</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> source, + <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> dest)</code> +<div class="block">Copies source to dest.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getElement(int)">getElement</a></strong>(int index)</code> +<div class="block">Returns the element at the specified index</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getGeometricMean()">getGeometricMean</a></strong>()</code> +<div class="block">Returns the <a href="http://www.xycoon.com/geometric_mean.htm"> + geometric mean </a> of the available values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getGeometricMeanImpl()">getGeometricMeanImpl</a></strong>()</code> +<div class="block">Returns the currently configured geometric mean implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getKurtosis()">getKurtosis</a></strong>()</code> +<div class="block">Returns the Kurtosis of the available values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getKurtosisImpl()">getKurtosisImpl</a></strong>()</code> +<div class="block">Returns the currently configured kurtosis implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMax()">getMax</a></strong>()</code> +<div class="block">Returns the maximum of the available values</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMaxImpl()">getMaxImpl</a></strong>()</code> +<div class="block">Returns the currently configured maximum implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMean()">getMean</a></strong>()</code> +<div class="block">Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm"> + arithmetic mean </a> of the available values</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMeanImpl()">getMeanImpl</a></strong>()</code> +<div class="block">Returns the currently configured mean implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMin()">getMin</a></strong>()</code> +<div class="block">Returns the minimum of the available values</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getMinImpl()">getMinImpl</a></strong>()</code> +<div class="block">Returns the currently configured minimum implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getN()">getN</a></strong>()</code> +<div class="block">Returns the number of available values</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPercentile(double)">getPercentile</a></strong>(double p)</code> +<div class="block">Returns an estimate for the pth percentile of the stored values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPercentileImpl()">getPercentileImpl</a></strong>()</code> +<div class="block">Returns the currently configured percentile implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPopulationVariance()">getPopulationVariance</a></strong>()</code> +<div class="block">Returns the <a href="http://en.wikibooks.org/wiki/Statistics/Summary/Variance"> + population variance</a> of the available values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getQuadraticMean()">getQuadraticMean</a></strong>()</code> +<div class="block">Returns the quadratic mean, a.k.a.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSkewness()">getSkewness</a></strong>()</code> +<div class="block">Returns the skewness of the available values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSkewnessImpl()">getSkewnessImpl</a></strong>()</code> +<div class="block">Returns the currently configured skewness implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSortedValues()">getSortedValues</a></strong>()</code> +<div class="block">Returns the current set of values in an array of double primitives, + sorted in ascending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getStandardDeviation()">getStandardDeviation</a></strong>()</code> +<div class="block">Returns the standard deviation of the available values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSum()">getSum</a></strong>()</code> +<div class="block">Returns the sum of the values that have been added to Univariate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSumImpl()">getSumImpl</a></strong>()</code> +<div class="block">Returns the currently configured sum implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSumsq()">getSumsq</a></strong>()</code> +<div class="block">Returns the sum of the squares of the available values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getSumsqImpl()">getSumsqImpl</a></strong>()</code> +<div class="block">Returns the currently configured sum of squares implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getValues()">getValues</a></strong>()</code> +<div class="block">Returns the current set of values in an array of double primitives.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getVariance()">getVariance</a></strong>()</code> +<div class="block">Returns the (sample) variance of the available values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getVarianceImpl()">getVarianceImpl</a></strong>()</code> +<div class="block">Returns the currently configured variance implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getWindowSize()">getWindowSize</a></strong>()</code> +<div class="block">Returns the maximum number of values that can be stored in the + dataset, or INFINITE_WINDOW (-1) if there is no limit.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#removeMostRecentValue()">removeMostRecentValue</a></strong>()</code> +<div class="block">Removes the most recent value from the dataset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#replaceMostRecentValue(double)">replaceMostRecentValue</a></strong>(double v)</code> +<div class="block">Replaces the most recently stored value with the given value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setGeometricMeanImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setGeometricMeanImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> geometricMeanImpl)</code> +<div class="block">Sets the implementation for the gemoetric mean.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setKurtosisImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setKurtosisImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> kurtosisImpl)</code> +<div class="block">Sets the implementation for the kurtosis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setMaxImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setMaxImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> maxImpl)</code> +<div class="block">Sets the implementation for the maximum.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setMeanImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setMeanImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> meanImpl)</code> +<div class="block">Sets the implementation for the mean.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setMinImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setMinImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> minImpl)</code> +<div class="block">Sets the implementation for the minimum.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setPercentileImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setPercentileImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> percentileImpl)</code> +<div class="block">Sets the implementation to be used by <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPercentile(double)"><code>getPercentile(double)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setSkewnessImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setSkewnessImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> skewnessImpl)</code> +<div class="block">Sets the implementation for the skewness.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setSumImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setSumImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> sumImpl)</code> +<div class="block">Sets the implementation for the sum.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setSumsqImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setSumsqImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> sumsqImpl)</code> +<div class="block">Sets the implementation for the sum of squares.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setVarianceImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)">setVarianceImpl</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> varianceImpl)</code> +<div class="block">Sets the implementation for the variance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#setWindowSize(int)">setWindowSize</a></strong>(int windowSize)</code> +<div class="block">WindowSize controls the number of values that contribute to the + reported statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#toString()">toString</a></strong>()</code> +<div class="block">Generates a text report displaying univariate statistics from values + that have been added.</div> +</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="INFINITE_WINDOW"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INFINITE_WINDOW</h4> +<pre>public static final int INFINITE_WINDOW</pre> +<div class="block">Represents an infinite window size. When the <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getWindowSize()"><code>getWindowSize()</code></a> + returns this value, there is no limit to the number of data values + that can be stored in the dataset.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.commons.math3.stat.descriptive.DescriptiveStatistics.INFINITE_WINDOW">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="windowSize"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>windowSize</h4> +<pre>protected int windowSize</pre> +<div class="block">hold the window size</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DescriptiveStatistics()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DescriptiveStatistics</h4> +<pre>public DescriptiveStatistics()</pre> +<div class="block">Construct a DescriptiveStatistics instance with an infinite window</div> +</li> +</ul> +<a name="DescriptiveStatistics(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DescriptiveStatistics</h4> +<pre>public DescriptiveStatistics(int window) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Construct a DescriptiveStatistics instance with the specified window</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>window</code> - the window size.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if window size is less than 1 but + not equal to <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#INFINITE_WINDOW"><code>INFINITE_WINDOW</code></a></dd></dl> +</li> +</ul> +<a name="DescriptiveStatistics(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DescriptiveStatistics</h4> +<pre>public DescriptiveStatistics(double[] initialDoubleArray)</pre> +<div class="block">Construct a DescriptiveStatistics instance with an infinite window + and the initial data values in double[] initialDoubleArray. + If initialDoubleArray is null, then this constructor corresponds to + DescriptiveStatistics()</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialDoubleArray</code> - the initial double[].</dd></dl> +</li> +</ul> +<a name="DescriptiveStatistics(org.apache.commons.math3.stat.descriptive.DescriptiveStatistics)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DescriptiveStatistics</h4> +<pre>public DescriptiveStatistics(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> original) + throws <a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></pre> +<div class="block">Copy constructor. Construct a new DescriptiveStatistics instance that + is a copy of original.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>original</code> - DescriptiveStatistics instance to copy</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></code> - if original is null</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="addValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValue</h4> +<pre>public void addValue(double v)</pre> +<div class="block">Adds the value to the dataset. If the dataset is at the maximum size + (i.e., the number of stored elements equals the currently configured + windowSize), the first (oldest) element in the dataset is discarded + to make room for the new value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the value to be added</dd></dl> +</li> +</ul> +<a name="removeMostRecentValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeMostRecentValue</h4> +<pre>public void removeMostRecentValue() + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a></pre> +<div class="block">Removes the most recent value from the dataset.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a></code> - if there are no elements stored</dd></dl> +</li> +</ul> +<a name="replaceMostRecentValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replaceMostRecentValue</h4> +<pre>public double replaceMostRecentValue(double v) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a></pre> +<div class="block">Replaces the most recently stored value with the given value. + There must be at least one element stored to call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the value to replace the most recent stored value</dd> +<dt><span class="strong">Returns:</span></dt><dd>replaced value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a></code> - if there are no elements stored</dd></dl> +</li> +</ul> +<a name="getMean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMean</h4> +<pre>public double getMean()</pre> +<div class="block">Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm"> + arithmetic mean </a> of the available values</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getMean()">getMean</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The mean or Double.NaN if no values have been added.</dd></dl> +</li> +</ul> +<a name="getGeometricMean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeometricMean</h4> +<pre>public double getGeometricMean()</pre> +<div class="block">Returns the <a href="http://www.xycoon.com/geometric_mean.htm"> + geometric mean </a> of the available values. + <p> + See <a href="../../../../../../org/apache/commons/math3/stat/descriptive/moment/GeometricMean.html" title="class in org.apache.commons.math3.stat.descriptive.moment"><code>GeometricMean</code></a> for details on the computing algorithm.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The geometricMean, Double.NaN if no values have been added, + or if any negative values have been added.</dd></dl> +</li> +</ul> +<a name="getVariance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVariance</h4> +<pre>public double getVariance()</pre> +<div class="block">Returns the (sample) variance of the available values. + + <p>This method returns the bias-corrected sample variance (using <code>n - 1</code> in + the denominator). Use <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPopulationVariance()"><code>getPopulationVariance()</code></a> for the non-bias-corrected + population variance.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getVariance()">getVariance</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The variance, Double.NaN if no values have been added + or 0.0 for a single value set.</dd></dl> +</li> +</ul> +<a name="getPopulationVariance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPopulationVariance</h4> +<pre>public double getPopulationVariance()</pre> +<div class="block">Returns the <a href="http://en.wikibooks.org/wiki/Statistics/Summary/Variance"> + population variance</a> of the available values.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The population variance, Double.NaN if no values have been added, + or 0.0 for a single value set.</dd></dl> +</li> +</ul> +<a name="getStandardDeviation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStandardDeviation</h4> +<pre>public double getStandardDeviation()</pre> +<div class="block">Returns the standard deviation of the available values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getStandardDeviation()">getStandardDeviation</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The standard deviation, Double.NaN if no values have been added + or 0.0 for a single value set.</dd></dl> +</li> +</ul> +<a name="getQuadraticMean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQuadraticMean</h4> +<pre>public double getQuadraticMean()</pre> +<div class="block">Returns the quadratic mean, a.k.a. + <a href="http://mathworld.wolfram.com/Root-Mean-Square.html"> + root-mean-square</a> of the available values</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The quadratic mean or <code>Double.NaN</code> if no values + have been added.</dd></dl> +</li> +</ul> +<a name="getSkewness()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkewness</h4> +<pre>public double getSkewness()</pre> +<div class="block">Returns the skewness of the available values. Skewness is a + measure of the asymmetry of a given distribution.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The skewness, Double.NaN if less than 3 values have been added.</dd></dl> +</li> +</ul> +<a name="getKurtosis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKurtosis</h4> +<pre>public double getKurtosis()</pre> +<div class="block">Returns the Kurtosis of the available values. Kurtosis is a + measure of the "peakedness" of a distribution.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The kurtosis, Double.NaN if less than 4 values have been added.</dd></dl> +</li> +</ul> +<a name="getMax()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMax</h4> +<pre>public double getMax()</pre> +<div class="block">Returns the maximum of the available values</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getMax()">getMax</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The max or Double.NaN if no values have been added.</dd></dl> +</li> +</ul> +<a name="getMin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMin</h4> +<pre>public double getMin()</pre> +<div class="block">Returns the minimum of the available values</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getMin()">getMin</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The min or Double.NaN if no values have been added.</dd></dl> +</li> +</ul> +<a name="getN()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getN</h4> +<pre>public long getN()</pre> +<div class="block">Returns the number of available values</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getN()">getN</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The number of available values</dd></dl> +</li> +</ul> +<a name="getSum()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSum</h4> +<pre>public double getSum()</pre> +<div class="block">Returns the sum of the values that have been added to Univariate.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html#getSum()">getSum</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/StatisticalSummary.html" title="interface in org.apache.commons.math3.stat.descriptive">StatisticalSummary</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The sum or Double.NaN if no values have been added</dd></dl> +</li> +</ul> +<a name="getSumsq()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSumsq</h4> +<pre>public double getSumsq()</pre> +<div class="block">Returns the sum of the squares of the available values.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The sum of the squares or Double.NaN if no + values have been added.</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">Resets all statistics and storage</div> +</li> +</ul> +<a name="getWindowSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowSize</h4> +<pre>public int getWindowSize()</pre> +<div class="block">Returns the maximum number of values that can be stored in the + dataset, or INFINITE_WINDOW (-1) if there is no limit.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The current window size or -1 if its Infinite.</dd></dl> +</li> +</ul> +<a name="setWindowSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWindowSize</h4> +<pre>public void setWindowSize(int windowSize) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">WindowSize controls the number of values that contribute to the + reported statistics. For example, if windowSize is set to 3 and the + values {1,2,3,4,5} have been added <strong> in that order</strong> then + the <i>available values</i> are {3,4,5} and all reported statistics will + be based on these values. If <code>windowSize</code> is decreased as a result + of this call and there are more than the new value of elements in the + current dataset, values from the front of the array are discarded to + reduce the dataset to <code>windowSize</code> elements.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowSize</code> - sets the size of the window.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if window size is less than 1 but + not equal to <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#INFINITE_WINDOW"><code>INFINITE_WINDOW</code></a></dd></dl> +</li> +</ul> +<a name="getValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValues</h4> +<pre>public double[] getValues()</pre> +<div class="block">Returns the current set of values in an array of double primitives. + The order of addition is preserved. The returned array is a fresh + copy of the underlying data -- i.e., it is not a reference to the + stored data.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>returns the current set of numbers in the order in which they + were added to this set</dd></dl> +</li> +</ul> +<a name="getSortedValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSortedValues</h4> +<pre>public double[] getSortedValues()</pre> +<div class="block">Returns the current set of values in an array of double primitives, + sorted in ascending order. The returned array is a fresh + copy of the underlying data -- i.e., it is not a reference to the + stored data.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>returns the current set of + numbers sorted in ascending order</dd></dl> +</li> +</ul> +<a name="getElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getElement</h4> +<pre>public double getElement(int index)</pre> +<div class="block">Returns the element at the specified index</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The Index of the element</dd> +<dt><span class="strong">Returns:</span></dt><dd>return the element at the specified index</dd></dl> +</li> +</ul> +<a name="getPercentile(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPercentile</h4> +<pre>public double getPercentile(double p) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Returns an estimate for the pth percentile of the stored values. + <p> + The implementation provided here follows the first estimation procedure presented + <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a> + </p><p> + <strong>Preconditions</strong>:<ul> + <li><code>0 < p ≤ 100</code> (otherwise an + <code>MathIllegalArgumentException</code> is thrown)</li> + <li>at least one value must be stored (returns <code>Double.NaN + </code> otherwise)</li> + </ul></p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - the requested percentile (scaled from 0 - 100)</dd> +<dt><span class="strong">Returns:</span></dt><dd>An estimate for the pth percentile of the stored data</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalStateException.html" title="class in org.apache.commons.math3.exception">MathIllegalStateException</a></code> - if percentile implementation has been + overridden and the supplied implementation does not support setQuantile</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if p is not a valid quantile</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<div class="block">Generates a text report displaying univariate statistics from values + that have been added. Each statistic is displayed on a separate + line.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>String with line feeds displaying statistics</dd></dl> +</li> +</ul> +<a name="apply(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>apply</h4> +<pre>public double apply(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> stat)</pre> +<div class="block">Apply the given statistic to the data associated with this set of statistics.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stat</code> - the statistic to apply</dd> +<dt><span class="strong">Returns:</span></dt><dd>the computed value of the statistic.</dd></dl> +</li> +</ul> +<a name="getMeanImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMeanImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getMeanImpl()</pre> +<div class="block">Returns the currently configured mean implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the mean</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setMeanImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMeanImpl</h4> +<pre>public void setMeanImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> meanImpl)</pre> +<div class="block"><p>Sets the implementation for the mean.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>meanImpl</code> - the UnivariateStatistic instance to use + for computing the mean</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getGeometricMeanImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeometricMeanImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getGeometricMeanImpl()</pre> +<div class="block">Returns the currently configured geometric mean implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the geometric mean</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setGeometricMeanImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGeometricMeanImpl</h4> +<pre>public void setGeometricMeanImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> geometricMeanImpl)</pre> +<div class="block"><p>Sets the implementation for the gemoetric mean.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>geometricMeanImpl</code> - the UnivariateStatistic instance to use + for computing the geometric mean</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getKurtosisImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKurtosisImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getKurtosisImpl()</pre> +<div class="block">Returns the currently configured kurtosis implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the kurtosis</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setKurtosisImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKurtosisImpl</h4> +<pre>public void setKurtosisImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> kurtosisImpl)</pre> +<div class="block"><p>Sets the implementation for the kurtosis.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>kurtosisImpl</code> - the UnivariateStatistic instance to use + for computing the kurtosis</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getMaxImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getMaxImpl()</pre> +<div class="block">Returns the currently configured maximum implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the maximum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setMaxImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxImpl</h4> +<pre>public void setMaxImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> maxImpl)</pre> +<div class="block"><p>Sets the implementation for the maximum.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxImpl</code> - the UnivariateStatistic instance to use + for computing the maximum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getMinImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getMinImpl()</pre> +<div class="block">Returns the currently configured minimum implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the minimum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setMinImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinImpl</h4> +<pre>public void setMinImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> minImpl)</pre> +<div class="block"><p>Sets the implementation for the minimum.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minImpl</code> - the UnivariateStatistic instance to use + for computing the minimum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getPercentileImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPercentileImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getPercentileImpl()</pre> +<div class="block">Returns the currently configured percentile implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the percentile</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setPercentileImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPercentileImpl</h4> +<pre>public void setPercentileImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> percentileImpl) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Sets the implementation to be used by <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html#getPercentile(double)"><code>getPercentile(double)</code></a>. + The supplied <code>UnivariateStatistic</code> must provide a + <code>setQuantile(double)</code> method; otherwise + <code>IllegalArgumentException</code> is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>percentileImpl</code> - the percentileImpl to set</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the supplied implementation does not + provide a <code>setQuantile</code> method</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getSkewnessImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkewnessImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getSkewnessImpl()</pre> +<div class="block">Returns the currently configured skewness implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the skewness</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSkewnessImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSkewnessImpl</h4> +<pre>public void setSkewnessImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> skewnessImpl)</pre> +<div class="block"><p>Sets the implementation for the skewness.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>skewnessImpl</code> - the UnivariateStatistic instance to use + for computing the skewness</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getVarianceImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVarianceImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getVarianceImpl()</pre> +<div class="block">Returns the currently configured variance implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the variance</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setVarianceImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVarianceImpl</h4> +<pre>public void setVarianceImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> varianceImpl)</pre> +<div class="block"><p>Sets the implementation for the variance.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>varianceImpl</code> - the UnivariateStatistic instance to use + for computing the variance</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getSumsqImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSumsqImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getSumsqImpl()</pre> +<div class="block">Returns the currently configured sum of squares implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the sum of squares</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSumsqImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSumsqImpl</h4> +<pre>public void setSumsqImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> sumsqImpl)</pre> +<div class="block"><p>Sets the implementation for the sum of squares.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sumsqImpl</code> - the UnivariateStatistic instance to use + for computing the sum of squares</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getSumImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSumImpl</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> getSumImpl()</pre> +<div class="block">Returns the currently configured sum implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the UnivariateStatistic implementing the sum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSumImpl(org.apache.commons.math3.stat.descriptive.UnivariateStatistic)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSumImpl</h4> +<pre>public void setSumImpl(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> sumImpl)</pre> +<div class="block"><p>Sets the implementation for the sum.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sumImpl</code> - the UnivariateStatistic instance to use + for computing the sum</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="copy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre>public <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> copy()</pre> +<div class="block">Returns a copy of this DescriptiveStatistics instance with the same internal state.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of this</dd></dl> +</li> +</ul> +<a name="copy(org.apache.commons.math3.stat.descriptive.DescriptiveStatistics, org.apache.commons.math3.stat.descriptive.DescriptiveStatistics)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>copy</h4> +<pre>public static void copy(<a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> source, + <a href="../../../../../../org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.commons.math3.stat.descriptive">DescriptiveStatistics</a> dest) + throws <a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></pre> +<div class="block">Copies source to dest. + <p>Neither source nor dest can be null.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - DescriptiveStatistics to copy</dd><dd><code>dest</code> - DescriptiveStatistics to copy to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></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><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/DescriptiveStatistics.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><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AggregateSummaryStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/descriptive/MultivariateSummaryStatistics.html" title="class in org.apache.commons.math3.stat.descriptive"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/descriptive/DescriptiveStatistics.html" target="_top">Frames</a></li> +<li><a href="DescriptiveStatistics.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |