diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/inference/MannWhitneyUTest.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/inference/MannWhitneyUTest.html | 372 |
1 files changed, 372 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/inference/MannWhitneyUTest.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/inference/MannWhitneyUTest.html new file mode 100644 index 0000000..9e29fc5 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/inference/MannWhitneyUTest.html @@ -0,0 +1,372 @@ +<!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>MannWhitneyUTest (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="MannWhitneyUTest (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/MannWhitneyUTest.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/inference/KolmogorovSmirnovTest.html" title="class in org.apache.commons.math3.stat.inference"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/inference/OneWayAnova.html" title="class in org.apache.commons.math3.stat.inference"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/inference/MannWhitneyUTest.html" target="_top">Frames</a></li> +<li><a href="MannWhitneyUTest.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.inference</div> +<h2 title="Class MannWhitneyUTest" class="title">Class MannWhitneyUTest</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.inference.MannWhitneyUTest</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">MannWhitneyUTest</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></pre> +<div class="block">An implementation of the Mann-Whitney U test (also called Wilcoxon rank-sum test).</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/inference/MannWhitneyUTest.html#MannWhitneyUTest()">MannWhitneyUTest</a></strong>()</code> +<div class="block">Create a test instance using where NaN's are left in place and ties get + the average of applicable ranks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/inference/MannWhitneyUTest.html#MannWhitneyUTest(org.apache.commons.math3.stat.ranking.NaNStrategy,%20org.apache.commons.math3.stat.ranking.TiesStrategy)">MannWhitneyUTest</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a> nanStrategy, + <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a> tiesStrategy)</code> +<div class="block">Create a test instance using the given strategies for NaN's and ties.</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>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/inference/MannWhitneyUTest.html#mannWhitneyU(double[],%20double[])">mannWhitneyU</a></strong>(double[] x, + double[] y)</code> +<div class="block">Computes the <a + href="http://en.wikipedia.org/wiki/Mann%E2%80%93Whitney_U"> Mann-Whitney + U statistic</a> comparing mean for two independent samples possibly of + different length.</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/inference/MannWhitneyUTest.html#mannWhitneyUTest(double[],%20double[])">mannWhitneyUTest</a></strong>(double[] x, + double[] y)</code> +<div class="block">Returns the asymptotic <i>observed significance level</i>, or <a href= + "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue"> + p-value</a>, associated with a <a + href="http://en.wikipedia.org/wiki/Mann%E2%80%93Whitney_U"> Mann-Whitney + U statistic</a> comparing mean for two independent samples.</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="MannWhitneyUTest()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MannWhitneyUTest</h4> +<pre>public MannWhitneyUTest()</pre> +<div class="block">Create a test instance using where NaN's are left in place and ties get + the average of applicable ranks. Use this unless you are very sure of + what you are doing.</div> +</li> +</ul> +<a name="MannWhitneyUTest(org.apache.commons.math3.stat.ranking.NaNStrategy, org.apache.commons.math3.stat.ranking.TiesStrategy)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MannWhitneyUTest</h4> +<pre>public MannWhitneyUTest(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a> nanStrategy, + <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a> tiesStrategy)</pre> +<div class="block">Create a test instance using the given strategies for NaN's and ties. + Only use this if you are sure of what you are doing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nanStrategy</code> - specifies the strategy that should be used for Double.NaN's</dd><dd><code>tiesStrategy</code> - specifies the strategy that should be used for ties</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="mannWhitneyU(double[], double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mannWhitneyU</h4> +<pre>public double mannWhitneyU(double[] x, + double[] y) + throws <a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></pre> +<div class="block">Computes the <a + href="http://en.wikipedia.org/wiki/Mann%E2%80%93Whitney_U"> Mann-Whitney + U statistic</a> comparing mean for two independent samples possibly of + different length. + <p> + This statistic can be used to perform a Mann-Whitney U test evaluating + the null hypothesis that the two independent samples has equal mean. + </p> + <p> + Let X<sub>i</sub> denote the i'th individual of the first sample and + Y<sub>j</sub> the j'th individual in the second sample. Note that the + samples would often have different length. + </p> + <p> + <strong>Preconditions</strong>: + <ul> + <li>All observations in the two samples are independent.</li> + <li>The observations are at least ordinal (continuous are also ordinal).</li> + </ul> + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the first sample</dd><dd><code>y</code> - the second sample</dd> +<dt><span class="strong">Returns:</span></dt><dd>Mann-Whitney U statistic (maximum of U<sup>x</sup> and U<sup>y</sup>)</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 <code>x</code> or <code>y</code> are <code>null</code>.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></code> - if <code>x</code> or <code>y</code> are zero-length.</dd></dl> +</li> +</ul> +<a name="mannWhitneyUTest(double[], double[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>mannWhitneyUTest</h4> +<pre>public double mannWhitneyUTest(double[] x, + double[] y) + throws <a href="../../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/ConvergenceException.html" title="class in org.apache.commons.math3.exception">ConvergenceException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a></pre> +<div class="block">Returns the asymptotic <i>observed significance level</i>, or <a href= + "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue"> + p-value</a>, associated with a <a + href="http://en.wikipedia.org/wiki/Mann%E2%80%93Whitney_U"> Mann-Whitney + U statistic</a> comparing mean for two independent samples. + <p> + Let X<sub>i</sub> denote the i'th individual of the first sample and + Y<sub>j</sub> the j'th individual in the second sample. Note that the + samples would often have different length. + </p> + <p> + <strong>Preconditions</strong>: + <ul> + <li>All observations in the two samples are independent.</li> + <li>The observations are at least ordinal (continuous are also ordinal).</li> + </ul> + </p><p> + Ties give rise to biased variance at the moment. See e.g. <a + href="http://mlsc.lboro.ac.uk/resources/statistics/Mannwhitney.pdf" + >http://mlsc.lboro.ac.uk/resources/statistics/Mannwhitney.pdf</a>.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the first sample</dd><dd><code>y</code> - the second sample</dd> +<dt><span class="strong">Returns:</span></dt><dd>asymptotic p-value</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 <code>x</code> or <code>y</code> are <code>null</code>.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></code> - if <code>x</code> or <code>y</code> are zero-length.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/ConvergenceException.html" title="class in org.apache.commons.math3.exception">ConvergenceException</a></code> - if the p-value can not be computed due to a + convergence error</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a></code> - if the maximum number of iterations + is exceeded</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/MannWhitneyUTest.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/inference/KolmogorovSmirnovTest.html" title="class in org.apache.commons.math3.stat.inference"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/inference/OneWayAnova.html" title="class in org.apache.commons.math3.stat.inference"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/inference/MannWhitneyUTest.html" target="_top">Frames</a></li> +<li><a href="MannWhitneyUTest.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> |