Google Git
Sign in
vanadium / third_party / f3f8ecf501af34dcff5dc09ab99fbc11aab47945 / . / java / commons-math3-3.3 / docs / apidocs / org / apache / commons / math3 / stat / ranking / NaturalRanking.html
blob: 97863f89b982aa15f90f04bed1d2b03118a50997 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>NaturalRanking (Apache Commons Math 3.3 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="NaturalRanking (Apache Commons Math 3.3 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/NaturalRanking.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/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/commons/math3/stat/ranking/RankingAlgorithm.html" title="interface in org.apache.commons.math3.stat.ranking"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/ranking/NaturalRanking.html" target="_top">Frames</a></li>
<li><a href="NaturalRanking.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.math3.stat.ranking</div>
<h2 title="Class NaturalRanking" class="title">Class NaturalRanking</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/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.ranking.NaturalRanking</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/ranking/RankingAlgorithm.html" title="interface in org.apache.commons.math3.stat.ranking">RankingAlgorithm</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">NaturalRanking</span>
extends <a href="http://docs.oracle.com/javase/6/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/ranking/RankingAlgorithm.html" title="interface in org.apache.commons.math3.stat.ranking">RankingAlgorithm</a></pre>
<div class="block"><p> Ranking based on the natural ordering on doubles.</p>
<p>NaNs are treated according to the configured <a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking"><code>NaNStrategy</code></a> and ties
are handled using the selected <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking"><code>TiesStrategy</code></a>.
Configuration settings are supplied in optional constructor arguments.
Defaults are <a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html#FAILED"><code>NaNStrategy.FAILED</code></a> and <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html#AVERAGE"><code>TiesStrategy.AVERAGE</code></a>,
respectively. When using <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html#RANDOM"><code>TiesStrategy.RANDOM</code></a>, a
<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random"><code>RandomGenerator</code></a> may be supplied as a constructor argument.</p>
<p>Examples:
<table border="1" cellpadding="3">
<tr><th colspan="3">
Input data: (20, 17, 30, 42.3, 17, 50, Double.NaN, Double.NEGATIVE_INFINITY, 17)
</th></tr>
<tr><th>NaNStrategy</th><th>TiesStrategy</th>
<th><code>rank(data)</code></th>
<tr>
<td>default (NaNs maximal)</td>
<td>default (ties averaged)</td>
<td>(5, 3, 6, 7, 3, 8, 9, 1, 3)</td></tr>
<tr>
<td>default (NaNs maximal)</td>
<td>MINIMUM</td>
<td>(5, 2, 6, 7, 2, 8, 9, 1, 2)</td></tr>
<tr>
<td>MINIMAL</td>
<td>default (ties averaged)</td>
<td>(6, 4, 7, 8, 4, 9, 1.5, 1.5, 4)</td></tr>
<tr>
<td>REMOVED</td>
<td>SEQUENTIAL</td>
<td>(5, 2, 6, 7, 3, 8, 1, 4)</td></tr>
<tr>
<td>MINIMAL</td>
<td>MAXIMUM</td>
<td>(6, 5, 7, 8, 5, 9, 2, 2, 5)</td></tr></table></p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: NaturalRanking.java 1454897 2013-03-10 19:02:54Z luc $</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#DEFAULT_NAN_STRATEGY">DEFAULT_NAN_STRATEGY</a></strong></code>
<div class="block">default NaN strategy</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#DEFAULT_TIES_STRATEGY">DEFAULT_TIES_STRATEGY</a></strong></code>
<div class="block">default ties strategy</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">&nbsp;</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/ranking/NaturalRanking.html#NaturalRanking()">NaturalRanking</a></strong>()</code>
<div class="block">Create a NaturalRanking with default strategies for handling ties and NaNs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy)">NaturalRanking</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy)</code>
<div class="block">Create a NaturalRanking with the given NaNStrategy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy, org.apache.commons.math3.random.RandomGenerator)">NaturalRanking</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy,
<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;randomGenerator)</code>
<div class="block">Create a NaturalRanking with the given NaNStrategy, TiesStrategy.RANDOM
and the given source of random data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy, org.apache.commons.math3.stat.ranking.TiesStrategy)">NaturalRanking</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy,
<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a>&nbsp;tiesStrategy)</code>
<div class="block">Create a NaturalRanking with the given NaNStrategy and TiesStrategy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#NaturalRanking(org.apache.commons.math3.random.RandomGenerator)">NaturalRanking</a></strong>(<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;randomGenerator)</code>
<div class="block">Create a NaturalRanking with TiesStrategy.RANDOM and the given
RandomGenerator as the source of random data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#NaturalRanking(org.apache.commons.math3.stat.ranking.TiesStrategy)">NaturalRanking</a></strong>(<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a>&nbsp;tiesStrategy)</code>
<div class="block">Create a NaturalRanking with the given TiesStrategy.</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">&nbsp;</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><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#getNanStrategy()">getNanStrategy</a></strong>()</code>
<div class="block">Return the NaNStrategy</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/ranking/NaturalRanking.html#getTiesStrategy()">getTiesStrategy</a></strong>()</code>
<div class="block">Return the TiesStrategy</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/ranking/NaturalRanking.html#rank(double[])">rank</a></strong>(double[]&nbsp;data)</code>
<div class="block">Rank <code>data</code> using the natural ordering on Doubles, with
NaN values handled according to <code>nanStrategy</code> and ties
resolved using <code>tiesStrategy.</code></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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" 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="DEFAULT_NAN_STRATEGY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_NAN_STRATEGY</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a> DEFAULT_NAN_STRATEGY</pre>
<div class="block">default NaN strategy</div>
</li>
</ul>
<a name="DEFAULT_TIES_STRATEGY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_TIES_STRATEGY</h4>
<pre>public static final&nbsp;<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a> DEFAULT_TIES_STRATEGY</pre>
<div class="block">default ties strategy</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NaturalRanking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking()</pre>
<div class="block">Create a NaturalRanking with default strategies for handling ties and NaNs.</div>
</li>
</ul>
<a name="NaturalRanking(org.apache.commons.math3.stat.ranking.TiesStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking(<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a>&nbsp;tiesStrategy)</pre>
<div class="block">Create a NaturalRanking with the given TiesStrategy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tiesStrategy</code> - the TiesStrategy to use</dd></dl>
</li>
</ul>
<a name="NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy)</pre>
<div class="block">Create a NaturalRanking with the given NaNStrategy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nanStrategy</code> - the NaNStrategy to use</dd></dl>
</li>
</ul>
<a name="NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy, org.apache.commons.math3.stat.ranking.TiesStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy,
<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a>&nbsp;tiesStrategy)</pre>
<div class="block">Create a NaturalRanking with the given NaNStrategy and TiesStrategy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nanStrategy</code> - NaNStrategy to use</dd><dd><code>tiesStrategy</code> - TiesStrategy to use</dd></dl>
</li>
</ul>
<a name="NaturalRanking(org.apache.commons.math3.random.RandomGenerator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking(<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;randomGenerator)</pre>
<div class="block">Create a NaturalRanking with TiesStrategy.RANDOM and the given
RandomGenerator as the source of random data.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>randomGenerator</code> - source of random data</dd></dl>
</li>
</ul>
<a name="NaturalRanking(org.apache.commons.math3.stat.ranking.NaNStrategy, org.apache.commons.math3.random.RandomGenerator)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NaturalRanking</h4>
<pre>public&nbsp;NaturalRanking(<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;nanStrategy,
<a href="../../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a>&nbsp;randomGenerator)</pre>
<div class="block">Create a NaturalRanking with the given NaNStrategy, TiesStrategy.RANDOM
and the given source of random data.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nanStrategy</code> - NaNStrategy to use</dd><dd><code>randomGenerator</code> - source of random data</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="getNanStrategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNanStrategy</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">NaNStrategy</a>&nbsp;getNanStrategy()</pre>
<div class="block">Return the NaNStrategy</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>returns the NaNStrategy</dd></dl>
</li>
</ul>
<a name="getTiesStrategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTiesStrategy</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/commons/math3/stat/ranking/TiesStrategy.html" title="enum in org.apache.commons.math3.stat.ranking">TiesStrategy</a>&nbsp;getTiesStrategy()</pre>
<div class="block">Return the TiesStrategy</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the TiesStrategy</dd></dl>
</li>
</ul>
<a name="rank(double[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rank</h4>
<pre>public&nbsp;double[]&nbsp;rank(double[]&nbsp;data)</pre>
<div class="block">Rank <code>data</code> using the natural ordering on Doubles, with
NaN values handled according to <code>nanStrategy</code> and ties
resolved using <code>tiesStrategy.</code></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/stat/ranking/RankingAlgorithm.html#rank(double[])">rank</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/commons/math3/stat/ranking/RankingAlgorithm.html" title="interface in org.apache.commons.math3.stat.ranking">RankingAlgorithm</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - array to be ranked</dd>
<dt><span class="strong">Returns:</span></dt><dd>array of ranks</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotANumberException.html" title="class in org.apache.commons.math3.exception">NotANumberException</a></code> - if the selected <a href="../../../../../../org/apache/commons/math3/stat/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking"><code>NaNStrategy</code></a> is <code>FAILED</code>
and a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang"><code>Double.NaN</code></a> is encountered in the input data</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/NaturalRanking.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/ranking/NaNStrategy.html" title="enum in org.apache.commons.math3.stat.ranking"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/commons/math3/stat/ranking/RankingAlgorithm.html" title="interface in org.apache.commons.math3.stat.ranking"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/ranking/NaturalRanking.html" target="_top">Frames</a></li>
<li><a href="NaturalRanking.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>