diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html')
-rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html | 619 |
1 files changed, 619 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html new file mode 100644 index 0000000..bd28a3f --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html @@ -0,0 +1,619 @@ +<!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>AbstractUnivariateStatistic (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="AbstractUnivariateStatistic (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/AbstractUnivariateStatistic.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/AbstractStorelessUnivariateStatistic.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/AggregateSummaryStatistics.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/AbstractUnivariateStatistic.html" target="_top">Frames</a></li> +<li><a href="AbstractUnivariateStatistic.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.stat.descriptive</div> +<h2 title="Class AbstractUnivariateStatistic" class="title">Class AbstractUnivariateStatistic</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.AbstractUnivariateStatistic</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a>, <a href="../../../../../../org/apache/commons/math3/util/MathArrays.Function.html" title="interface in org.apache.commons.math3.util">MathArrays.Function</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.commons.math3.stat.descriptive">AbstractStorelessUnivariateStatistic</a>, <a href="../../../../../../org/apache/commons/math3/stat/descriptive/rank/Percentile.html" title="class in org.apache.commons.math3.stat.descriptive.rank">Percentile</a>, <a href="../../../../../../org/apache/commons/math3/stat/descriptive/moment/SemiVariance.html" title="class in org.apache.commons.math3.stat.descriptive.moment">SemiVariance</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractUnivariateStatistic</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/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></pre> +<div class="block">Abstract base class for all implementations of the + <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive"><code>UnivariateStatistic</code></a> interface. + <p> + Provides a default implementation of <code>evaluate(double[]),</code> + delegating to <code>evaluate(double[], int, int)</code> in the natural way. + </p> + <p> + Also includes a <code>test</code> method that performs generic parameter + validation for the <code>evaluate</code> methods.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#AbstractUnivariateStatistic()">AbstractUnivariateStatistic</a></strong>()</code> </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>abstract <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/AbstractUnivariateStatistic.html#copy()">copy</a></strong>()</code> +<div class="block">Returns a copy of the statistic with the same internal state.</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/AbstractUnivariateStatistic.html#evaluate()">evaluate</a></strong>()</code> +<div class="block">Returns the result of evaluating the statistic over the stored data.</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/AbstractUnivariateStatistic.html#evaluate(double[])">evaluate</a></strong>(double[] values)</code> +<div class="block">Returns the result of evaluating the statistic over the input array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#evaluate(double[],%20int,%20int)">evaluate</a></strong>(double[] values, + int begin, + int length)</code> +<div class="block">Returns the result of evaluating the statistic over the specified entries + in the input array.</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/AbstractUnivariateStatistic.html#getData()">getData</a></strong>()</code> +<div class="block">Get a copy of the stored data array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#getDataRef()">getDataRef</a></strong>()</code> +<div class="block">Get a reference to the stored data array.</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/AbstractUnivariateStatistic.html#setData(double[])">setData</a></strong>(double[] values)</code> +<div class="block">Set the data array.</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/AbstractUnivariateStatistic.html#setData(double[],%20int,%20int)">setData</a></strong>(double[] values, + int begin, + int length)</code> +<div class="block">Set the data array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#test(double[],%20double[],%20int,%20int)">test</a></strong>(double[] values, + double[] weights, + int begin, + int length)</code> +<div class="block">This method is used by <code>evaluate(double[], double[], int, int)</code> methods + to verify that the begin and length parameters designate a subarray of positive length + and the weights are all non-negative, non-NaN, finite, and not all zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#test(double[],%20double[],%20int,%20int,%20boolean)">test</a></strong>(double[] values, + double[] weights, + int begin, + int length, + boolean allowEmpty)</code> +<div class="block">This method is used by <code>evaluate(double[], double[], int, int)</code> methods + to verify that the begin and length parameters designate a subarray of positive length + and the weights are all non-negative, non-NaN, finite, and not all zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#test(double[],%20int,%20int)">test</a></strong>(double[] values, + int begin, + int length)</code> +<div class="block">This method is used by <code>evaluate(double[], int, int)</code> methods + to verify that the input parameters designate a subarray of positive length.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#test(double[],%20int,%20int,%20boolean)">test</a></strong>(double[] values, + int begin, + int length, + boolean allowEmpty)</code> +<div class="block">This method is used by <code>evaluate(double[], int, int)</code> methods + to verify that the input parameters designate a subarray of positive length.</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#toString()" title="class or interface in java.lang">toString</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractUnivariateStatistic()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractUnivariateStatistic</h4> +<pre>public AbstractUnivariateStatistic()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setData(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public void setData(double[] values)</pre> +<div class="block">Set the data array. + <p> + The stored value is a copy of the parameter array, not the array itself. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - data array to store (may be null to remove stored data)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#evaluate()"><code>evaluate()</code></a></dd></dl> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public double[] getData()</pre> +<div class="block">Get a copy of the stored data array.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>copy of the stored data array (may be null)</dd></dl> +</li> +</ul> +<a name="getDataRef()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataRef</h4> +<pre>protected double[] getDataRef()</pre> +<div class="block">Get a reference to the stored data array.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>reference to the stored data array (may be null)</dd></dl> +</li> +</ul> +<a name="setData(double[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public void setData(double[] values, + int begin, + int length) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Set the data array. The input array is copied, not referenced.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - data array to store</dd><dd><code>begin</code> - the index of the first element to include</dd><dd><code>length</code> - the number of elements to include</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 values is null or the indices + are not valid</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#evaluate()"><code>evaluate()</code></a></dd></dl> +</li> +</ul> +<a name="evaluate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public double evaluate() + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Returns the result of evaluating the statistic over the stored data. + <p> + The stored array is the one which was set by previous calls to <a href="../../../../../../org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.html#setData(double[])"><code>setData(double[])</code></a>. + </p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the value of the statistic applied to the stored data</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 stored data array is null</dd></dl> +</li> +</ul> +<a name="evaluate(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public double evaluate(double[] values) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Returns the result of evaluating the statistic over the input array.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html#evaluate(double[])">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/util/MathArrays.Function.html#evaluate(double[])">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/util/MathArrays.Function.html" title="interface in org.apache.commons.math3.util">MathArrays.Function</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - input array</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value of the statistic applied to the input array</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 values is null</dd></dl> +</li> +</ul> +<a name="evaluate(double[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public abstract double evaluate(double[] values, + int begin, + int length) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Returns the result of evaluating the statistic over the specified entries + in the input array.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html#evaluate(double[],%20int,%20int)">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/util/MathArrays.Function.html#evaluate(double[],%20int,%20int)">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/util/MathArrays.Function.html" title="interface in org.apache.commons.math3.util">MathArrays.Function</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - the input array</dd><dd><code>begin</code> - the index of the first element to include</dd><dd><code>length</code> - the number of elements to include</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value of the statistic applied to the included array entries</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 values is null or the indices are invalid</dd></dl> +</li> +</ul> +<a name="copy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre>public abstract <a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a> copy()</pre> +<div class="block">Returns a copy of the statistic with the same internal state.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html#copy()">copy</a></code> in interface <code><a href="../../../../../../org/apache/commons/math3/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.commons.math3.stat.descriptive">UnivariateStatistic</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a copy of the statistic</dd></dl> +</li> +</ul> +<a name="test(double[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>test</h4> +<pre>protected boolean test(double[] values, + int begin, + int length) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">This method is used by <code>evaluate(double[], int, int)</code> methods + to verify that the input parameters designate a subarray of positive length. + <p> + <ul> + <li>returns <code>true</code> iff the parameters designate a subarray of + positive length</li> + <li>throws <code>MathIllegalArgumentException</code> if the array is null or + or the indices are invalid</li> + <li>returns <code>false</li> if the array is non-null, but + <code>length</code> is 0. + </ul></p></div> +<dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>true if the parameters are valid and designate a subarray of positive length</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 indices are invalid or the array is null</dd></dl> +</li> +</ul> +<a name="test(double[], int, int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>test</h4> +<pre>protected boolean test(double[] values, + int begin, + int length, + boolean allowEmpty) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">This method is used by <code>evaluate(double[], int, int)</code> methods + to verify that the input parameters designate a subarray of positive length. + <p> + <ul> + <li>returns <code>true</code> iff the parameters designate a subarray of + non-negative length</li> + <li>throws <code>IllegalArgumentException</code> if the array is null or + or the indices are invalid</li> + <li>returns <code>false</li> if the array is non-null, but + <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code> + </ul></p></div> +<dl><dt><span class="strong">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><dd><code>allowEmpty</code> - if <code>true</code> then zero length arrays are allowed</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the parameters are valid</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 indices are invalid or the array is null</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +<a name="test(double[], double[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>test</h4> +<pre>protected boolean test(double[] values, + double[] weights, + int begin, + int length) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">This method is used by <code>evaluate(double[], double[], int, int)</code> methods + to verify that the begin and length parameters designate a subarray of positive length + and the weights are all non-negative, non-NaN, finite, and not all zero. + <p> + <ul> + <li>returns <code>true</code> iff the parameters designate a subarray of + positive length and the weights array contains legitimate values.</li> + <li>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> + </li> + <li>returns <code>false</li> if the array is non-null, but + <code>length</code> is 0. + </ul></p></div> +<dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>true if the parameters are valid and designate a subarray of positive length</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 indices are invalid or the array is null</dd><dt><span class="strong">Since:</span></dt> + <dd>2.1</dd></dl> +</li> +</ul> +<a name="test(double[], double[], int, int, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>test</h4> +<pre>protected boolean test(double[] values, + double[] weights, + int begin, + int length, + boolean allowEmpty) + throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">This method is used by <code>evaluate(double[], double[], int, int)</code> methods + to verify that the begin and length parameters designate a subarray of positive length + and the weights are all non-negative, non-NaN, finite, and not all zero. + <p> + <ul> + <li>returns <code>true</code> iff the parameters designate a subarray of + non-negative length and the weights array contains legitimate values.</li> + <li>throws <code>MathIllegalArgumentException</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> + </li> + <li>returns <code>false</li> if the array is non-null, but + <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code>. + </ul></p></div> +<dl><dt><span class="strong">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><dd><code>allowEmpty</code> - if <code>true</code> than allow zero length arrays to pass.</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the parameters are valid.</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 of the arrays are null</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the array indices are not valid, + the weights array contains NaN, infinite or negative elements, or there + are no positive weights.</dd><dt><span class="strong">Since:</span></dt> + <dd>3.0</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/AbstractUnivariateStatistic.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/AbstractStorelessUnivariateStatistic.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/AggregateSummaryStatistics.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/AbstractUnivariateStatistic.html" target="_top">Frames</a></li> +<li><a href="AbstractUnivariateStatistic.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |