| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>AbstractUnivariateStatistic</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractUnivariateStatistic"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":6,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/openejb/math/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.openejb.math.stat.descriptive"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/openejb/math/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.openejb.math.stat.descriptive</div> |
| <h2 title="Class AbstractUnivariateStatistic" class="title">Class AbstractUnivariateStatistic</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openejb.math.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/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive">AbstractStorelessUnivariateStatistic</a>, <a href="../../../../../../org/apache/openejb/math/stat/descriptive/rank/Percentile.html" title="class in org.apache.openejb.math.stat.descriptive.rank">Percentile</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractUnivariateStatistic</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></pre> |
| <div class="block">Abstract base class for all implementations of the |
| <a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#AbstractUnivariateStatistic--">AbstractUnivariateStatistic</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#copy--">copy</a></span>()</code> |
| <div class="block">Returns a copy of the statistic with the same internal state.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#evaluate-double:A-">evaluate</a></span>(double[] values)</code> |
| <div class="block">Returns the result of evaluating the statistic over the input array.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#evaluate-double:A-int-int-">evaluate</a></span>(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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#test-double:A-double:A-int-int-">test</a></span>(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 id="i4" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractUnivariateStatistic.html#test-double:A-int-int-">test</a></span>(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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="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="evaluate-double:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evaluate</h4> |
| <pre>public double evaluate(double[] values)</pre> |
| <div class="block">Returns the result of evaluating the statistic over the input array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#evaluate-double:A-">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - input array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the statistic applied to the input array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evaluate-double:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evaluate</h4> |
| <pre>public abstract double evaluate(double[] values, |
| int begin, |
| int length)</pre> |
| <div class="block">Returns the result of evaluating the statistic over the specified entries |
| in the input array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#evaluate-double:A-int-int-">evaluate</a></code> in interface <code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the value of the statistic applied to the included array entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a> copy()</pre> |
| <div class="block">Returns a copy of the statistic with the same internal state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html#copy--">copy</a></code> in interface <code><a href="../../../../../../org/apache/openejb/math/stat/descriptive/UnivariateStatistic.html" title="interface in org.apache.openejb.math.stat.descriptive">UnivariateStatistic</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the statistic</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="test-double:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>test</h4> |
| <pre>protected boolean test(double[] values, |
| int begin, |
| int length)</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>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. |
| </ul></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the input array</dd> |
| <dd><code>begin</code> - index of the first array element to include</dd> |
| <dd><code>length</code> - the number of elements to include</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the parameters are valid and designate a subarray of positive length</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the indices are invalid or the array is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="test-double:A-double:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>test</h4> |
| <pre>protected boolean test(double[] values, |
| double[] weights, |
| int begin, |
| int length)</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="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the input array</dd> |
| <dd><code>weights</code> - the weights array</dd> |
| <dd><code>begin</code> - index of the first array element to include</dd> |
| <dd><code>length</code> - the number of elements to include</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the parameters are valid and designate a subarray of positive length</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the indices are invalid or the array is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/openejb/math/stat/descriptive/AbstractStorelessUnivariateStatistic.html" title="class in org.apache.openejb.math.stat.descriptive"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/openejb/math/stat/descriptive/DescriptiveStatistics.html" title="class in org.apache.openejb.math.stat.descriptive"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/openejb/math/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 ======= --> |
| </body> |
| </html> |