Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/Percentile.EstimationType.html ============================================================================== --- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/Percentile.EstimationType.html (added) +++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/Percentile.EstimationType.html Sat Oct 18 20:10:38 2014 @@ -0,0 +1,1144 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="fr"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.commons.math3.stat.descriptive.rank;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.Arrays;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.BitSet;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.commons.math3.exception.MathIllegalArgumentException;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.commons.math3.exception.MathUnsupportedOperationException;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.commons.math3.exception.NullArgumentException;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.commons.math3.exception.OutOfRangeException;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.commons.math3.exception.util.LocalizedFormats;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.commons.math3.stat.descriptive.AbstractUnivariateStatistic;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.commons.math3.stat.ranking.NaNStrategy;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.commons.math3.util.FastMath;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.commons.math3.util.KthSelector;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.commons.math3.util.MathArrays;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.commons.math3.util.MathUtils;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.commons.math3.util.MedianOf3PivotingStrategy;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.commons.math3.util.PivotingStrategyInterface;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.math3.util.Precision;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>/**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Provides percentile computation.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * There are several commonly used methods for estimating percentiles (a.k.a.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * quantiles) based on sample data. For large samples, the different methods<a name="line.42"></a> +<span class="sourceLineNo">043</span> * agree closely, but when sample sizes are small, different methods will give<a name="line.43"></a> +<span class="sourceLineNo">044</span> * significantly different results. The algorithm implemented here works as follows:<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <ol><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>Let <code>n</code> be the length of the (sorted) array and<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <code>0 < p <= 100</code> be the desired percentile.</li><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <li>If <code> n = 1 </code> return the unique array element (regardless of<a name="line.48"></a> +<span class="sourceLineNo">049</span> * the value of <code>p</code>); otherwise </li><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <li>Compute the estimated percentile position<a name="line.50"></a> +<span class="sourceLineNo">051</span> * <code> pos = p * (n + 1) / 100</code> and the difference, <code>d</code><a name="line.51"></a> +<span class="sourceLineNo">052</span> * between <code>pos</code> and <code>floor(pos)</code> (i.e. the fractional<a name="line.52"></a> +<span class="sourceLineNo">053</span> * part of <code>pos</code>).</li><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <li> If <code>pos < 1</code> return the smallest element in the array.</li><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <li> Else if <code>pos >= n</code> return the largest element in the array.</li><a name="line.55"></a> +<span class="sourceLineNo">056</span> * <li> Else let <code>lower</code> be the element in position<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <code>floor(pos)</code> in the array and let <code>upper</code> be the<a name="line.57"></a> +<span class="sourceLineNo">058</span> * next element in the array. Return <code>lower + d * (upper - lower)</code><a name="line.58"></a> +<span class="sourceLineNo">059</span> * </li><a name="line.59"></a> +<span class="sourceLineNo">060</span> * </ol></p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * To compute percentiles, the data must be at least partially ordered. Input<a name="line.62"></a> +<span class="sourceLineNo">063</span> * arrays are copied and recursively partitioned using an ordering definition.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * The ordering used by <code>Arrays.sort(double[])</code> is the one determined<a name="line.64"></a> +<span class="sourceLineNo">065</span> * by {@link java.lang.Double#compareTo(Double)}. This ordering makes<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <code>Double.NaN</code> larger than any other value (including<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <code>Double.POSITIVE_INFINITY</code>). Therefore, for example, the median<a name="line.67"></a> +<span class="sourceLineNo">068</span> * (50th percentile) of<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <code>{0, 1, 2, 3, 4, Double.NaN}</code> evaluates to <code>2.5.</code></p><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <p><a name="line.70"></a> +<span class="sourceLineNo">071</span> * Since percentile estimation usually involves interpolation between array<a name="line.71"></a> +<span class="sourceLineNo">072</span> * elements, arrays containing <code>NaN</code> or infinite values will often<a name="line.72"></a> +<span class="sourceLineNo">073</span> * result in <code>NaN</code> or infinite values returned.</p><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p><a name="line.74"></a> +<span class="sourceLineNo">075</span> * Further, to include different estimation types such as R1, R2 as mentioned in<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <a href="http://en.wikipedia.org/wiki/Quantile">Quantile page(wikipedia)</a>,<a name="line.76"></a> +<span class="sourceLineNo">077</span> * a type specific NaN handling strategy is used to closely match with the<a name="line.77"></a> +<span class="sourceLineNo">078</span> * typically observed results from popular tools like R(R1-R9), Excel(R7).</p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * <p><a name="line.79"></a> +<span class="sourceLineNo">080</span> * Since 2.2, Percentile uses only selection instead of complete sorting<a name="line.80"></a> +<span class="sourceLineNo">081</span> * and caches selection algorithm state between calls to the various<a name="line.81"></a> +<span class="sourceLineNo">082</span> * {@code evaluate} methods. This greatly improves efficiency, both for a single<a name="line.82"></a> +<span class="sourceLineNo">083</span> * percentile and multiple percentile computations. To maximize performance when<a name="line.83"></a> +<span class="sourceLineNo">084</span> * multiple percentiles are computed based on the same data, users should set the<a name="line.84"></a> +<span class="sourceLineNo">085</span> * data array once using either one of the {@link #evaluate(double[], double)} or<a name="line.85"></a> +<span class="sourceLineNo">086</span> * {@link #setData(double[])} methods and thereafter {@link #evaluate(double)}<a name="line.86"></a> +<span class="sourceLineNo">087</span> * with just the percentile provided.<a name="line.87"></a> +<span class="sourceLineNo">088</span> * </p><a name="line.88"></a> +<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> +<span class="sourceLineNo">090</span> * <strong>Note that this implementation is not synchronized.</strong> If<a name="line.90"></a> +<span class="sourceLineNo">091</span> * multiple threads access an instance of this class concurrently, and at least<a name="line.91"></a> +<span class="sourceLineNo">092</span> * one of the threads invokes the <code>increment()</code> or<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <code>clear()</code> method, it must be synchronized externally.</p><a name="line.93"></a> +<span class="sourceLineNo">094</span> *<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span>public class Percentile extends AbstractUnivariateStatistic implements Serializable {<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /** Serializable version identifier */<a name="line.98"></a> +<span class="sourceLineNo">099</span> private static final long serialVersionUID = -8091216485095130416L;<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> /** Maximum number of partitioning pivots cached (each level double the number of pivots). */<a name="line.101"></a> +<span class="sourceLineNo">102</span> private static final int MAX_CACHED_LEVELS = 10;<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span> /** Maximum number of cached pivots in the pivots cached array */<a name="line.104"></a> +<span class="sourceLineNo">105</span> private static final int PIVOTS_HEAP_LENGTH = 0x1 << MAX_CACHED_LEVELS - 1;<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /** Default KthSelector used with default pivoting strategy */<a name="line.107"></a> +<span class="sourceLineNo">108</span> private final KthSelector kthSelector;<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> /** Any of the {@link EstimationType}s such as {@link EstimationType#LEGACY CM} can be used. */<a name="line.110"></a> +<span class="sourceLineNo">111</span> private final EstimationType estimationType;<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span> /** NaN Handling of the input as defined by {@link NaNStrategy} */<a name="line.113"></a> +<span class="sourceLineNo">114</span> private final NaNStrategy nanStrategy;<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /** Determines what percentile is computed when evaluate() is activated<a name="line.116"></a> +<span class="sourceLineNo">117</span> * with no quantile argument */<a name="line.117"></a> +<span class="sourceLineNo">118</span> private double quantile;<a name="line.118"></a> +<span class="sourceLineNo">119</span><a name="line.119"></a> +<span class="sourceLineNo">120</span> /** Cached pivots. */<a name="line.120"></a> +<span class="sourceLineNo">121</span> private int[] cachedPivots;<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Constructs a Percentile with the following defaults.<a name="line.124"></a> +<span class="sourceLineNo">125</span> * <ul><a name="line.125"></a> +<span class="sourceLineNo">126</span> * <li>default quantile: 50.0, can be reset with {@link #setQuantile(double)}</li><a name="line.126"></a> +<span class="sourceLineNo">127</span> * <li>default estimation type: {@link EstimationType#LEGACY},<a name="line.127"></a> +<span class="sourceLineNo">128</span> * can be reset with {@link #withEstimationType(EstimationType)}</li><a name="line.128"></a> +<span class="sourceLineNo">129</span> * <li>default NaN strategy: {@link NaNStrategy#REMOVED},<a name="line.129"></a> +<span class="sourceLineNo">130</span> * can be reset with {@link #withNaNStrategy(NaNStrategy)}</li><a name="line.130"></a> +<span class="sourceLineNo">131</span> * <li>a KthSelector that makes use of {@link MedianOf3PivotingStrategy},<a name="line.131"></a> +<span class="sourceLineNo">132</span> * can be reset with {@link #withKthSelector(KthSelector)}</li><a name="line.132"></a> +<span class="sourceLineNo">133</span> * </ul><a name="line.133"></a> +<span class="sourceLineNo">134</span> */<a name="line.134"></a> +<span class="sourceLineNo">135</span> public Percentile() {<a name="line.135"></a> +<span class="sourceLineNo">136</span> // No try-catch or advertised exception here - arg is valid<a name="line.136"></a> +<span class="sourceLineNo">137</span> this(50.0);<a name="line.137"></a> +<span class="sourceLineNo">138</span> }<a name="line.138"></a> +<span class="sourceLineNo">139</span><a name="line.139"></a> +<span class="sourceLineNo">140</span> /**<a name="line.140"></a> +<span class="sourceLineNo">141</span> * Constructs a Percentile with the specific quantile value and the following<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <ul><a name="line.142"></a> +<span class="sourceLineNo">143</span> * <li>default method type: {@link EstimationType#LEGACY}</li><a name="line.143"></a> +<span class="sourceLineNo">144</span> * <li>default NaN strategy: {@link NaNStrategy#REMOVED}</li><a name="line.144"></a> +<span class="sourceLineNo">145</span> * <li>a Kth Selector : {@link KthSelector}</li><a name="line.145"></a> +<span class="sourceLineNo">146</span> * </ul><a name="line.146"></a> +<span class="sourceLineNo">147</span> * @param quantile the quantile<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @throws MathIllegalArgumentException if p is not greater than 0 and less<a name="line.148"></a> +<span class="sourceLineNo">149</span> * than or equal to 100<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> public Percentile(final double quantile) throws MathIllegalArgumentException {<a name="line.151"></a> +<span class="sourceLineNo">152</span> this(quantile, EstimationType.LEGACY, NaNStrategy.REMOVED,<a name="line.152"></a> +<span class="sourceLineNo">153</span> new KthSelector(new MedianOf3PivotingStrategy()));<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> /**<a name="line.156"></a> +<span class="sourceLineNo">157</span> * Copy constructor, creates a new {@code Percentile} identical<a name="line.157"></a> +<span class="sourceLineNo">158</span> * to the {@code original}<a name="line.158"></a> +<span class="sourceLineNo">159</span> *<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param original the {@code Percentile} instance to copy<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @throws NullArgumentException if original is null<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> public Percentile(final Percentile original) throws NullArgumentException {<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> MathUtils.checkNotNull(original);<a name="line.165"></a> +<span class="sourceLineNo">166</span> estimationType = original.getEstimationType();<a name="line.166"></a> +<span class="sourceLineNo">167</span> nanStrategy = original.getNaNStrategy();<a name="line.167"></a> +<span class="sourceLineNo">168</span> kthSelector = original.getKthSelector();<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> setData(original.getDataRef());<a name="line.170"></a> +<span class="sourceLineNo">171</span> if (original.cachedPivots != null) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> System.arraycopy(original.cachedPivots, 0, cachedPivots, 0, original.cachedPivots.length);<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span> setQuantile(original.quantile);<a name="line.174"></a> +<span class="sourceLineNo">175</span><a name="line.175"></a> +<span class="sourceLineNo">176</span> }<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> /**<a name="line.178"></a> +<span class="sourceLineNo">179</span> * Constructs a Percentile with the specific quantile value,<a name="line.179"></a> +<span class="sourceLineNo">180</span> * {@link EstimationType}, {@link NaNStrategy} and {@link KthSelector}.<a name="line.180"></a> +<span class="sourceLineNo">181</span> *<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param quantile the quantile to be computed<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param estimationType one of the percentile {@link EstimationType estimation types}<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @param nanStrategy one of {@link NaNStrategy} to handle with NaNs<a name="line.184"></a> +<span class="sourceLineNo">185</span> * @param kthSelector a {@link KthSelector} to use for pivoting during search<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @throws MathIllegalArgumentException if p is not within (0,100]<a name="line.186"></a> +<span class="sourceLineNo">187</span> * @throws NullArgumentException if type or NaNStrategy passed is null<a name="line.187"></a> +<span class="sourceLineNo">188</span> */<a name="line.188"></a> +<span class="sourceLineNo">189</span> protected Percentile(final double quantile,<a name="line.189"></a> +<span class="sourceLineNo">190</span> final EstimationType estimationType,<a name="line.190"></a> +<span class="sourceLineNo">191</span> final NaNStrategy nanStrategy,<a name="line.191"></a> +<span class="sourceLineNo">192</span> final KthSelector kthSelector)<a name="line.192"></a> +<span class="sourceLineNo">193</span> throws MathIllegalArgumentException {<a name="line.193"></a> +<span class="sourceLineNo">194</span> setQuantile(quantile);<a name="line.194"></a> +<span class="sourceLineNo">195</span> cachedPivots = null;<a name="line.195"></a> +<span class="sourceLineNo">196</span> MathUtils.checkNotNull(estimationType);<a name="line.196"></a> +<span class="sourceLineNo">197</span> MathUtils.checkNotNull(nanStrategy);<a name="line.197"></a> +<span class="sourceLineNo">198</span> MathUtils.checkNotNull(kthSelector);<a name="line.198"></a> +<span class="sourceLineNo">199</span> this.estimationType = estimationType;<a name="line.199"></a> +<span class="sourceLineNo">200</span> this.nanStrategy = nanStrategy;<a name="line.200"></a> +<span class="sourceLineNo">201</span> this.kthSelector = kthSelector;<a name="line.201"></a> +<span class="sourceLineNo">202</span> }<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> /** {@inheritDoc} */<a name="line.204"></a> +<span class="sourceLineNo">205</span> @Override<a name="line.205"></a> +<span class="sourceLineNo">206</span> public void setData(final double[] values) {<a name="line.206"></a> +<span class="sourceLineNo">207</span> if (values == null) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> cachedPivots = null;<a name="line.208"></a> +<span class="sourceLineNo">209</span> } else {<a name="line.209"></a> +<span class="sourceLineNo">210</span> cachedPivots = new int[PIVOTS_HEAP_LENGTH];<a name="line.210"></a> +<span class="sourceLineNo">211</span> Arrays.fill(cachedPivots, -1);<a name="line.211"></a> +<span class="sourceLineNo">212</span> }<a name="line.212"></a> +<span class="sourceLineNo">213</span> super.setData(values);<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /** {@inheritDoc} */<a name="line.216"></a> +<span class="sourceLineNo">217</span> @Override<a name="line.217"></a> +<span class="sourceLineNo">218</span> public void setData(final double[] values, final int begin, final int length)<a name="line.218"></a> +<span class="sourceLineNo">219</span> throws MathIllegalArgumentException {<a name="line.219"></a> +<span class="sourceLineNo">220</span> if (values == null) {<a name="line.220"></a> +<span class="sourceLineNo">221</span> cachedPivots = null;<a name="line.221"></a> +<span class="sourceLineNo">222</span> } else {<a name="line.222"></a> +<span class="sourceLineNo">223</span> cachedPivots = new int[PIVOTS_HEAP_LENGTH];<a name="line.223"></a> +<span class="sourceLineNo">224</span> Arrays.fill(cachedPivots, -1);<a name="line.224"></a> +<span class="sourceLineNo">225</span> }<a name="line.225"></a> +<span class="sourceLineNo">226</span> super.setData(values, begin, length);<a name="line.226"></a> +<span class="sourceLineNo">227</span> }<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * Returns the result of evaluating the statistic over the stored data.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * <p><a name="line.231"></a> +<span class="sourceLineNo">232</span> * The stored array is the one which was set by previous calls to<a name="line.232"></a> +<span class="sourceLineNo">233</span> * {@link #setData(double[])}<a name="line.233"></a> +<span class="sourceLineNo">234</span> * </p><a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param p the percentile value to compute<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @return the value of the statistic applied to the stored data<a name="line.236"></a> +<span class="sourceLineNo">237</span> * @throws MathIllegalArgumentException if p is not a valid quantile value<a name="line.237"></a> +<span class="sourceLineNo">238</span> * (p must be greater than 0 and less than or equal to 100)<a name="line.238"></a> +<span class="sourceLineNo">239</span> */<a name="line.239"></a> +<span class="sourceLineNo">240</span> public double evaluate(final double p) throws MathIllegalArgumentException {<a name="line.240"></a> +<span class="sourceLineNo">241</span> return evaluate(getDataRef(), p);<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> /**<a name="line.244"></a> +<span class="sourceLineNo">245</span> * Returns an estimate of the <code>p</code>th percentile of the values<a name="line.245"></a> +<span class="sourceLineNo">246</span> * in the <code>values</code> array.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <p><a name="line.247"></a> +<span class="sourceLineNo">248</span> * Calls to this method do not modify the internal <code>quantile</code><a name="line.248"></a> +<span class="sourceLineNo">249</span> * state of this statistic.</p><a name="line.249"></a> +<span class="sourceLineNo">250</span> * <p><a name="line.250"></a> +<span class="sourceLineNo">251</span> * <ul><a name="line.251"></a> +<span class="sourceLineNo">252</span> * <li>Returns <code>Double.NaN</code> if <code>values</code> has length<a name="line.252"></a> +<span class="sourceLineNo">253</span> * <code>0</code></li><a name="line.253"></a> +<span class="sourceLineNo">254</span> * <li>Returns (for any value of <code>p</code>) <code>values[0]</code><a name="line.254"></a> +<span class="sourceLineNo">255</span> * if <code>values</code> has length <code>1</code></li><a name="line.255"></a> +<span class="sourceLineNo">256</span> * <li>Throws <code>MathIllegalArgumentException</code> if <code>values</code><a name="line.256"></a> +<span class="sourceLineNo">257</span> * is null or p is not a valid quantile value (p must be greater than 0<a name="line.257"></a> +<span class="sourceLineNo">258</span> * and less than or equal to 100) </li><a name="line.258"></a> +<span class="sourceLineNo">259</span> * </ul></p><a name="line.259"></a> +<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> +<span class="sourceLineNo">261</span> * See {@link Percentile} for a description of the percentile estimation<a name="line.261"></a> +<span class="sourceLineNo">262</span> * algorithm used.</p><a name="line.262"></a> +<span class="sourceLineNo">263</span> *<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @param values input array of values<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @param p the percentile value to compute<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return the percentile value or Double.NaN if the array is empty<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @throws MathIllegalArgumentException if <code>values</code> is null<a name="line.267"></a> +<span class="sourceLineNo">268</span> * or p is invalid<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> public double evaluate(final double[] values, final double p)<a name="line.270"></a> +<span class="sourceLineNo">271</span> throws MathIllegalArgumentException {<a name="line.271"></a> +<span class="sourceLineNo">272</span> test(values, 0, 0);<a name="line.272"></a> +<span class="sourceLineNo">273</span> return evaluate(values, 0, values.length, p);<a name="line.273"></a> +<span class="sourceLineNo">274</span> }<a name="line.274"></a> +<span class="sourceLineNo">275</span><a name="line.275"></a> +<span class="sourceLineNo">276</span> /**<a name="line.276"></a> +<span class="sourceLineNo">277</span> * Returns an estimate of the <code>quantile</code>th percentile of the<a name="line.277"></a> +<span class="sourceLineNo">278</span> * designated values in the <code>values</code> array. The quantile<a name="line.278"></a> +<span class="sourceLineNo">279</span> * estimated is determined by the <code>quantile</code> property.<a name="line.279"></a> +<span class="sourceLineNo">280</span> * <p><a name="line.280"></a> +<span class="sourceLineNo">281</span> * <ul><a name="line.281"></a> +<span class="sourceLineNo">282</span> * <li>Returns <code>Double.NaN</code> if <code>length = 0</code></li><a name="line.282"></a> +<span class="sourceLineNo">283</span> * <li>Returns (for any value of <code>quantile</code>)<a name="line.283"></a> +<span class="sourceLineNo">284</span> * <code>values[begin]</code> if <code>length = 1 </code></li><a name="line.284"></a> +<span class="sourceLineNo">285</span> * <li>Throws <code>MathIllegalArgumentException</code> if <code>values</code><a name="line.285"></a> +<span class="sourceLineNo">286</span> * is null, or <code>start</code> or <code>length</code> is invalid</li><a name="line.286"></a> +<span class="sourceLineNo">287</span> * </ul></p><a name="line.287"></a> +<span class="sourceLineNo">288</span> * <p><a name="line.288"></a> +<span class="sourceLineNo">289</span> * See {@link Percentile} for a description of the percentile estimation<a name="line.289"></a> +<span class="sourceLineNo">290</span> * algorithm used.</p><a name="line.290"></a> +<span class="sourceLineNo">291</span> *<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @param values the input array<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @param start index of the first array element to include<a name="line.293"></a> +<span class="sourceLineNo">294</span> * @param length the number of elements to include<a name="line.294"></a> +<span class="sourceLineNo">295</span> * @return the percentile value<a name="line.295"></a> +<span class="sourceLineNo">296</span> * @throws MathIllegalArgumentException if the parameters are not valid<a name="line.296"></a> +<span class="sourceLineNo">297</span> *<a name="line.297"></a> +<span class="sourceLineNo">298</span> */<a name="line.298"></a> +<span class="sourceLineNo">299</span> @Override<a name="line.299"></a> +<span class="sourceLineNo">300</span> public double evaluate(final double[] values, final int start, final int length)<a name="line.300"></a> +<span class="sourceLineNo">301</span> throws MathIllegalArgumentException {<a name="line.301"></a> +<span class="sourceLineNo">302</span> return evaluate(values, start, length, quantile);<a name="line.302"></a> +<span class="sourceLineNo">303</span> }<a name="line.303"></a> +<span class="sourceLineNo">304</span><a name="line.304"></a> +<span class="sourceLineNo">305</span> /**<a name="line.305"></a> +<span class="sourceLineNo">306</span> * Returns an estimate of the <code>p</code>th percentile of the values<a name="line.306"></a> +<span class="sourceLineNo">307</span> * in the <code>values</code> array, starting with the element in (0-based)<a name="line.307"></a> +<span class="sourceLineNo">308</span> * position <code>begin</code> in the array and including <code>length</code><a name="line.308"></a> +<span class="sourceLineNo">309</span> * values.<a name="line.309"></a> +<span class="sourceLineNo">310</span> * <p><a name="line.310"></a> +<span class="sourceLineNo">311</span> * Calls to this method do not modify the internal <code>quantile</code><a name="line.311"></a> +<span class="sourceLineNo">312</span> * state of this statistic.</p><a name="line.312"></a> +<span class="sourceLineNo">313</span> * <p><a name="line.313"></a> +<span class="sourceLineNo">314</span> * <ul><a name="line.314"></a> +<span class="sourceLineNo">315</span> * <li>Returns <code>Double.NaN</code> if <code>length = 0</code></li><a name="line.315"></a> +<span class="sourceLineNo">316</span> * <li>Returns (for any value of <code>p</code>) <code>values[begin]</code><a name="line.316"></a> +<span class="sourceLineNo">317</span> * if <code>length = 1 </code></li><a name="line.317"></a> +<span class="sourceLineNo">318</span> * <li>Throws <code>MathIllegalArgumentException</code> if <code>values</code><a name="line.318"></a> +<span class="sourceLineNo">319</span> * is null , <code>begin</code> or <code>length</code> is invalid, or<a name="line.319"></a> +<span class="sourceLineNo">320</span> * <code>p</code> is not a valid quantile value (p must be greater than 0<a name="line.320"></a> +<span class="sourceLineNo">321</span> * and less than or equal to 100)</li><a name="line.321"></a> +<span class="sourceLineNo">322</span> * </ul></p><a name="line.322"></a> +<span class="sourceLineNo">323</span> * <p><a name="line.323"></a> +<span class="sourceLineNo">324</span> * See {@link Percentile} for a description of the percentile estimation<a name="line.324"></a> +<span class="sourceLineNo">325</span> * algorithm used.</p><a name="line.325"></a> +<span class="sourceLineNo">326</span> *<a name="line.326"></a> +<span class="sourceLineNo">327</span> * @param values array of input values<a name="line.327"></a> +<span class="sourceLineNo">328</span> * @param p the percentile to compute<a name="line.328"></a> +<span class="sourceLineNo">329</span> * @param begin the first (0-based) element to include in the computation<a name="line.329"></a> +<span class="sourceLineNo">330</span> * @param length the number of array elements to include<a name="line.330"></a> +<span class="sourceLineNo">331</span> * @return the percentile value<a name="line.331"></a> +<span class="sourceLineNo">332</span> * @throws MathIllegalArgumentException if the parameters are not valid or the<a name="line.332"></a> +<span class="sourceLineNo">333</span> * input array is null<a name="line.333"></a> +<span class="sourceLineNo">334</span> */<a name="line.334"></a> +<span class="sourceLineNo">335</span> public double evaluate(final double[] values, final int begin,<a name="line.335"></a> +<span class="sourceLineNo">336</span> final int length, final double p)<a name="line.336"></a> +<span class="sourceLineNo">337</span> throws MathIllegalArgumentException {<a name="line.337"></a> +<span class="sourceLineNo">338</span><a name="line.338"></a> +<span class="sourceLineNo">339</span> test(values, begin, length);<a name="line.339"></a> +<span class="sourceLineNo">340</span> if (p > 100 || p <= 0) {<a name="line.340"></a> +<span class="sourceLineNo">341</span> throw new OutOfRangeException(<a name="line.341"></a> +<span class="sourceLineNo">342</span> LocalizedFormats.OUT_OF_BOUNDS_QUANTILE_VALUE, p, 0, 100);<a name="line.342"></a> +<span class="sourceLineNo">343</span> }<a name="line.343"></a> +<span class="sourceLineNo">344</span> if (length == 0) {<a name="line.344"></a> +<span class="sourceLineNo">345</span> return Double.NaN;<a name="line.345"></a> +<span class="sourceLineNo">346</span> }<a name="line.346"></a> +<span class="sourceLineNo">347</span> if (length == 1) {<a name="line.347"></a> +<span class="sourceLineNo">348</span> return values[begin]; // always return single value for n = 1<a name="line.348"></a> +<span class="sourceLineNo">349</span> }<a name="line.349"></a> +<span class="sourceLineNo">350</span><a name="line.350"></a> +<span class="sourceLineNo">351</span> final double[] work = getWorkArray(values, begin, length);<a name="line.351"></a> +<span class="sourceLineNo">352</span> final int[] pivotsHeap = getPivots(values);<a name="line.352"></a> +<span class="sourceLineNo">353</span> return work.length == 0 ? Double.NaN :<a name="line.353"></a> +<span class="sourceLineNo">354</span> estimationType.evaluate(work, pivotsHeap, p, kthSelector);<a name="line.354"></a> +<span class="sourceLineNo">355</span> }<a name="line.355"></a> +<span class="sourceLineNo">356</span><a name="line.356"></a> +<span class="sourceLineNo">357</span> /** Select a pivot index as the median of three<a name="line.357"></a> +<span class="sourceLineNo">358</span> * <p><a name="line.358"></a> +<span class="sourceLineNo">359</span> * <b>Note:</b> With the effect of allowing {@link KthSelector} to be set on<a name="line.359"></a> +<span class="sourceLineNo">360</span> * {@link Percentile} instances(thus indirectly {@link PivotingStrategy})<a name="line.360"></a> +<span class="sourceLineNo">361</span> * this method wont take effect any more and hence is unsupported.<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @param work data array<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @param begin index of the first element of the slice<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @param end index after the last element of the slice<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @return the index of the median element chosen between the<a name="line.365"></a> +<span class="sourceLineNo">366</span> * first, the middle and the last element of the array slice<a name="line.366"></a> +<span class="sourceLineNo">367</span> * @deprecated Please refrain from using this method (as it wont take effect)<a name="line.367"></a> +<span class="sourceLineNo">368</span> * and instead use {@link Percentile#withKthSelector(newKthSelector)} if<a name="line.368"></a> +<span class="sourceLineNo">369</span> * required.<a name="line.369"></a> +<span class="sourceLineNo">370</span> *<a name="line.370"></a> +<span class="sourceLineNo">371</span> */<a name="line.371"></a> +<span class="sourceLineNo">372</span> @Deprecated<a name="line.372"></a> +<span class="sourceLineNo">373</span> int medianOf3(final double[] work, final int begin, final int end) {<a name="line.373"></a> +<span class="sourceLineNo">374</span> return new MedianOf3PivotingStrategy().pivotIndex(work, begin, end);<a name="line.374"></a> +<span class="sourceLineNo">375</span> //throw new MathUnsupportedOperationException();<a name="line.375"></a> +<span class="sourceLineNo">376</span> }<a name="line.376"></a> +<span class="sourceLineNo">377</span><a name="line.377"></a> +<span class="sourceLineNo">378</span> /**<a name="line.378"></a> +<span class="sourceLineNo">379</span> * Returns the value of the quantile field (determines what percentile is<a name="line.379"></a> +<span class="sourceLineNo">380</span> * computed when evaluate() is called with no quantile argument).<a name="line.380"></a> +<span class="sourceLineNo">381</span> *<a name="line.381"></a> +<span class="sourceLineNo">382</span> * @return quantile set while construction or {@link #setQuantile(double)}<a name="line.382"></a> +<span class="sourceLineNo">383</span> */<a name="line.383"></a> +<span class="sourceLineNo">384</span> public double getQuantile() {<a name="line.384"></a> +<span class="sourceLineNo">385</span> return quantile;<a name="line.385"></a> +<span class="sourceLineNo">386</span> }<a name="line.386"></a> +<span class="sourceLineNo">387</span><a name="line.387"></a> +<span class="sourceLineNo">388</span> /**<a name="line.388"></a> +<span class="sourceLineNo">389</span> * Sets the value of the quantile field (determines what percentile is<a name="line.389"></a> +<span class="sourceLineNo">390</span> * computed when evaluate() is called with no quantile argument).<a name="line.390"></a> +<span class="sourceLineNo">391</span> *<a name="line.391"></a> +<span class="sourceLineNo">392</span> * @param p a value between 0 < p <= 100<a name="line.392"></a> +<span class="sourceLineNo">393</span> * @throws MathIllegalArgumentException if p is not greater than 0 and less<a name="line.393"></a> +<span class="sourceLineNo">394</span> * than or equal to 100<a name="line.394"></a> +<span class="sourceLineNo">395</span> */<a name="line.395"></a> +<span class="sourceLineNo">396</span> public void setQuantile(final double p) throws MathIllegalArgumentException {<a name="line.396"></a> +<span class="sourceLineNo">397</span> if (p <= 0 || p > 100) {<a name="line.397"></a> +<span class="sourceLineNo">398</span> throw new OutOfRangeException(<a name="line.398"></a> +<span class="sourceLineNo">399</span> LocalizedFormats.OUT_OF_BOUNDS_QUANTILE_VALUE, p, 0, 100);<a name="line.399"></a> +<span class="sourceLineNo">400</span> }<a name="line.400"></a> +<span class="sourceLineNo">401</span> quantile = p;<a name="line.401"></a> +<span class="sourceLineNo">402</span> }<a name="line.402"></a> +<span class="sourceLineNo">403</span><a name="line.403"></a> +<span class="sourceLineNo">404</span> /**<a name="line.404"></a> +<span class="sourceLineNo">405</span> * {@inheritDoc}<a name="line.405"></a> +<span class="sourceLineNo">406</span> */<a name="line.406"></a> +<span class="sourceLineNo">407</span> @Override<a name="line.407"></a> +<span class="sourceLineNo">408</span> public Percentile copy() {<a name="line.408"></a> +<span class="sourceLineNo">409</span> return new Percentile(this);<a name="line.409"></a> +<span class="sourceLineNo">410</span> }<a name="line.410"></a> +<span class="sourceLineNo">411</span><a name="line.411"></a> +<span class="sourceLineNo">412</span> /**<a name="line.412"></a> +<span class="sourceLineNo">413</span> * Copies source to dest.<a name="line.413"></a> +<span class="sourceLineNo">414</span> * @param source Percentile to copy<a name="line.414"></a> +<span class="sourceLineNo">415</span> * @param dest Percentile to copy to<a name="line.415"></a> +<span class="sourceLineNo">416</span> * @exception MathUnsupportedOperationException always thrown since 3.4<a name="line.416"></a> +<span class="sourceLineNo">417</span> * @deprecated as of 3.4 this method does not work anymore, as it fails to<a name="line.417"></a> +<span class="sourceLineNo">418</span> * copy internal states between instances configured with different<a name="line.418"></a> +<span class="sourceLineNo">419</span> * {@link EstimationType estimation type}, {@link NaNStrategy NaN handling strategies}<a name="line.419"></a> +<span class="sourceLineNo">420</span> * and {@link KthSelector kthSelector}, it therefore always<a name="line.420"></a> +<span class="sourceLineNo">421</span> * throw {@link MathUnsupportedOperationException}<a name="line.421"></a> +<span class="sourceLineNo">422</span> */<a name="line.422"></a> +<span class="sourceLineNo">423</span> @Deprecated<a name="line.423"></a> +<span class="sourceLineNo">424</span> public static void copy(final Percentile source, final Percentile dest)<a name="line.424"></a> +<span class="sourceLineNo">425</span> throws MathUnsupportedOperationException {<a name="line.425"></a> +<span class="sourceLineNo">426</span> throw new MathUnsupportedOperationException();<a name="line.426"></a> +<span class="sourceLineNo">427</span> }<a name="line.427"></a> +<span class="sourceLineNo">428</span><a name="line.428"></a> +<span class="sourceLineNo">429</span> /**<a name="line.429"></a> +<span class="sourceLineNo">430</span> * Get the work array to operate. Makes use of prior {@code storedData} if<a name="line.430"></a> +<span class="sourceLineNo">431</span> * it exists or else do a check on NaNs and copy a subset of the array<a name="line.431"></a> +<span class="sourceLineNo">432</span> * defined by begin and length parameters. The set {@link #nanStrategy} will<a name="line.432"></a> +<span class="sourceLineNo">433</span> * be used to either retain/remove/replace any NaNs present before returning<a name="line.433"></a> +<span class="sourceLineNo">434</span> * the resultant array.<a name="line.434"></a> +<span class="sourceLineNo">435</span> *<a name="line.435"></a> +<span class="sourceLineNo">436</span> * @param values the array of numbers<a name="line.436"></a> +<span class="sourceLineNo">437</span> * @param begin index to start reading the array<a name="line.437"></a> +<span class="sourceLineNo">438</span> * @param length the length of array to be read from the begin index<a name="line.438"></a> +<span class="sourceLineNo">439</span> * @return work array sliced from values in the range [begin,begin+length)<a name="line.439"></a> +<span class="sourceLineNo">440</span> * @throws MathIllegalArgumentException if values or indices are invalid<a name="line.440"></a> +<span class="sourceLineNo">441</span> */<a name="line.441"></a> +<span class="sourceLineNo">442</span> protected double[] getWorkArray(final double[] values, final int begin, final int length) {<a name="line.442"></a> +<span class="sourceLineNo">443</span> final double[] work;<a name="line.443"></a> +<span class="sourceLineNo">444</span> if (values == getDataRef()) {<a name="line.444"></a> +<span class="sourceLineNo">445</span> work = getDataRef();<a name="line.445"></a> +<span class="sourceLineNo">446</span> } else {<a name="line.446"></a> +<span class="sourceLineNo">447</span> switch (nanStrategy) {<a name="line.447"></a> +<span class="sourceLineNo">448</span> case MAXIMAL:// Replace NaNs with +INFs<a name="line.448"></a> +<span class="sourceLineNo">449</span> work = replaceAndSlice(values, begin, length, Double.NaN, Double.POSITIVE_INFINITY);<a name="line.449"></a> +<span class="sourceLineNo">450</span> break;<a name="line.450"></a> +<span class="sourceLineNo">451</span> case MINIMAL:// Replace NaNs with -INFs<a name="line.451"></a> +<span class="sourceLineNo">452</span> work = replaceAndSlice(values, begin, length, Double.NaN, Double.NEGATIVE_INFINITY);<a name="line.452"></a> +<span class="sourceLineNo">453</span> break;<a name="line.453"></a> +<span class="sourceLineNo">454</span> case REMOVED:// Drop NaNs from data<a name="line.454"></a> +<span class="sourceLineNo">455</span> work = removeAndSlice(values, begin, length, Double.NaN);<a name="line.455"></a> +<span class="sourceLineNo">456</span> break;<a name="line.456"></a> +<span class="sourceLineNo">457</span> case FAILED:// just throw exception as NaN is un-acceptable<a name="line.457"></a> +<span class="sourceLineNo">458</span> work = copyOf(values, begin, length);<a name="line.458"></a> +<span class="sourceLineNo">459</span> MathArrays.checkNotNaN(work);<a name="line.459"></a> +<span class="sourceLineNo">460</span> break;<a name="line.460"></a> +<span class="sourceLineNo">461</span> default: //FIXED<a name="line.461"></a> +<span class="sourceLineNo">462</span> work = copyOf(values,begin,length);<a name="line.462"></a> +<span class="sourceLineNo">463</span> break;<a name="line.463"></a> +<span class="sourceLineNo">464</span> }<a name="line.464"></a> +<span class="sourceLineNo">465</span> }<a name="line.465"></a> +<span class="sourceLineNo">466</span> return work;<a name="line.466"></a> +<span class="sourceLineNo">467</span> }<a name="line.467"></a> +<span class="sourceLineNo">468</span><a name="line.468"></a> +<span class="sourceLineNo">469</span> /**<a name="line.469"></a> +<span class="sourceLineNo">470</span> * Make a copy of the array for the slice defined by array part from<a name="line.470"></a> +<span class="sourceLineNo">471</span> * [begin, begin+length)<a name="line.471"></a> +<span class="sourceLineNo">472</span> * @param values the input array<a name="line.472"></a> +<span class="sourceLineNo">473</span> * @param begin start index of the array to include<a name="line.473"></a> +<span class="sourceLineNo">474</span> * @param length number of elements to include from begin<a name="line.474"></a> +<span class="sourceLineNo">475</span> * @return copy of a slice of the original array<a name="line.475"></a> +<span class="sourceLineNo">476</span> */<a name="line.476"></a> +<span class="sourceLineNo">477</span> private static double[] copyOf(final double[] values, final int begin, final int length) {<a name="line.477"></a> +<span class="sourceLineNo">478</span> MathArrays.verifyValues(values, begin, length);<a name="line.478"></a> +<span class="sourceLineNo">479</span> return MathArrays.copyOfRange(values, begin, begin + length);<a name="line.479"></a> +<span class="sourceLineNo">480</span> }<a name="line.480"></a> +<span class="sourceLineNo">481</span><a name="line.481"></a> +<span class="sourceLineNo">482</span> /**<a name="line.482"></a> +<span class="sourceLineNo">483</span> * Replace every occurrence of a given value with a replacement value in a<a name="line.483"></a> +<span class="sourceLineNo">484</span> * copied slice of array defined by array part from [begin, begin+length).<a name="line.484"></a> +<span class="sourceLineNo">485</span> * @param values the input array<a name="line.485"></a> +<span class="sourceLineNo">486</span> * @param begin start index of the array to include<a name="line.486"></a> +<span class="sourceLineNo">487</span> * @param length number of elements to include from begin<a name="line.487"></a> +<span class="sourceLineNo">488</span> * @param original the value to be replaced with<a name="line.488"></a> +<span class="sourceLineNo">489</span> * @param replacement the value to be used for replacement<a name="line.489"></a> +<span class="sourceLineNo">490</span> * @return the copy of sliced array with replaced values<a name="line.490"></a> +<span class="sourceLineNo">491</span> */<a name="line.491"></a> +<span class="sourceLineNo">492</span> private static double[] replaceAndSlice(final double[] values,<a name="line.492"></a> +<span class="sourceLineNo">493</span> final int begin, final int length,<a name="line.493"></a> +<span class="sourceLineNo">494</span> final double original,<a name="line.494"></a> +<span class="sourceLineNo">495</span> final double replacement) {<a name="line.495"></a> +<span class="sourceLineNo">496</span> final double[] temp = copyOf(values, begin, length);<a name="line.496"></a> +<span class="sourceLineNo">497</span> for(int i = 0; i < length; i++) {<a name="line.497"></a> +<span class="sourceLineNo">498</span> temp[i] = Precision.equalsIncludingNaN(original, temp[i]) ?<a name="line.498"></a> +<span class="sourceLineNo">499</span> replacement : temp[i];<a name="line.499"></a> +<span class="sourceLineNo">500</span> }<a name="line.500"></a> +<span class="sourceLineNo">501</span> return temp;<a name="line.501"></a> +<span class="sourceLineNo">502</span> }<a name="line.502"></a> +<span class="sourceLineNo">503</span><a name="line.503"></a> +<span class="sourceLineNo">504</span> /**<a name="line.504"></a> +<span class="sourceLineNo">505</span> * Remove the occurrence of a given value in a copied slice of array<a name="line.505"></a> +<span class="sourceLineNo">506</span> * defined by the array part from [begin, begin+length).<a name="line.506"></a> +<span class="sourceLineNo">507</span> * @param values the input array<a name="line.507"></a> +<span class="sourceLineNo">508</span> * @param begin start index of the array to include<a name="line.508"></a> +<span class="sourceLineNo">509</span> * @param length number of elements to include from begin<a name="line.509"></a> +<span class="sourceLineNo">510</span> * @param removedValue the value to be removed from the sliced array<a name="line.510"></a> +<span class="sourceLineNo">511</span> * @return the copy of the sliced array after removing the removedValue<a name="line.511"></a> +<span class="sourceLineNo">512</span> */<a name="line.512"></a> +<span class="sourceLineNo">513</span> private static double[] removeAndSlice(final double[] values,<a name="line.513"></a> +<span class="sourceLineNo">514</span> final int begin, final int length,<a name="line.514"></a> +<span class="sourceLineNo">515</span> final double removedValue) {<a name="line.515"></a> +<span class="sourceLineNo">516</span> MathArrays.verifyValues(values, begin, length);<a name="line.516"></a> +<span class="sourceLineNo">517</span> final double[] temp;<a name="line.517"></a> +<span class="sourceLineNo">518</span> //BitSet(length) to indicate where the removedValue is located<a name="line.518"></a> +<span class="sourceLineNo">519</span> final BitSet bits = new BitSet(length);<a name="line.519"></a> +<span class="sourceLineNo">520</span> for (int i = begin; i < begin+length; i++) {<a name="line.520"></a> +<span class="sourceLineNo">521</span> if (Precision.equalsIncludingNaN(removedValue, values[i])) {<a name="line.521"></a> +<span class="sourceLineNo">522</span> bits.set(i - begin);<a name="line.522"></a> +<span class="sourceLineNo">523</span> }<a name="line.523"></a> +<span class="sourceLineNo">524</span> }<a name="line.524"></a> +<span class="sourceLineNo">525</span> //Check if empty then create a new copy<a name="line.525"></a> +<span class="sourceLineNo">526</span> if (bits.isEmpty()) {<a name="line.526"></a> +<span class="sourceLineNo">527</span> temp = copyOf(values, begin, length); // Nothing removed, just copy<a name="line.527"></a> +<span class="sourceLineNo">528</span> } else if(bits.cardinality() == length){<a name="line.528"></a> +<span class="sourceLineNo">529</span> temp = new double[0]; // All removed, just empty<a name="line.529"></a> +<span class="sourceLineNo">530</span> }else { // Some removable, so new<a name="line.530"></a> +<span class="sourceLineNo">531</span> temp = new double[length - bits.cardinality()];<a name="line.531"></a> +<span class="sourceLineNo">532</span> int start = begin; //start index from source array (i.e values)<a name="line.532"></a> +<span class="sourceLineNo">533</span> int dest = 0; //dest index in destination array(i.e temp)<a name="line.533"></a> +<span class="sourceLineNo">534</span> int nextOne = -1; //nextOne is the index of bit set of next one<a name="line.534"></a> +<span class="sourceLineNo">535</span> int bitSetPtr = 0; //bitSetPtr is start index pointer of bitset<a name="line.535"></a> +<span class="sourceLineNo">536</span> while ((nextOne = bits.nextSetBit(bitSetPtr)) != -1) {<a name="line.536"></a> +<span class="sourceLineNo">537</span> final int lengthToCopy = nextOne - bitSetPtr;<a name="line.537"></a> +<span class="sourceLineNo">538</span> System.arraycopy(values, start, temp, dest, lengthToCopy);<a name="line.538"></a> +<span class="sourceLineNo">539</span> dest += lengthToCopy;<a name="line.539"></a> +<span class="sourceLineNo">540</span> start = begin + (bitSetPtr = bits.nextClearBit(nextOne));<a name="line.540"></a> +<span class="sourceLineNo">541</span> }<a name="line.541"></a> +<span class="sourceLineNo">542</span> //Copy any residue past start index till begin+length<a name="line.542"></a> +<span class="sourceLineNo">543</span> if (start < begin + length) {<a name="line.543"></a> +<span class="sourceLineNo">544</span> System.arraycopy(values,start,temp,dest,begin + length - start);<a name="line.544"></a> +<span class="sourceLineNo">545</span> }<a name="line.545"></a> +<span class="sourceLineNo">546</span> }<a name="line.546"></a> +<span class="sourceLineNo">547</span> return temp;<a name="line.547"></a> +<span class="sourceLineNo">548</span> }<a name="line.548"></a> +<span class="sourceLineNo">549</span><a name="line.549"></a> +<span class="sourceLineNo">550</span> /**<a name="line.550"></a> +<span class="sourceLineNo">551</span> * Get pivots which is either cached or a newly created one<a name="line.551"></a> +<span class="sourceLineNo">552</span> *<a name="line.552"></a> +<span class="sourceLineNo">553</span> * @param values array containing the input numbers<a name="line.553"></a> +<span class="sourceLineNo">554</span> * @return cached pivots or a newly created one<a name="line.554"></a> +<span class="sourceLineNo">555</span> */<a name="line.555"></a> +<span class="sourceLineNo">556</span> private int[] getPivots(final double[] values) {<a name="line.556"></a> +<span class="sourceLineNo">557</span> final int[] pivotsHeap;<a name="line.557"></a> +<span class="sourceLineNo">558</span> if (values == getDataRef()) {<a name="line.558"></a> +<span class="sourceLineNo">559</span> pivotsHeap = cachedPivots;<a name="line.559"></a> +<span class="sourceLineNo">560</span> } else {<a name="line.560"></a> +<span class="sourceLineNo">561</span> pivotsHeap = new int[PIVOTS_HEAP_LENGTH];<a name="line.561"></a> +<span class="sourceLineNo">562</span> Arrays.fill(pivotsHeap, -1);<a name="line.562"></a> +<span class="sourceLineNo">563</span> }<a name="line.563"></a> +<span class="sourceLineNo">564</span> return pivotsHeap;<a name="line.564"></a> +<span class="sourceLineNo">565</span> }<a name="line.565"></a> +<span class="sourceLineNo">566</span><a name="line.566"></a> +<span class="sourceLineNo">567</span> /**<a name="line.567"></a> +<span class="sourceLineNo">568</span> * Get the estimation {@link EstimationType type} used for computation.<a name="line.568"></a> +<span class="sourceLineNo">569</span> *<a name="line.569"></a> +<span class="sourceLineNo">570</span> * @return the {@code estimationType} set<a name="line.570"></a> +<span class="sourceLineNo">571</span> */<a name="line.571"></a> +<span class="sourceLineNo">572</span> public EstimationType getEstimationType() {<a name="line.572"></a> +<span class="sourceLineNo">573</span> return estimationType;<a name="line.573"></a> +<span class="sourceLineNo">574</span> }<a name="line.574"></a> +<span class="sourceLineNo">575</span><a name="line.575"></a> +<span class="sourceLineNo">576</span> /**<a name="line.576"></a> +<span class="sourceLineNo">577</span> * Build a new instance similar to the current one except for the<a name="line.577"></a> +<span class="sourceLineNo">578</span> * {@link EstimationType estimation type}.<a name="line.578"></a> +<span class="sourceLineNo">579</span> * <p><a name="line.579"></a> +<span class="sourceLineNo">580</span> * This method is intended to be used as part of a fluent-type builder<a name="line.580"></a> +<span class="sourceLineNo">581</span> * pattern. Building finely tune instances should be done as follows:<a name="line.581"></a> +<span class="sourceLineNo">582</span> * </p><a name="line.582"></a> +<span class="sourceLineNo">583</span> * <pre><a name="line.583"></a> +<span class="sourceLineNo">584</span> * Percentile customized = new Percentile(quantile).<a name="line.584"></a> +<span class="sourceLineNo">585</span> * withEstimationType(estimationType).<a name="line.585"></a> +<span class="sourceLineNo">586</span> * withNaNStrategy(nanStrategy).<a name="line.586"></a> +<span class="sourceLineNo">587</span> * withKthSelector(kthSelector);<a name="line.587"></a> +<span class="sourceLineNo">588</span> * </pre><a name="line.588"></a> +<span class="sourceLineNo">589</span> * <p><a name="line.589"></a> +<span class="sourceLineNo">590</span> * If any of the {@code withXxx} method is omitted, the default value for<a name="line.590"></a> +<span class="sourceLineNo">591</span> * the corresponding customization parameter will be used.<a name="line.591"></a> +<span class="sourceLineNo">592</span> * </p><a name="line.592"></a> +<span class="sourceLineNo">593</span> * @param newEstimationType estimation type for the new instance<a name="line.593"></a> +<span class="sourceLineNo">594</span> * @return a new instance, with changed estimation type<a name="line.594"></a> +<span class="sourceLineNo">595</span> * @throws NullArgumentException when newEstimationType is null<a name="line.595"></a> +<span class="sourceLineNo">596</span> */<a name="line.596"></a> +<span class="sourceLineNo">597</span> public Percentile withEstimationType(final EstimationType newEstimationType) {<a name="line.597"></a> +<span class="sourceLineNo">598</span> return new Percentile(quantile, newEstimationType, nanStrategy, kthSelector);<a name="line.598"></a> +<span class="sourceLineNo">599</span> }<a name="line.599"></a> +<span class="sourceLineNo">600</span><a name="line.600"></a> +<span class="sourceLineNo">601</span> /**<a name="line.601"></a> +<span class="sourceLineNo">602</span> * Get the {@link NaNStrategy NaN Handling} strategy used for computation.<a name="line.602"></a> +<span class="sourceLineNo">603</span> * @return {@code NaN Handling} strategy set during construction<a name="line.603"></a> +<span class="sourceLineNo">604</span> */<a name="line.604"></a> +<span class="sourceLineNo">605</span> public NaNStrategy getNaNStrategy() {<a name="line.605"></a> +<span class="sourceLineNo">606</span> return nanStrategy;<a name="line.606"></a> +<span class="sourceLineNo">607</span> }<a name="line.607"></a> +<span class="sourceLineNo">608</span><a name="line.608"></a> +<span class="sourceLineNo">609</span> /**<a name="line.609"></a> +<span class="sourceLineNo">610</span> * Build a new instance similar to the current one except for the<a name="line.610"></a> +<span class="sourceLineNo">611</span> * {@link NaNStrategy NaN handling} strategy.<a name="line.611"></a> +<span class="sourceLineNo">612</span> * <p><a name="line.612"></a> +<span class="sourceLineNo">613</span> * This method is intended to be used as part of a fluent-type builder<a name="line.613"></a> +<span class="sourceLineNo">614</span> * pattern. Building finely tune instances should be done as follows:<a name="line.614"></a> +<span class="sourceLineNo">615</span> * </p><a name="line.615"></a> +<span class="sourceLineNo">616</span> * <pre><a name="line.616"></a> +<span class="sourceLineNo">617</span> * Percentile customized = new Percentile(quantile).<a name="line.617"></a> +<span class="sourceLineNo">618</span> * withEstimationType(estimationType).<a name="line.618"></a> +<span class="sourceLineNo">619</span> * withNaNStrategy(nanStrategy).<a name="line.619"></a> +<span class="sourceLineNo">620</span> * withKthSelector(kthSelector);<a name="line.620"></a> +<span class="sourceLineNo">621</span> * </pre><a name="line.621"></a> +<span class="sourceLineNo">622</span> * <p><a name="line.622"></a> +<span class="sourceLineNo">623</span> * If any of the {@code withXxx} method is omitted, the default value for<a name="line.623"></a> +<span class="sourceLineNo">624</span> * the corresponding customization parameter will be used.<a name="line.624"></a> +<span class="sourceLineNo">625</span> * </p><a name="line.625"></a> +<span class="sourceLineNo">626</span> * @param newNaNStrategy NaN strategy for the new instance<a name="line.626"></a> +<span class="sourceLineNo">627</span> * @return a new instance, with changed NaN handling strategy<a name="line.627"></a> +<span class="sourceLineNo">628</span> * @throws NullArgumentException when newNaNStrategy is null<a name="line.628"></a> +<span class="sourceLineNo">629</span> */<a name="line.629"></a> +<span class="sourceLineNo">630</span> public Percentile withNaNStrategy(final NaNStrategy newNaNStrategy) {<a name="line.630"></a> +<span class="sourceLineNo">631</span> return new Percentile(quantile, estimationType, newNaNStrategy, kthSelector);<a name="line.631"></a> +<span class="sourceLineNo">632</span> }<a name="line.632"></a> +<span class="sourceLineNo">633</span><a name="line.633"></a> +<span class="sourceLineNo">634</span> /**<a name="line.634"></a> +<span class="sourceLineNo">635</span> * Get the {@link KthSelector kthSelector} used for computation.<a name="line.635"></a> +<span class="sourceLineNo">636</span> * @return the {@code kthSelector} set<a name="line.636"></a> +<span class="sourceLineNo">637</span> */<a name="line.637"></a> +<span class="sourceLineNo">638</span> public KthSelector getKthSelector() {<a name="line.638"></a> +<span class="sourceLineNo">639</span> return kthSelector;<a name="line.639"></a> +<span class="sourceLineNo">640</span> }<a name="line.640"></a> +<span class="sourceLineNo">641</span><a name="line.641"></a> +<span class="sourceLineNo">642</span> /**<a name="line.642"></a> +<span class="sourceLineNo">643</span> * Get the {@link PivotingStrategyInterface} used in KthSelector for computation.<a name="line.643"></a> +<span class="sourceLineNo">644</span> * @return the pivoting strategy set<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> public PivotingStrategyInterface getPivotingStrategy() {<a name="line.646"></a> +<span class="sourceLineNo">647</span> return kthSelector.getPivotingStrategy();<a name="line.647"></a> +<span class="sourceLineNo">648</span> }<a name="line.648"></a> +<span class="sourceLineNo">649</span><a name="line.649"></a> +<span class="sourceLineNo">650</span> /**<a name="line.650"></a> +<span class="sourceLineNo">651</span> * Build a new instance similar to the current one except for the<a name="line.651"></a> +<span class="sourceLineNo">652</span> * {@link KthSelector kthSelector} instance specifically set.<a name="line.652"></a> +<span class="sourceLineNo">653</span> * <p><a name="line.653"></a> +<span class="sourceLineNo">654</span> * This method is intended to be used as part of a fluent-type builder<a name="line.654"></a> +<span class="sourceLineNo">655</span> * pattern. Building finely tune instances should be done as follows:<a name="line.655"></a> +<span class="sourceLineNo">656</span> * </p><a name="line.656"></a> +<span class="sourceLineNo">657</span> * <pre><a name="line.657"></a> +<span class="sourceLineNo">658</span> * Percentile customized = new Percentile(quantile).<a name="line.658"></a> +<span class="sourceLineNo">659</span> * withEstimationType(estimationType).<a name="line.659"></a> +<span class="sourceLineNo">660</span> * withNaNStrategy(nanStrategy).<a name="line.660"></a> +<span class="sourceLineNo">661</span> * withKthSelector(newKthSelector);<a name="line.661"></a> +<span class="sourceLineNo">662</span> * </pre><a name="line.662"></a> +<span class="sourceLineNo">663</span> * <p><a name="line.663"></a> +<span class="sourceLineNo">664</span> * If any of the {@code withXxx} method is omitted, the default value for<a name="line.664"></a> +<span class="sourceLineNo">665</span> * the corresponding customization parameter will be used.<a name="line.665"></a> +<span class="sourceLineNo">666</span> * </p><a name="line.666"></a> +<span class="sourceLineNo">667</span> * @param newKthSelector KthSelector for the new instance<a name="line.667"></a> +<span class="sourceLineNo">668</span> * @return a new instance, with changed KthSelector<a name="line.668"></a> +<span class="sourceLineNo">669</span> * @throws NullArgumentException when newKthSelector is null<a name="line.669"></a> +<span class="sourceLineNo">670</span> */<a name="line.670"></a> +<span class="sourceLineNo">671</span> public Percentile withKthSelector(final KthSelector newKthSelector) {<a name="line.671"></a> +<span class="sourceLineNo">672</span> return new Percentile(quantile, estimationType, nanStrategy,<a name="line.672"></a> +<span class="sourceLineNo">673</span> newKthSelector);<a name="line.673"></a> +<span class="sourceLineNo">674</span> }<a name="line.674"></a> +<span class="sourceLineNo">675</span><a name="line.675"></a> +<span class="sourceLineNo">676</span> /**<a name="line.676"></a> +<span class="sourceLineNo">677</span> * An enum for various estimation strategies of a percentile referred in<a name="line.677"></a> +<span class="sourceLineNo">678</span> * <a href="http://en.wikipedia.org/wiki/Quantile">wikipedia on quantile</a><a name="line.678"></a> +<span class="sourceLineNo">679</span> * with the names of enum matching those of types mentioned in<a name="line.679"></a> +<span class="sourceLineNo">680</span> * wikipedia.<a name="line.680"></a> +<span class="sourceLineNo">681</span> * <p><a name="line.681"></a> +<span class="sourceLineNo">682</span> * Each enum corresponding to the specific type of estimation in wikipedia<a name="line.682"></a> +<span class="sourceLineNo">683</span> * implements the respective formulae that specializes in the below aspects<a name="line.683"></a> +<span class="sourceLineNo">684</span> * <ul><a name="line.684"></a> +<span class="sourceLineNo">685</span> * <li>An <b>index method</b> to calculate approximate index of the<a name="line.685"></a> +<span class="sourceLineNo">686</span> * estimate</li><a name="line.686"></a> +<span class="sourceLineNo">687</span> * <li>An <b>estimate method</b> to estimate a value found at the earlier<a name="line.687"></a> +<span class="sourceLineNo">688</span> * computed index</li><a name="line.688"></a> +<span class="sourceLineNo">689</span> * <li>A <b> minLimit</b> on the quantile for which first element of sorted<a name="line.689"></a> +<span class="sourceLineNo">690</span> * input is returned as an estimate </li><a name="line.690"></a> +<span class="sourceLineNo">691</span> * <li>A <b> maxLimit</b> on the quantile for which last element of sorted<a name="line.691"></a> +<span class="sourceLineNo">692</span> * input is returned as an estimate </li><a name="line.692"></a> +<span class="sourceLineNo">693</span> * </ul><a name="line.693"></a> +<span class="sourceLineNo">694</span> * <p><a name="line.694"></a> +<span class="sourceLineNo">695</span> * Users can now create {@link Percentile} by explicitly passing this enum;<a name="line.695"></a> +<span class="sourceLineNo">696</span> * such as by invoking {@link Percentile#withEstimationType(EstimationType)}<a name="line.696"></a> +<span class="sourceLineNo">697</span> * <p><a name="line.697"></a> +<span class="sourceLineNo">698</span> * References:<a name="line.698"></a> +<span class="sourceLineNo">699</span> * <ol><a name="line.699"></a> +<span class="sourceLineNo">700</span> * <li><a name="line.700"></a> +<span class="sourceLineNo">701</span> * <a href="http://en.wikipedia.org/wiki/Quantile">Wikipedia on quantile</a><a name="line.701"></a> +<span class="sourceLineNo">702</span> * </li><a name="line.702"></a> +<span class="sourceLineNo">703</span> * <li><a name="line.703"></a> +<span class="sourceLineNo">704</span> * <a href="https://www.amherst.edu/media/view/129116/.../Sample+Quantiles.pdf"><a name="line.704"></a> +<span class="sourceLineNo">705</span> * Hyndman, R. J. and Fan, Y. (1996) Sample quantiles in statistical<a name="line.705"></a> +<span class="sourceLineNo">706</span> * packages, American Statistician 50, 361â365</a> </li><a name="line.706"></a> +<span class="sourceLineNo">707</span> * <li><a name="line.707"></a> +<span class="sourceLineNo">708</span> * <a href="http://stat.ethz.ch/R-manual/R-devel/library/stats/html/quantile.html"><a name="line.708"></a> +<span class="sourceLineNo">709</span> * R-Manual </a></li><a name="line.709"></a> +<span class="sourceLineNo">710</span> * </ol><a name="line.710"></a> +<span class="sourceLineNo">711</span> *<a name="line.711"></a> +<span class="sourceLineNo">712</span> */<a name="line.712"></a> +<span class="sourceLineNo">713</span> public static enum EstimationType {<a name="line.713"></a> +<span class="sourceLineNo">714</span> /**<a name="line.714"></a> +<span class="sourceLineNo">715</span> * This is the default type used in the {@link Percentile}.This method<a name="line.715"></a> +<span class="sourceLineNo">716</span> * has the following formulae for index and estimates<br><a name="line.716"></a> +<span class="sourceLineNo">717</span> * \( \begin{align}<a name="line.717"></a> +<span class="sourceLineNo">718</span> * &amp;index = (N+1)p\ \\<a name="line.718"></a> +<span class="sourceLineNo">719</span> * &amp;estimate = x_{\lceil h\,-\,1/2 \rceil} \\<a name="line.719"></a> +<span class="sourceLineNo">720</span> * &amp;minLimit = 0 \\<a name="line.720"></a> +<span class="sourceLineNo">721</span> * &amp;maxLimit = 1 \\<a name="line.721"></a> +<span class="sourceLineNo">722</span> * \end{align}\)<a name="line.722"></a> +<span class="sourceLineNo">723</span> */<a name="line.723"></a> +<span class="sourceLineNo">724</span> LEGACY("Legacy Apache Commons Math") {<a name="line.724"></a> +<span class="sourceLineNo">725</span> /**<a name="line.725"></a> +<span class="sourceLineNo">726</span> * {@inheritDoc}.This method in particular makes use of existing<a name="line.726"></a> +<span class="sourceLineNo">727</span> * Apache Commons Math style of picking up the index.<a name="line.727"></a> +<span class="sourceLineNo">728</span> */<a name="line.728"></a> +<span class="sourceLineNo">729</span> @Override<a name="line.729"></a> +<span class="sourceLineNo">730</span> protected double index(final double p, final int length) {<a name="line.730"></a> +<span class="sourceLineNo">731</span> final double minLimit = 0d;<a name="line.731"></a> +<span class="sourceLineNo">732</span> final double maxLimit = 1d;<a name="line.732"></a> +<span class="sourceLineNo">733</span> return Double.compare(p, minLimit) == 0 ? 0 :<a name="line.733"></a> +<span class="sourceLineNo">734</span> Double.compare(p, maxLimit) == 0 ?<a name="line.734"></a> +<span class="sourceLineNo">735</span> length : p * (length + 1);<a name="line.735"></a> +<span class="sourceLineNo">736</span> }<a name="line.736"></a> +<span class="sourceLineNo">737</span> },<a name="line.737"></a> +<span class="sourceLineNo">738</span> /**<a name="line.738"></a> +<span class="sourceLineNo">739</span> * The method R_1 has the following formulae for index and estimates<br><a name="line.739"></a> +<span class="sourceLineNo">740</span> * \( \begin{align}<a name="line.740"></a> +<span class="sourceLineNo">741</span> * &amp;index= Np + 1/2\, \\<a name="line.741"></a> +<span class="sourceLineNo">742</span> * &amp;estimate= x_{\lceil h\,-\,1/2 \rceil} \\<a name="line.742"></a> +<span class="sourceLineNo">743</span> * &amp;minLimit = 0 \\<a name="line.743"></a> +<span class="sourceLineNo">744</span> * \end{align}\)<a name="line.744"></a> +<span class="sourceLineNo">745</span> */<a name="line.745"></a> +<span class="sourceLineNo">746</span> R_1("R-1") {<a name="line.746"></a> +<span class="sourceLineNo">747</span><a name="line.747"></a> +<span class="sourceLineNo">748</span> @Override<a name="line.748"></a> +<span class="sourceLineNo">749</span> protected double index(final double p, final int length) {<a name="line.749"></a> +<span class="sourceLineNo">750</span> final double minLimit = 0d;<a name="line.750"></a> +<span class="sourceLineNo">751</span> return Double.compare(p, minLimit) == 0 ? 0 : length * p + 0.5;<a name="line.751"></a> +<span class="sourceLineNo">752</span> }<a name="line.752"></a> +<span class="sourceLineNo">753</span><a name="line.753"></a> +<span class="sourceLineNo">754</span> /**<a name="line.754"></a> +<span class="sourceLineNo">755</span> * {@inheritDoc}This method in particular for R_1 uses ceil(pos-0.5)<a name="line.755"></a> +<span class="sourceLineNo">756</span> */<a name="line.756"></a> +<span class="sourceLineNo">757</span> @Override<a name="line.757"></a> +<span class="sourceLineNo">758</span> protected double estimate(final double[] values,<a name="line.758"></a> +<span class="sourceLineNo">759</span> final int[] pivotsHeap, final double pos,<a name="line.759"></a> +<span class="sourceLineNo">760</span> final int length, final KthSelector kthSelector) {<a name="line.760"></a> +<span class="sourceLineNo">761</span> return super.estimate(values, pivotsHeap, FastMath.ceil(pos - 0.5), length, kthSelector);<a name="line.761"></a> +<span class="sourceLineNo">762</span> }<a name="line.762"></a> +<span class="sourceLineNo">763</span><a name="line.763"></a> +<span class="sourceLineNo">764</span> },<a name="line.764"></a> +<span class="sourceLineNo">765</span> /**<a name="line.765"></a> +<span class="sourceLineNo">766</span> * The method R_2 has the following formulae for index and estimates<br><a name="line.766"></a> +<span class="sourceLineNo">767</span> * \( \begin{align}<a name="line.767"></a> +<span class="sourceLineNo">768</span> * &amp;index= Np + 1/2\, \\<a name="line.768"></a> +<span class="sourceLineNo">769</span> * &amp;estimate=\frac{x_{\lceil h\,-\,1/2 \rceil} +<a name="line.769"></a> +<span class="sourceLineNo">770</span> * x_{\lfloor h\,+\,1/2 \rfloor}}{2} \\<a name="line.770"></a> +<span class="sourceLineNo">771</span> * &amp;minLimit = 0 \\<a name="line.771"></a> +<span class="sourceLineNo">772</span> * &amp;maxLimit = 1 \\<a name="line.772"></a> +<span class="sourceLineNo">773</span> * \end{align}\)<a name="line.773"></a> +<span class="sourceLineNo">774</span> */<a name="line.774"></a> +<span class="sourceLineNo">775</span> R_2("R-2") {<a name="line.775"></a> +<span class="sourceLineNo">776</span><a name="line.776"></a> +<span class="sourceLineNo">777</span> @Override<a name="line.777"></a> +<span class="sourceLineNo">778</span> protected double index(final double p, final int length) {<a name="line.778"></a> +<span class="sourceLineNo">779</span> final double minLimit = 0d;<a name="line.779"></a> +<span class="sourceLineNo">780</span> final double maxLimit = 1d;<a name="line.780"></a> +<span class="sourceLineNo">781</span> return Double.compare(p, maxLimit) == 0 ? length :<a name="line.781"></a> +<span class="sourceLineNo">782</span> Double.compare(p, minLimit) == 0 ? 0 : length * p + 0.5;<a name="line.782"></a> +<span class="sourceLineNo">783</span> }<a name="line.783"></a> +<span class="sourceLineNo">784</span><a name="line.784"></a> +<span class="sourceLineNo">785</span> /**<a name="line.785"></a> +<span class="sourceLineNo">786</span> * {@inheritDoc}This method in particular for R_2 averages the<a name="line.786"></a> +<span class="sourceLineNo">787</span> * values at ceil(p+0.5) and floor(p-0.5).<a name="line.787"></a> +<span class="sourceLineNo">788</span> */<a name="line.788"></a> +<span class="sourceLineNo">789</span> @Override<a name="line.789"></a> +<span class="sourceLineNo">790</span> protected double estimate(final double[] values,<a name="line.790"></a> +<span class="sourceLineNo">791</span> final int[] pivotsHeap, final double pos,<a name="line.791"></a> +<span class="sourceLineNo">792</span> final int length, final KthSelector kthSelector) {<a name="line.792"></a> +<span class="sourceLineNo">793</span> final double low =<a name="line.793"></a> +<span class="sourceLineNo">794</span> super.estimate(values, pivotsHeap, FastMath.ceil(pos - 0.5), length, kthSelector);<a name="line.794"></a> +<span class="sourceLineNo">795</span> final double high =<a name="line.795"></a> +<span class="sourceLineNo">796</span> super.estimate(values, pivotsHeap,FastMath.floor(pos + 0.5), length, kthSelector);<a name="line.796"></a> +<span class="sourceLineNo">797</span> return (low + high) / 2;<a name="line.797"></a> +<span class="sourceLineNo">798</span> }<a name="line.798"></a> +<span class="sourceLineNo">799</span><a name="line.799"></a> +<span class="sourceLineNo">800</span> },<a name="line.800"></a> +<span class="sourceLineNo">801</span> /**<a name="line.801"></a> +<span class="sourceLineNo">802</span> * The method R_3 has the following formulae for index and estimates<br><a name="line.802"></a> +<span class="sourceLineNo">803</span> * \( \begin{align}<a name="line.803"></a> +<span class="sourceLineNo">804</span> * &amp;index= Np \\<a name="line.804"></a> +<span class="sourceLineNo">805</span> * &amp;estimate= x_{\lfloor h \rceil}\, \\<a name="line.805"></a> +<span class="sourceLineNo">806</span> * &amp;minLimit = 0.5/N \\<a name="line.806"></a> +<span class="sourceLineNo">807</span> * \end{align}\)<a name="line.807"></a> +<span class="sourceLineNo">808</span> */<a name="line.808"></a> +<span class="sourceLineNo">809</span> R_3("R-3") {<a name="line.809"></a> +<span class="sourceLineNo">810</span> @Override<a name="line.810"></a> +<span class="sourceLineNo">811</span> protected double index(final double p, final int length) {<a name="line.811"></a> +<span class="sourceLineNo">812</span> final double minLimit = 1d/2 / length;<a name="line.812"></a> +<span class="sourceLineNo">813</span> return Double.compare(p, minLimit) <= 0 ?<a name="line.813"></a> +<span class="sourceLineNo">814</span> 0 : FastMath.rint(length * p);<a name="line.814"></a> +<span class="sourceLineNo">815</span> }<a name="line.815"></a> +<span class="sourceLineNo">816</span><a name="line.816"></a> +<span class="sourceLineNo">817</span> },<a name="line.817"></a> +<span class="sourceLineNo">818</span> /**<a name="line.818"></a> +<span class="sourceLineNo">819</span> * The method R_4 has the following formulae for index and estimates<br><a name="line.819"></a> +<span class="sourceLineNo">820</span> * \( \begin{align}<a name="line.820"></a> +<span class="sourceLineNo">821</span> * &amp;index= Np\, \\<a name="line.821"></a> +<span class="sourceLineNo">822</span> * &amp;estimate= x_{\lfloor h \rfloor} + (h -<a name="line.822"></a> +<span class="sourceLineNo">823</span> * \lfloor h \rfloor) (x_{\lfloor h \rfloor + 1} - x_{\lfloor h<a name="line.823"></a> +<span class="sourceLineNo">824</span> * \rfloor}) \\<a name="line.824"></a> +<span class="sourceLineNo">825</span> * &amp;minLimit = 1/N \\<a name="line.825"></a> +<span class="sourceLineNo">826</span> * &amp;maxLimit = 1 \\<a name="line.826"></a> +<span class="sourceLineNo">827</span> * \end{align}\)<a name="line.827"></a> +<span class="sourceLineNo">828</span> */<a name="line.828"></a> +<span class="sourceLineNo">829</span> R_4("R-4") {<a name="line.829"></a> +<span class="sourceLineNo">830</span> @Override<a name="line.830"></a> +<span class="sourceLineNo">831</span> protected double index(final double p, final int length) {<a name="line.831"></a> +<span class="sourceLineNo">832</span> final double minLimit = 1d / length;<a name="line.832"></a> +<span class="sourceLineNo">833</span> final double maxLimit = 1d;<a name="line.833"></a> +<span class="sourceLineNo">834</span> return Double.compare(p, minLimit) < 0 ? 0 :<a name="line.834"></a> +<span class="sourceLineNo">835</span> Double.compare(p, maxLimit) == 0 ? length : length * p;<a name="line.835"></a> +<span class="sourceLineNo">836</span> }<a name="line.836"></a> +<span class="sourceLineNo">837</span><a name="line.837"></a> +<span class="sourceLineNo">838</span> },<a name="line.838"></a> +<span class="sourceLineNo">839</span> /**<a name="line.839"></a> +<span class="sourceLineNo">840</span> * The method R_5 has the following formulae for index and estimates<br><a name="line.840"></a> +<span class="sourceLineNo">841</span> * \( \begin{align}<a name="line.841"></a> +<span class="sourceLineNo">842</span> * &amp;index= Np + 1/2\\<a name="line.842"></a> +<span class="sourceLineNo">843</span> * &amp;estimate= x_{\lfloor h \rfloor} + (h -<a name="line.843"></a>
[... 294 lines stripped ...]
