Added: websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.html ============================================================================== --- websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.html (added) +++ websites/production/commons/content/proper/commons-math/apidocs/src-html/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.html Sat Oct 18 20:10:38 2014 @@ -0,0 +1,1068 @@ +<!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.IOException;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.ObjectInputStream;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.io.Serializable;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.text.DecimalFormat;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.Collection;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.Collections;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.commons.math3.analysis.UnivariateFunction;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.commons.math3.analysis.interpolation.LinearInterpolator;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.commons.math3.analysis.interpolation.NevilleInterpolator;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.commons.math3.analysis.interpolation.UnivariateInterpolator;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.commons.math3.exception.InsufficientDataException;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.commons.math3.exception.OutOfRangeException;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.commons.math3.exception.util.LocalizedFormats;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.math3.stat.descriptive.AbstractStorelessUnivariateStatistic;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.commons.math3.stat.descriptive.StorelessUnivariateStatistic;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.commons.math3.util.MathArrays;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.commons.math3.util.MathUtils;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.commons.math3.util.Precision;<a name="line.40"></a> +<span class="sourceLineNo">041</span><a name="line.41"></a> +<span class="sourceLineNo">042</span>/**<a name="line.42"></a> +<span class="sourceLineNo">043</span> * A {@link StorelessUnivariateStatistic} estimating percentiles using the<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <ahref=http://www.cs.wustl.edu/~jain/papers/ftp/psqr.pdf>P<SUP>2</SUP></a><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Algorithm as explained by <a href=http://www.cse.wustl.edu/~jain/>Raj<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Jain</a> and Imrich Chlamtac in<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <a href=http://www.cse.wustl.edu/~jain/papers/psqr.htm>P<SUP>2</SUP> Algorithm<a name="line.47"></a> +<span class="sourceLineNo">048</span> * for Dynamic Calculation of Quantiles and Histogram Without Storing<a name="line.48"></a> +<span class="sourceLineNo">049</span> * Observations</a>.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * Note: This implementation is not synchronized and produces an approximate<a name="line.51"></a> +<span class="sourceLineNo">052</span> * result. For small samples, where data can be stored and processed in memory,<a name="line.52"></a> +<span class="sourceLineNo">053</span> * {@link Percentile} should be used.</p><a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span>public class PSquarePercentile extends AbstractStorelessUnivariateStatistic<a name="line.56"></a> +<span class="sourceLineNo">057</span> implements StorelessUnivariateStatistic, Serializable {<a name="line.57"></a> +<span class="sourceLineNo">058</span><a name="line.58"></a> +<span class="sourceLineNo">059</span> /**<a name="line.59"></a> +<span class="sourceLineNo">060</span> * The maximum array size used for psquare algorithm<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> private static final int PSQUARE_CONSTANT = 5;<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> /**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * A Default quantile needed in case if user prefers to use default no<a name="line.65"></a> +<span class="sourceLineNo">066</span> * argument constructor.<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> private static final double DEFAULT_QUANTILE_DESIRED = 50d;<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * Serial ID<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> private static final long serialVersionUID = 2283912083175715479L;<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * A decimal formatter for print convenience<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> private static final DecimalFormat DECIMAL_FORMAT = new DecimalFormat(<a name="line.78"></a> +<span class="sourceLineNo">079</span> "00.00");<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> /**<a name="line.81"></a> +<span class="sourceLineNo">082</span> * Initial list of 5 numbers corresponding to 5 markers. <b>NOTE:</b>watch<a name="line.82"></a> +<span class="sourceLineNo">083</span> * out for the add methods that are overloaded<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> private final List<Double> initialFive = new FixedCapacityList<Double>(<a name="line.85"></a> +<span class="sourceLineNo">086</span> PSQUARE_CONSTANT);<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * The quantile needed should be in range of 0-1. The constructor<a name="line.89"></a> +<span class="sourceLineNo">090</span> * {@link #PSquarePercentile(double)} ensures that passed in percentile is<a name="line.90"></a> +<span class="sourceLineNo">091</span> * divided by 100.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> private final double quantile;<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> * lastObservation is the last observation value/input sample. No need to<a name="line.96"></a> +<span class="sourceLineNo">097</span> * serialize<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> private transient double lastObservation;<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> /**<a name="line.101"></a> +<span class="sourceLineNo">102</span> * Markers is the marker collection object which comes to effect<a name="line.102"></a> +<span class="sourceLineNo">103</span> * only after 5 values are inserted<a name="line.103"></a> +<span class="sourceLineNo">104</span> */<a name="line.104"></a> +<span class="sourceLineNo">105</span> private PSquareMarkers markers = null;<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /**<a name="line.107"></a> +<span class="sourceLineNo">108</span> * Computed p value (i,e percentile value of data set hither to received)<a name="line.108"></a> +<span class="sourceLineNo">109</span> */<a name="line.109"></a> +<span class="sourceLineNo">110</span> private double pValue = Double.NaN;<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Counter to count the values/observations accepted into this data set<a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> private long countOfObservations;<a name="line.115"></a> +<span class="sourceLineNo">116</span><a name="line.116"></a> +<span class="sourceLineNo">117</span> /**<a name="line.117"></a> +<span class="sourceLineNo">118</span> * Constructs a PSquarePercentile with the specific percentile value.<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @param p the percentile<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @throws OutOfRangeException if p is not greater than 0 and less<a name="line.120"></a> +<span class="sourceLineNo">121</span> * than or equal to 100<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public PSquarePercentile(final double p) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> if (p > 100 || p < 0) {<a name="line.124"></a> +<span class="sourceLineNo">125</span> throw new OutOfRangeException(LocalizedFormats.OUT_OF_RANGE,<a name="line.125"></a> +<span class="sourceLineNo">126</span> p, 0, 100);<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span> this.quantile = p / 100d;// always set it within (0,1]<a name="line.128"></a> +<span class="sourceLineNo">129</span> }<a name="line.129"></a> +<span class="sourceLineNo">130</span><a name="line.130"></a> +<span class="sourceLineNo">131</span> /**<a name="line.131"></a> +<span class="sourceLineNo">132</span> * Default constructor that assumes a {@link #DEFAULT_QUANTILE_DESIRED<a name="line.132"></a> +<span class="sourceLineNo">133</span> * default quantile} needed<a name="line.133"></a> +<span class="sourceLineNo">134</span> */<a name="line.134"></a> +<span class="sourceLineNo">135</span> PSquarePercentile() {<a name="line.135"></a> +<span class="sourceLineNo">136</span> this(DEFAULT_QUANTILE_DESIRED);<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<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> * {@inheritDoc}<a name="line.140"></a> +<span class="sourceLineNo">141</span> */<a name="line.141"></a> +<span class="sourceLineNo">142</span> @Override<a name="line.142"></a> +<span class="sourceLineNo">143</span> public int hashCode() {<a name="line.143"></a> +<span class="sourceLineNo">144</span> double result = getResult();<a name="line.144"></a> +<span class="sourceLineNo">145</span> result = Double.isNaN(result) ? 37 : result;<a name="line.145"></a> +<span class="sourceLineNo">146</span> final double markersHash = markers == null ? 0 : markers.hashCode();<a name="line.146"></a> +<span class="sourceLineNo">147</span> final double[] toHash = {result, quantile, markersHash, countOfObservations};<a name="line.147"></a> +<span class="sourceLineNo">148</span> return Arrays.hashCode(toHash);<a name="line.148"></a> +<span class="sourceLineNo">149</span> }<a name="line.149"></a> +<span class="sourceLineNo">150</span><a name="line.150"></a> +<span class="sourceLineNo">151</span> /**<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Returns true iff {@code o} is a {@code PSquarePercentile} returning the<a name="line.152"></a> +<span class="sourceLineNo">153</span> * same values as this for {@code getResult()} and {@code getN()} and also<a name="line.153"></a> +<span class="sourceLineNo">154</span> * having equal markers<a name="line.154"></a> +<span class="sourceLineNo">155</span> *<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @param o object to compare<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @return true if {@code o} is a {@code PSquarePercentile} with<a name="line.157"></a> +<span class="sourceLineNo">158</span> * equivalent internal state<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> @Override<a name="line.160"></a> +<span class="sourceLineNo">161</span> public boolean equals(Object o) {<a name="line.161"></a> +<span class="sourceLineNo">162</span> boolean result = false;<a name="line.162"></a> +<span class="sourceLineNo">163</span> if (this == o) {<a name="line.163"></a> +<span class="sourceLineNo">164</span> result = true;<a name="line.164"></a> +<span class="sourceLineNo">165</span> } else if (o != null && o instanceof PSquarePercentile) {<a name="line.165"></a> +<span class="sourceLineNo">166</span> PSquarePercentile that = (PSquarePercentile) o;<a name="line.166"></a> +<span class="sourceLineNo">167</span> boolean isNotNull = markers != null && that.markers != null;<a name="line.167"></a> +<span class="sourceLineNo">168</span> boolean isNull = markers == null && that.markers == null;<a name="line.168"></a> +<span class="sourceLineNo">169</span> result = isNotNull ? markers.equals(that.markers) : isNull;<a name="line.169"></a> +<span class="sourceLineNo">170</span> // markers as in the case of first<a name="line.170"></a> +<span class="sourceLineNo">171</span> // five observations<a name="line.171"></a> +<span class="sourceLineNo">172</span> result = result && getN() == that.getN();<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span> return result;<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> * {@inheritDoc}The internal state updated due to the new value in this<a name="line.178"></a> +<span class="sourceLineNo">179</span> * context is basically of the marker positions and computation of the<a name="line.179"></a> +<span class="sourceLineNo">180</span> * approximate quantile.<a name="line.180"></a> +<span class="sourceLineNo">181</span> *<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param observation the observation currently being added.<a name="line.182"></a> +<span class="sourceLineNo">183</span> */<a name="line.183"></a> +<span class="sourceLineNo">184</span> @Override<a name="line.184"></a> +<span class="sourceLineNo">185</span> public void increment(final double observation) {<a name="line.185"></a> +<span class="sourceLineNo">186</span> // Increment counter<a name="line.186"></a> +<span class="sourceLineNo">187</span> countOfObservations++;<a name="line.187"></a> +<span class="sourceLineNo">188</span><a name="line.188"></a> +<span class="sourceLineNo">189</span> // Store last observation<a name="line.189"></a> +<span class="sourceLineNo">190</span> this.lastObservation = observation;<a name="line.190"></a> +<span class="sourceLineNo">191</span><a name="line.191"></a> +<span class="sourceLineNo">192</span> // 0. Use Brute force for <5<a name="line.192"></a> +<span class="sourceLineNo">193</span> if (markers == null) {<a name="line.193"></a> +<span class="sourceLineNo">194</span> if (initialFive.add(observation)) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> Collections.sort(initialFive);<a name="line.195"></a> +<span class="sourceLineNo">196</span> pValue =<a name="line.196"></a> +<span class="sourceLineNo">197</span> initialFive<a name="line.197"></a> +<span class="sourceLineNo">198</span> .get((int) (quantile * (initialFive.size() - 1)));<a name="line.198"></a> +<span class="sourceLineNo">199</span> return;<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span> // 1. Initialize once after 5th observation<a name="line.201"></a> +<span class="sourceLineNo">202</span> markers = newMarkers(initialFive, quantile);<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span> // 2. process a Data Point and return pValue<a name="line.204"></a> +<span class="sourceLineNo">205</span> pValue = markers.processDataPoint(observation);<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Returns a string containing the last observation, the current estimate<a name="line.209"></a> +<span class="sourceLineNo">210</span> * of the quantile and all markers.<a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @return string representation of state data<a name="line.212"></a> +<span class="sourceLineNo">213</span> */<a name="line.213"></a> +<span class="sourceLineNo">214</span> @Override<a name="line.214"></a> +<span class="sourceLineNo">215</span> public String toString() {<a name="line.215"></a> +<span class="sourceLineNo">216</span><a name="line.216"></a> +<span class="sourceLineNo">217</span> if (markers == null) {<a name="line.217"></a> +<span class="sourceLineNo">218</span> return String.format("obs=%s pValue=%s",<a name="line.218"></a> +<span class="sourceLineNo">219</span> DECIMAL_FORMAT.format(lastObservation),<a name="line.219"></a> +<span class="sourceLineNo">220</span> DECIMAL_FORMAT.format(pValue));<a name="line.220"></a> +<span class="sourceLineNo">221</span> } else {<a name="line.221"></a> +<span class="sourceLineNo">222</span> return String.format("obs=%s markers=%s",<a name="line.222"></a> +<span class="sourceLineNo">223</span> DECIMAL_FORMAT.format(lastObservation), markers.toString());<a name="line.223"></a> +<span class="sourceLineNo">224</span> }<a name="line.224"></a> +<span class="sourceLineNo">225</span> }<a name="line.225"></a> +<span class="sourceLineNo">226</span><a name="line.226"></a> +<span class="sourceLineNo">227</span> /**<a name="line.227"></a> +<span class="sourceLineNo">228</span> * {@inheritDoc}<a name="line.228"></a> +<span class="sourceLineNo">229</span> */<a name="line.229"></a> +<span class="sourceLineNo">230</span> public long getN() {<a name="line.230"></a> +<span class="sourceLineNo">231</span> return countOfObservations;<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span><a name="line.233"></a> +<span class="sourceLineNo">234</span> /**<a name="line.234"></a> +<span class="sourceLineNo">235</span> * {@inheritDoc}<a name="line.235"></a> +<span class="sourceLineNo">236</span> */<a name="line.236"></a> +<span class="sourceLineNo">237</span> @Override<a name="line.237"></a> +<span class="sourceLineNo">238</span> public StorelessUnivariateStatistic copy() {<a name="line.238"></a> +<span class="sourceLineNo">239</span> // multiply quantile by 100 now as anyway constructor divides it by 100<a name="line.239"></a> +<span class="sourceLineNo">240</span> PSquarePercentile copy = new PSquarePercentile(100d * quantile);<a name="line.240"></a> +<span class="sourceLineNo">241</span><a name="line.241"></a> +<span class="sourceLineNo">242</span> if (markers != null) {<a name="line.242"></a> +<span class="sourceLineNo">243</span> copy.markers = (PSquareMarkers) markers.clone();<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span> copy.countOfObservations = countOfObservations;<a name="line.245"></a> +<span class="sourceLineNo">246</span> copy.pValue = pValue;<a name="line.246"></a> +<span class="sourceLineNo">247</span> copy.initialFive.clear();<a name="line.247"></a> +<span class="sourceLineNo">248</span> copy.initialFive.addAll(initialFive);<a name="line.248"></a> +<span class="sourceLineNo">249</span> return copy;<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Returns the quantile estimated by this statistic in the range [0.0-1.0]<a name="line.253"></a> +<span class="sourceLineNo">254</span> *<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @return quantile estimated by {@link #getResult()}<a name="line.255"></a> +<span class="sourceLineNo">256</span> */<a name="line.256"></a> +<span class="sourceLineNo">257</span> public double quantile() {<a name="line.257"></a> +<span class="sourceLineNo">258</span> return quantile;<a name="line.258"></a> +<span class="sourceLineNo">259</span> }<a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> /**<a name="line.261"></a> +<span class="sourceLineNo">262</span> * {@inheritDoc}. This basically clears all the markers, the<a name="line.262"></a> +<span class="sourceLineNo">263</span> * initialFive list and sets countOfObservations to 0.<a name="line.263"></a> +<span class="sourceLineNo">264</span> */<a name="line.264"></a> +<span class="sourceLineNo">265</span> @Override<a name="line.265"></a> +<span class="sourceLineNo">266</span> public void clear() {<a name="line.266"></a> +<span class="sourceLineNo">267</span> markers = null;<a name="line.267"></a> +<span class="sourceLineNo">268</span> initialFive.clear();<a name="line.268"></a> +<span class="sourceLineNo">269</span> countOfObservations = 0L;<a name="line.269"></a> +<span class="sourceLineNo">270</span> pValue = Double.NaN;<a name="line.270"></a> +<span class="sourceLineNo">271</span> }<a name="line.271"></a> +<span class="sourceLineNo">272</span><a name="line.272"></a> +<span class="sourceLineNo">273</span> /**<a name="line.273"></a> +<span class="sourceLineNo">274</span> * {@inheritDoc}<a name="line.274"></a> +<span class="sourceLineNo">275</span> */<a name="line.275"></a> +<span class="sourceLineNo">276</span> @Override<a name="line.276"></a> +<span class="sourceLineNo">277</span> public double getResult() {<a name="line.277"></a> +<span class="sourceLineNo">278</span> if (Double.compare(quantile, 1d) == 0) {<a name="line.278"></a> +<span class="sourceLineNo">279</span> pValue = maximum();<a name="line.279"></a> +<span class="sourceLineNo">280</span> } else if (Double.compare(quantile, 0d) == 0) {<a name="line.280"></a> +<span class="sourceLineNo">281</span> pValue = minimum();<a name="line.281"></a> +<span class="sourceLineNo">282</span> }<a name="line.282"></a> +<span class="sourceLineNo">283</span> return pValue;<a name="line.283"></a> +<span class="sourceLineNo">284</span> }<a name="line.284"></a> +<span class="sourceLineNo">285</span><a name="line.285"></a> +<span class="sourceLineNo">286</span> /**<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @return maximum in the data set added to this statistic<a name="line.287"></a> +<span class="sourceLineNo">288</span> */<a name="line.288"></a> +<span class="sourceLineNo">289</span> private double maximum() {<a name="line.289"></a> +<span class="sourceLineNo">290</span> double val = Double.NaN;<a name="line.290"></a> +<span class="sourceLineNo">291</span> if (markers != null) {<a name="line.291"></a> +<span class="sourceLineNo">292</span> val = markers.height(PSQUARE_CONSTANT);<a name="line.292"></a> +<span class="sourceLineNo">293</span> } else if (!initialFive.isEmpty()) {<a name="line.293"></a> +<span class="sourceLineNo">294</span> val = initialFive.get(initialFive.size() - 1);<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span> return val;<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> /**<a name="line.299"></a> +<span class="sourceLineNo">300</span> * @return minimum in the data set added to this statistic<a name="line.300"></a> +<span class="sourceLineNo">301</span> */<a name="line.301"></a> +<span class="sourceLineNo">302</span> private double minimum() {<a name="line.302"></a> +<span class="sourceLineNo">303</span> double val = Double.NaN;<a name="line.303"></a> +<span class="sourceLineNo">304</span> if (markers != null) {<a name="line.304"></a> +<span class="sourceLineNo">305</span> val = markers.height(1);<a name="line.305"></a> +<span class="sourceLineNo">306</span> } else if (!initialFive.isEmpty()) {<a name="line.306"></a> +<span class="sourceLineNo">307</span> val = initialFive.get(0);<a name="line.307"></a> +<span class="sourceLineNo">308</span> }<a name="line.308"></a> +<span class="sourceLineNo">309</span> return val;<a name="line.309"></a> +<span class="sourceLineNo">310</span> }<a name="line.310"></a> +<span class="sourceLineNo">311</span><a name="line.311"></a> +<span class="sourceLineNo">312</span> /**<a name="line.312"></a> +<span class="sourceLineNo">313</span> * Markers is an encapsulation of the five markers/buckets as indicated in<a name="line.313"></a> +<span class="sourceLineNo">314</span> * the original works.<a name="line.314"></a> +<span class="sourceLineNo">315</span> */<a name="line.315"></a> +<span class="sourceLineNo">316</span> private static class Markers implements PSquareMarkers, Serializable {<a name="line.316"></a> +<span class="sourceLineNo">317</span> /**<a name="line.317"></a> +<span class="sourceLineNo">318</span> * Serial version id<a name="line.318"></a> +<span class="sourceLineNo">319</span> */<a name="line.319"></a> +<span class="sourceLineNo">320</span> private static final long serialVersionUID = 1L;<a name="line.320"></a> +<span class="sourceLineNo">321</span><a name="line.321"></a> +<span class="sourceLineNo">322</span> /** Low marker index */<a name="line.322"></a> +<span class="sourceLineNo">323</span> private static final int LOW = 2;<a name="line.323"></a> +<span class="sourceLineNo">324</span><a name="line.324"></a> +<span class="sourceLineNo">325</span> /** High marker index */<a name="line.325"></a> +<span class="sourceLineNo">326</span> private static final int HIGH = 4;<a name="line.326"></a> +<span class="sourceLineNo">327</span><a name="line.327"></a> +<span class="sourceLineNo">328</span> /**<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Array of 5+1 Markers (The first marker is dummy just so we<a name="line.329"></a> +<span class="sourceLineNo">330</span> * can match the rest of indexes [1-5] indicated in the original works<a name="line.330"></a> +<span class="sourceLineNo">331</span> * which follows unit based index)<a name="line.331"></a> +<span class="sourceLineNo">332</span> */<a name="line.332"></a> +<span class="sourceLineNo">333</span> private final Marker[] markerArray;<a name="line.333"></a> +<span class="sourceLineNo">334</span><a name="line.334"></a> +<span class="sourceLineNo">335</span> /**<a name="line.335"></a> +<span class="sourceLineNo">336</span> * Kth cell belonging to [1-5] of the markerArray. No need for<a name="line.336"></a> +<span class="sourceLineNo">337</span> * this to be serialized<a name="line.337"></a> +<span class="sourceLineNo">338</span> */<a name="line.338"></a> +<span class="sourceLineNo">339</span> private transient int k = -1;<a name="line.339"></a> +<span class="sourceLineNo">340</span><a name="line.340"></a> +<span class="sourceLineNo">341</span> /**<a name="line.341"></a> +<span class="sourceLineNo">342</span> * Constructor<a name="line.342"></a> +<span class="sourceLineNo">343</span> *<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param theMarkerArray marker array to be used<a name="line.344"></a> +<span class="sourceLineNo">345</span> */<a name="line.345"></a> +<span class="sourceLineNo">346</span> private Markers(final Marker[] theMarkerArray) {<a name="line.346"></a> +<span class="sourceLineNo">347</span> MathUtils.checkNotNull(theMarkerArray);<a name="line.347"></a> +<span class="sourceLineNo">348</span> markerArray = theMarkerArray;<a name="line.348"></a> +<span class="sourceLineNo">349</span> for (int i = 1; i < PSQUARE_CONSTANT; i++) {<a name="line.349"></a> +<span class="sourceLineNo">350</span> markerArray[i].previous(markerArray[i - 1])<a name="line.350"></a> +<span class="sourceLineNo">351</span> .next(markerArray[i + 1]).index(i);<a name="line.351"></a> +<span class="sourceLineNo">352</span> }<a name="line.352"></a> +<span class="sourceLineNo">353</span> markerArray[0].previous(markerArray[0]).next(markerArray[1])<a name="line.353"></a> +<span class="sourceLineNo">354</span> .index(0);<a name="line.354"></a> +<span class="sourceLineNo">355</span> markerArray[5].previous(markerArray[4]).next(markerArray[5])<a name="line.355"></a> +<span class="sourceLineNo">356</span> .index(5);<a name="line.356"></a> +<span class="sourceLineNo">357</span> }<a name="line.357"></a> +<span class="sourceLineNo">358</span><a name="line.358"></a> +<span class="sourceLineNo">359</span> /**<a name="line.359"></a> +<span class="sourceLineNo">360</span> * Constructor<a name="line.360"></a> +<span class="sourceLineNo">361</span> *<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @param initialFive elements required to build Marker<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @param p quantile required to be computed<a name="line.363"></a> +<span class="sourceLineNo">364</span> */<a name="line.364"></a> +<span class="sourceLineNo">365</span> private Markers(final List<Double> initialFive, final double p) {<a name="line.365"></a> +<span class="sourceLineNo">366</span> this(createMarkerArray(initialFive, p));<a name="line.366"></a> +<span class="sourceLineNo">367</span> }<a name="line.367"></a> +<span class="sourceLineNo">368</span><a name="line.368"></a> +<span class="sourceLineNo">369</span> /**<a name="line.369"></a> +<span class="sourceLineNo">370</span> * Creates a marker array using initial five elements and a quantile<a name="line.370"></a> +<span class="sourceLineNo">371</span> *<a name="line.371"></a> +<span class="sourceLineNo">372</span> * @param initialFive list of initial five elements<a name="line.372"></a> +<span class="sourceLineNo">373</span> * @param p the pth quantile<a name="line.373"></a> +<span class="sourceLineNo">374</span> * @return Marker array<a name="line.374"></a> +<span class="sourceLineNo">375</span> */<a name="line.375"></a> +<span class="sourceLineNo">376</span> private static Marker[] createMarkerArray(<a name="line.376"></a> +<span class="sourceLineNo">377</span> final List<Double> initialFive, final double p) {<a name="line.377"></a> +<span class="sourceLineNo">378</span> final int countObserved =<a name="line.378"></a> +<span class="sourceLineNo">379</span> initialFive == null ? -1 : initialFive.size();<a name="line.379"></a> +<span class="sourceLineNo">380</span> if (countObserved < PSQUARE_CONSTANT) {<a name="line.380"></a> +<span class="sourceLineNo">381</span> throw new InsufficientDataException(<a name="line.381"></a> +<span class="sourceLineNo">382</span> LocalizedFormats.INSUFFICIENT_OBSERVED_POINTS_IN_SAMPLE,<a name="line.382"></a> +<span class="sourceLineNo">383</span> countObserved, PSQUARE_CONSTANT);<a name="line.383"></a> +<span class="sourceLineNo">384</span> }<a name="line.384"></a> +<span class="sourceLineNo">385</span> Collections.sort(initialFive);<a name="line.385"></a> +<span class="sourceLineNo">386</span> return new Marker[] {<a name="line.386"></a> +<span class="sourceLineNo">387</span> new Marker(),// Null Marker<a name="line.387"></a> +<span class="sourceLineNo">388</span> new Marker(initialFive.get(0), 1, 0, 1),<a name="line.388"></a> +<span class="sourceLineNo">389</span> new Marker(initialFive.get(1), 1 + 2 * p, p / 2, 2),<a name="line.389"></a> +<span class="sourceLineNo">390</span> new Marker(initialFive.get(2), 1 + 4 * p, p, 3),<a name="line.390"></a> +<span class="sourceLineNo">391</span> new Marker(initialFive.get(3), 3 + 2 * p, (1 + p) / 2, 4),<a name="line.391"></a> +<span class="sourceLineNo">392</span> new Marker(initialFive.get(4), 5, 1, 5) };<a name="line.392"></a> +<span class="sourceLineNo">393</span> }<a name="line.393"></a> +<span class="sourceLineNo">394</span><a name="line.394"></a> +<span class="sourceLineNo">395</span> /**<a name="line.395"></a> +<span class="sourceLineNo">396</span> * {@inheritDoc}<a name="line.396"></a> +<span class="sourceLineNo">397</span> */<a name="line.397"></a> +<span class="sourceLineNo">398</span> @Override<a name="line.398"></a> +<span class="sourceLineNo">399</span> public int hashCode() {<a name="line.399"></a> +<span class="sourceLineNo">400</span> return Arrays.deepHashCode(markerArray);<a name="line.400"></a> +<span class="sourceLineNo">401</span> }<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> * {@inheritDoc}.This equals method basically checks for marker array to<a name="line.404"></a> +<span class="sourceLineNo">405</span> * be deep equals.<a name="line.405"></a> +<span class="sourceLineNo">406</span> *<a name="line.406"></a> +<span class="sourceLineNo">407</span> * @param o is the other object<a name="line.407"></a> +<span class="sourceLineNo">408</span> * @return true if the object compares with this object are equivalent<a name="line.408"></a> +<span class="sourceLineNo">409</span> */<a name="line.409"></a> +<span class="sourceLineNo">410</span> @Override<a name="line.410"></a> +<span class="sourceLineNo">411</span> public boolean equals(Object o) {<a name="line.411"></a> +<span class="sourceLineNo">412</span> boolean result = false;<a name="line.412"></a> +<span class="sourceLineNo">413</span> if (this == o) {<a name="line.413"></a> +<span class="sourceLineNo">414</span> result = true;<a name="line.414"></a> +<span class="sourceLineNo">415</span> } else if (o != null && o instanceof Markers) {<a name="line.415"></a> +<span class="sourceLineNo">416</span> Markers that = (Markers) o;<a name="line.416"></a> +<span class="sourceLineNo">417</span> result = Arrays.deepEquals(markerArray, that.markerArray);<a name="line.417"></a> +<span class="sourceLineNo">418</span> }<a name="line.418"></a> +<span class="sourceLineNo">419</span> return result;<a name="line.419"></a> +<span class="sourceLineNo">420</span> }<a name="line.420"></a> +<span class="sourceLineNo">421</span><a name="line.421"></a> +<span class="sourceLineNo">422</span> /**<a name="line.422"></a> +<span class="sourceLineNo">423</span> * Process a data point<a name="line.423"></a> +<span class="sourceLineNo">424</span> *<a name="line.424"></a> +<span class="sourceLineNo">425</span> * @param inputDataPoint is the data point passed<a name="line.425"></a> +<span class="sourceLineNo">426</span> * @return computed percentile<a name="line.426"></a> +<span class="sourceLineNo">427</span> */<a name="line.427"></a> +<span class="sourceLineNo">428</span> public double processDataPoint(final double inputDataPoint) {<a name="line.428"></a> +<span class="sourceLineNo">429</span><a name="line.429"></a> +<span class="sourceLineNo">430</span> // 1. Find cell and update minima and maxima<a name="line.430"></a> +<span class="sourceLineNo">431</span> final int kthCell = findCellAndUpdateMinMax(inputDataPoint);<a name="line.431"></a> +<span class="sourceLineNo">432</span><a name="line.432"></a> +<span class="sourceLineNo">433</span> // 2. Increment positions<a name="line.433"></a> +<span class="sourceLineNo">434</span> incrementPositions(1, kthCell + 1, 5);<a name="line.434"></a> +<span class="sourceLineNo">435</span><a name="line.435"></a> +<span class="sourceLineNo">436</span> // 2a. Update desired position with increments<a name="line.436"></a> +<span class="sourceLineNo">437</span> updateDesiredPositions();<a name="line.437"></a> +<span class="sourceLineNo">438</span><a name="line.438"></a> +<span class="sourceLineNo">439</span> // 3. Adjust heights of m[2-4] if necessary<a name="line.439"></a> +<span class="sourceLineNo">440</span> adjustHeightsOfMarkers();<a name="line.440"></a> +<span class="sourceLineNo">441</span><a name="line.441"></a> +<span class="sourceLineNo">442</span> // 4. Return percentile<a name="line.442"></a> +<span class="sourceLineNo">443</span> return getPercentileValue();<a name="line.443"></a> +<span class="sourceLineNo">444</span> }<a name="line.444"></a> +<span class="sourceLineNo">445</span><a name="line.445"></a> +<span class="sourceLineNo">446</span> /**<a name="line.446"></a> +<span class="sourceLineNo">447</span> * Returns the percentile computed thus far.<a name="line.447"></a> +<span class="sourceLineNo">448</span> *<a name="line.448"></a> +<span class="sourceLineNo">449</span> * @return height of mid point marker<a name="line.449"></a> +<span class="sourceLineNo">450</span> */<a name="line.450"></a> +<span class="sourceLineNo">451</span> public double getPercentileValue() {<a name="line.451"></a> +<span class="sourceLineNo">452</span> return height(3);<a name="line.452"></a> +<span class="sourceLineNo">453</span> }<a name="line.453"></a> +<span class="sourceLineNo">454</span><a name="line.454"></a> +<span class="sourceLineNo">455</span> /**<a name="line.455"></a> +<span class="sourceLineNo">456</span> * Finds the cell where the input observation / value fits.<a name="line.456"></a> +<span class="sourceLineNo">457</span> *<a name="line.457"></a> +<span class="sourceLineNo">458</span> * @param observation the input value to be checked for<a name="line.458"></a> +<span class="sourceLineNo">459</span> * @return kth cell (of the markers ranging from 1-5) where observed<a name="line.459"></a> +<span class="sourceLineNo">460</span> * sample fits<a name="line.460"></a> +<span class="sourceLineNo">461</span> */<a name="line.461"></a> +<span class="sourceLineNo">462</span> private int findCellAndUpdateMinMax(final double observation) {<a name="line.462"></a> +<span class="sourceLineNo">463</span> k = -1;<a name="line.463"></a> +<span class="sourceLineNo">464</span> if (observation < height(1)) {<a name="line.464"></a> +<span class="sourceLineNo">465</span> markerArray[1].markerHeight = observation;<a name="line.465"></a> +<span class="sourceLineNo">466</span> k = 1;<a name="line.466"></a> +<span class="sourceLineNo">467</span> } else if (observation < height(2)) {<a name="line.467"></a> +<span class="sourceLineNo">468</span> k = 1;<a name="line.468"></a> +<span class="sourceLineNo">469</span> } else if (observation < height(3)) {<a name="line.469"></a> +<span class="sourceLineNo">470</span> k = 2;<a name="line.470"></a> +<span class="sourceLineNo">471</span> } else if (observation < height(4)) {<a name="line.471"></a> +<span class="sourceLineNo">472</span> k = 3;<a name="line.472"></a> +<span class="sourceLineNo">473</span> } else if (observation <= height(5)) {<a name="line.473"></a> +<span class="sourceLineNo">474</span> k = 4;<a name="line.474"></a> +<span class="sourceLineNo">475</span> } else {<a name="line.475"></a> +<span class="sourceLineNo">476</span> markerArray[5].markerHeight = observation;<a name="line.476"></a> +<span class="sourceLineNo">477</span> k = 4;<a name="line.477"></a> +<span class="sourceLineNo">478</span> }<a name="line.478"></a> +<span class="sourceLineNo">479</span> return k;<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> * Adjust marker heights by setting quantile estimates to middle markers.<a name="line.483"></a> +<span class="sourceLineNo">484</span> */<a name="line.484"></a> +<span class="sourceLineNo">485</span> private void adjustHeightsOfMarkers() {<a name="line.485"></a> +<span class="sourceLineNo">486</span> for (int i = LOW; i <= HIGH; i++) {<a name="line.486"></a> +<span class="sourceLineNo">487</span> estimate(i);<a name="line.487"></a> +<span class="sourceLineNo">488</span> }<a name="line.488"></a> +<span class="sourceLineNo">489</span> }<a name="line.489"></a> +<span class="sourceLineNo">490</span><a name="line.490"></a> +<span class="sourceLineNo">491</span> /**<a name="line.491"></a> +<span class="sourceLineNo">492</span> * {@inheritDoc}<a name="line.492"></a> +<span class="sourceLineNo">493</span> */<a name="line.493"></a> +<span class="sourceLineNo">494</span> public double estimate(final int index) {<a name="line.494"></a> +<span class="sourceLineNo">495</span> if (index < LOW || index > HIGH) {<a name="line.495"></a> +<span class="sourceLineNo">496</span> throw new OutOfRangeException(index, LOW, HIGH);<a name="line.496"></a> +<span class="sourceLineNo">497</span> }<a name="line.497"></a> +<span class="sourceLineNo">498</span> return markerArray[index].estimate();<a name="line.498"></a> +<span class="sourceLineNo">499</span> }<a name="line.499"></a> +<span class="sourceLineNo">500</span><a name="line.500"></a> +<span class="sourceLineNo">501</span> /**<a name="line.501"></a> +<span class="sourceLineNo">502</span> * Increment positions by d. Refer to algorithm paper for the<a name="line.502"></a> +<span class="sourceLineNo">503</span> * definition of d.<a name="line.503"></a> +<span class="sourceLineNo">504</span> *<a name="line.504"></a> +<span class="sourceLineNo">505</span> * @param d The increment value for the position<a name="line.505"></a> +<span class="sourceLineNo">506</span> * @param startIndex start index of the marker array<a name="line.506"></a> +<span class="sourceLineNo">507</span> * @param endIndex end index of the marker array<a name="line.507"></a> +<span class="sourceLineNo">508</span> */<a name="line.508"></a> +<span class="sourceLineNo">509</span> private void incrementPositions(final int d, final int startIndex,<a name="line.509"></a> +<span class="sourceLineNo">510</span> final int endIndex) {<a name="line.510"></a> +<span class="sourceLineNo">511</span> for (int i = startIndex; i <= endIndex; i++) {<a name="line.511"></a> +<span class="sourceLineNo">512</span> markerArray[i].incrementPosition(d);<a name="line.512"></a> +<span class="sourceLineNo">513</span> }<a name="line.513"></a> +<span class="sourceLineNo">514</span> }<a name="line.514"></a> +<span class="sourceLineNo">515</span><a name="line.515"></a> +<span class="sourceLineNo">516</span> /**<a name="line.516"></a> +<span class="sourceLineNo">517</span> * Desired positions incremented by bucket width. The bucket width is<a name="line.517"></a> +<span class="sourceLineNo">518</span> * basically the desired increments.<a name="line.518"></a> +<span class="sourceLineNo">519</span> */<a name="line.519"></a> +<span class="sourceLineNo">520</span> private void updateDesiredPositions() {<a name="line.520"></a> +<span class="sourceLineNo">521</span> for (int i = 1; i < markerArray.length; i++) {<a name="line.521"></a> +<span class="sourceLineNo">522</span> markerArray[i].updateDesiredPosition();<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><a name="line.525"></a> +<span class="sourceLineNo">526</span> /**<a name="line.526"></a> +<span class="sourceLineNo">527</span> * Sets previous and next markers after default read is done.<a name="line.527"></a> +<span class="sourceLineNo">528</span> *<a name="line.528"></a> +<span class="sourceLineNo">529</span> * @param anInputStream the input stream to be deserialized<a name="line.529"></a> +<span class="sourceLineNo">530</span> * @throws ClassNotFoundException thrown when a desired class not found<a name="line.530"></a> +<span class="sourceLineNo">531</span> * @throws IOException thrown due to any io errors<a name="line.531"></a> +<span class="sourceLineNo">532</span> */<a name="line.532"></a> +<span class="sourceLineNo">533</span> private void readObject(ObjectInputStream anInputStream)<a name="line.533"></a> +<span class="sourceLineNo">534</span> throws ClassNotFoundException, IOException {<a name="line.534"></a> +<span class="sourceLineNo">535</span> // always perform the default de-serialization first<a name="line.535"></a> +<span class="sourceLineNo">536</span> anInputStream.defaultReadObject();<a name="line.536"></a> +<span class="sourceLineNo">537</span> // Build links<a name="line.537"></a> +<span class="sourceLineNo">538</span> for (int i = 1; i < PSQUARE_CONSTANT; i++) {<a name="line.538"></a> +<span class="sourceLineNo">539</span> markerArray[i].previous(markerArray[i - 1])<a name="line.539"></a> +<span class="sourceLineNo">540</span> .next(markerArray[i + 1]).index(i);<a name="line.540"></a> +<span class="sourceLineNo">541</span> }<a name="line.541"></a> +<span class="sourceLineNo">542</span> markerArray[0].previous(markerArray[0]).next(markerArray[1])<a name="line.542"></a> +<span class="sourceLineNo">543</span> .index(0);<a name="line.543"></a> +<span class="sourceLineNo">544</span> markerArray[5].previous(markerArray[4]).next(markerArray[5])<a name="line.544"></a> +<span class="sourceLineNo">545</span> .index(5);<a name="line.545"></a> +<span class="sourceLineNo">546</span> }<a name="line.546"></a> +<span class="sourceLineNo">547</span><a name="line.547"></a> +<span class="sourceLineNo">548</span> /**<a name="line.548"></a> +<span class="sourceLineNo">549</span> * Return marker height given index<a name="line.549"></a> +<span class="sourceLineNo">550</span> *<a name="line.550"></a> +<span class="sourceLineNo">551</span> * @param markerIndex index of marker within (1,6)<a name="line.551"></a> +<span class="sourceLineNo">552</span> * @return marker height<a name="line.552"></a> +<span class="sourceLineNo">553</span> */<a name="line.553"></a> +<span class="sourceLineNo">554</span> public double height(final int markerIndex) {<a name="line.554"></a> +<span class="sourceLineNo">555</span> if (markerIndex >= markerArray.length || markerIndex <= 0) {<a name="line.555"></a> +<span class="sourceLineNo">556</span> throw new OutOfRangeException(markerIndex, 1,<a name="line.556"></a> +<span class="sourceLineNo">557</span> markerArray.length);<a name="line.557"></a> +<span class="sourceLineNo">558</span> }<a name="line.558"></a> +<span class="sourceLineNo">559</span> return markerArray[markerIndex].markerHeight;<a name="line.559"></a> +<span class="sourceLineNo">560</span> }<a name="line.560"></a> +<span class="sourceLineNo">561</span><a name="line.561"></a> +<span class="sourceLineNo">562</span> /**<a name="line.562"></a> +<span class="sourceLineNo">563</span> * {@inheritDoc}.Clone Markers<a name="line.563"></a> +<span class="sourceLineNo">564</span> *<a name="line.564"></a> +<span class="sourceLineNo">565</span> * @return cloned object<a name="line.565"></a> +<span class="sourceLineNo">566</span> */<a name="line.566"></a> +<span class="sourceLineNo">567</span> @Override<a name="line.567"></a> +<span class="sourceLineNo">568</span> public Object clone() {<a name="line.568"></a> +<span class="sourceLineNo">569</span> return new Markers(new Marker[] { new Marker(),<a name="line.569"></a> +<span class="sourceLineNo">570</span> (Marker) markerArray[1].clone(),<a name="line.570"></a> +<span class="sourceLineNo">571</span> (Marker) markerArray[2].clone(),<a name="line.571"></a> +<span class="sourceLineNo">572</span> (Marker) markerArray[3].clone(),<a name="line.572"></a> +<span class="sourceLineNo">573</span> (Marker) markerArray[4].clone(),<a name="line.573"></a> +<span class="sourceLineNo">574</span> (Marker) markerArray[5].clone() });<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><a name="line.577"></a> +<span class="sourceLineNo">578</span> /**<a name="line.578"></a> +<span class="sourceLineNo">579</span> * Returns string representation of the Marker array.<a name="line.579"></a> +<span class="sourceLineNo">580</span> *<a name="line.580"></a> +<span class="sourceLineNo">581</span> * @return Markers as a string<a name="line.581"></a> +<span class="sourceLineNo">582</span> */<a name="line.582"></a> +<span class="sourceLineNo">583</span> @Override<a name="line.583"></a> +<span class="sourceLineNo">584</span> public String toString() {<a name="line.584"></a> +<span class="sourceLineNo">585</span> return String.format("m1=[%s],m2=[%s],m3=[%s],m4=[%s],m5=[%s]",<a name="line.585"></a> +<span class="sourceLineNo">586</span> markerArray[1].toString(), markerArray[2].toString(),<a name="line.586"></a> +<span class="sourceLineNo">587</span> markerArray[3].toString(), markerArray[4].toString(),<a name="line.587"></a> +<span class="sourceLineNo">588</span> markerArray[5].toString());<a name="line.588"></a> +<span class="sourceLineNo">589</span> }<a name="line.589"></a> +<span class="sourceLineNo">590</span><a name="line.590"></a> +<span class="sourceLineNo">591</span> }<a name="line.591"></a> +<span class="sourceLineNo">592</span><a name="line.592"></a> +<span class="sourceLineNo">593</span> /**<a name="line.593"></a> +<span class="sourceLineNo">594</span> * The class modeling the attributes of the marker of the P-square algorithm<a name="line.594"></a> +<span class="sourceLineNo">595</span> */<a name="line.595"></a> +<span class="sourceLineNo">596</span> private static class Marker implements Serializable, Cloneable {<a name="line.596"></a> +<span class="sourceLineNo">597</span><a name="line.597"></a> +<span class="sourceLineNo">598</span> /**<a name="line.598"></a> +<span class="sourceLineNo">599</span> * Serial Version ID<a name="line.599"></a> +<span class="sourceLineNo">600</span> */<a name="line.600"></a> +<span class="sourceLineNo">601</span> private static final long serialVersionUID = -3575879478288538431L;<a name="line.601"></a> +<span class="sourceLineNo">602</span><a name="line.602"></a> +<span class="sourceLineNo">603</span> /**<a name="line.603"></a> +<span class="sourceLineNo">604</span> * The marker index which is just a serial number for the marker in the<a name="line.604"></a> +<span class="sourceLineNo">605</span> * marker array of 5+1.<a name="line.605"></a> +<span class="sourceLineNo">606</span> */<a name="line.606"></a> +<span class="sourceLineNo">607</span> private int index;<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> * The integral marker position. Refer to the variable n in the original<a name="line.610"></a> +<span class="sourceLineNo">611</span> * works.<a name="line.611"></a> +<span class="sourceLineNo">612</span> */<a name="line.612"></a> +<span class="sourceLineNo">613</span> private double intMarkerPosition;<a name="line.613"></a> +<span class="sourceLineNo">614</span><a name="line.614"></a> +<span class="sourceLineNo">615</span> /**<a name="line.615"></a> +<span class="sourceLineNo">616</span> * Desired marker position. Refer to the variable n' in the original<a name="line.616"></a> +<span class="sourceLineNo">617</span> * works.<a name="line.617"></a> +<span class="sourceLineNo">618</span> */<a name="line.618"></a> +<span class="sourceLineNo">619</span> private double desiredMarkerPosition;<a name="line.619"></a> +<span class="sourceLineNo">620</span><a name="line.620"></a> +<span class="sourceLineNo">621</span> /**<a name="line.621"></a> +<span class="sourceLineNo">622</span> * Marker height or the quantile. Refer to the variable q in the<a name="line.622"></a> +<span class="sourceLineNo">623</span> * original works.<a name="line.623"></a> +<span class="sourceLineNo">624</span> */<a name="line.624"></a> +<span class="sourceLineNo">625</span> private double markerHeight;<a name="line.625"></a> +<span class="sourceLineNo">626</span><a name="line.626"></a> +<span class="sourceLineNo">627</span> /**<a name="line.627"></a> +<span class="sourceLineNo">628</span> * Desired marker increment. Refer to the variable dn' in the original<a name="line.628"></a> +<span class="sourceLineNo">629</span> * works.<a name="line.629"></a> +<span class="sourceLineNo">630</span> */<a name="line.630"></a> +<span class="sourceLineNo">631</span> private double desiredMarkerIncrement;<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> * Next and previous markers for easy linked navigation in loops. this<a name="line.634"></a> +<span class="sourceLineNo">635</span> * is not serialized as they can be rebuilt during deserialization.<a name="line.635"></a> +<span class="sourceLineNo">636</span> */<a name="line.636"></a> +<span class="sourceLineNo">637</span> private transient Marker next;<a name="line.637"></a> +<span class="sourceLineNo">638</span><a name="line.638"></a> +<span class="sourceLineNo">639</span> /**<a name="line.639"></a> +<span class="sourceLineNo">640</span> * The previous marker links<a name="line.640"></a> +<span class="sourceLineNo">641</span> */<a name="line.641"></a> +<span class="sourceLineNo">642</span> private transient Marker previous;<a name="line.642"></a> +<span class="sourceLineNo">643</span><a name="line.643"></a> +<span class="sourceLineNo">644</span> /**<a name="line.644"></a> +<span class="sourceLineNo">645</span> * Nonlinear interpolator<a name="line.645"></a> +<span class="sourceLineNo">646</span> */<a name="line.646"></a> +<span class="sourceLineNo">647</span> private final UnivariateInterpolator nonLinear =<a name="line.647"></a> +<span class="sourceLineNo">648</span> new NevilleInterpolator();<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> * Linear interpolator which is not serializable<a name="line.651"></a> +<span class="sourceLineNo">652</span> */<a name="line.652"></a> +<span class="sourceLineNo">653</span> private transient UnivariateInterpolator linear =<a name="line.653"></a> +<span class="sourceLineNo">654</span> new LinearInterpolator();<a name="line.654"></a> +<span class="sourceLineNo">655</span><a name="line.655"></a> +<span class="sourceLineNo">656</span> /**<a name="line.656"></a> +<span class="sourceLineNo">657</span> * Default constructor<a name="line.657"></a> +<span class="sourceLineNo">658</span> */<a name="line.658"></a> +<span class="sourceLineNo">659</span> private Marker() {<a name="line.659"></a> +<span class="sourceLineNo">660</span> this.next = this.previous = this;<a name="line.660"></a> +<span class="sourceLineNo">661</span> }<a name="line.661"></a> +<span class="sourceLineNo">662</span><a name="line.662"></a> +<span class="sourceLineNo">663</span> /**<a name="line.663"></a> +<span class="sourceLineNo">664</span> * Constructor of the marker with parameters<a name="line.664"></a> +<span class="sourceLineNo">665</span> *<a name="line.665"></a> +<span class="sourceLineNo">666</span> * @param heightOfMarker represent the quantile value<a name="line.666"></a> +<span class="sourceLineNo">667</span> * @param makerPositionDesired represent the desired marker position<a name="line.667"></a> +<span class="sourceLineNo">668</span> * @param markerPositionIncrement represent increments for position<a name="line.668"></a> +<span class="sourceLineNo">669</span> * @param markerPositionNumber represent the position number of marker<a name="line.669"></a> +<span class="sourceLineNo">670</span> */<a name="line.670"></a> +<span class="sourceLineNo">671</span> private Marker(double heightOfMarker, double makerPositionDesired,<a name="line.671"></a> +<span class="sourceLineNo">672</span> double markerPositionIncrement, double markerPositionNumber) {<a name="line.672"></a> +<span class="sourceLineNo">673</span> this();<a name="line.673"></a> +<span class="sourceLineNo">674</span> this.markerHeight = heightOfMarker;<a name="line.674"></a> +<span class="sourceLineNo">675</span> this.desiredMarkerPosition = makerPositionDesired;<a name="line.675"></a> +<span class="sourceLineNo">676</span> this.desiredMarkerIncrement = markerPositionIncrement;<a name="line.676"></a> +<span class="sourceLineNo">677</span> this.intMarkerPosition = markerPositionNumber;<a name="line.677"></a> +<span class="sourceLineNo">678</span> }<a name="line.678"></a> +<span class="sourceLineNo">679</span><a name="line.679"></a> +<span class="sourceLineNo">680</span> /**<a name="line.680"></a> +<span class="sourceLineNo">681</span> * Sets the previous marker.<a name="line.681"></a> +<span class="sourceLineNo">682</span> *<a name="line.682"></a> +<span class="sourceLineNo">683</span> * @param previousMarker the previous marker to the current marker in<a name="line.683"></a> +<span class="sourceLineNo">684</span> * the array of markers<a name="line.684"></a> +<span class="sourceLineNo">685</span> * @return this instance<a name="line.685"></a> +<span class="sourceLineNo">686</span> */<a name="line.686"></a> +<span class="sourceLineNo">687</span> private Marker previous(final Marker previousMarker) {<a name="line.687"></a> +<span class="sourceLineNo">688</span> MathUtils.checkNotNull(previousMarker);<a name="line.688"></a> +<span class="sourceLineNo">689</span> this.previous = previousMarker;<a name="line.689"></a> +<span class="sourceLineNo">690</span> return this;<a name="line.690"></a> +<span class="sourceLineNo">691</span> }<a name="line.691"></a> +<span class="sourceLineNo">692</span><a name="line.692"></a> +<span class="sourceLineNo">693</span> /**<a name="line.693"></a> +<span class="sourceLineNo">694</span> * Sets the next marker.<a name="line.694"></a> +<span class="sourceLineNo">695</span> *<a name="line.695"></a> +<span class="sourceLineNo">696</span> * @param nextMarker the next marker to the current marker in the array<a name="line.696"></a> +<span class="sourceLineNo">697</span> * of markers<a name="line.697"></a> +<span class="sourceLineNo">698</span> * @return this instance<a name="line.698"></a> +<span class="sourceLineNo">699</span> */<a name="line.699"></a> +<span class="sourceLineNo">700</span> private Marker next(final Marker nextMarker) {<a name="line.700"></a> +<span class="sourceLineNo">701</span> MathUtils.checkNotNull(nextMarker);<a name="line.701"></a> +<span class="sourceLineNo">702</span> this.next = nextMarker;<a name="line.702"></a> +<span class="sourceLineNo">703</span> return this;<a name="line.703"></a> +<span class="sourceLineNo">704</span> }<a name="line.704"></a> +<span class="sourceLineNo">705</span><a name="line.705"></a> +<span class="sourceLineNo">706</span> /**<a name="line.706"></a> +<span class="sourceLineNo">707</span> * Sets the index of the marker.<a name="line.707"></a> +<span class="sourceLineNo">708</span> *<a name="line.708"></a> +<span class="sourceLineNo">709</span> * @param indexOfMarker the array index of the marker in marker array<a name="line.709"></a> +<span class="sourceLineNo">710</span> * @return this instance<a name="line.710"></a> +<span class="sourceLineNo">711</span> */<a name="line.711"></a> +<span class="sourceLineNo">712</span> private Marker index(final int indexOfMarker) {<a name="line.712"></a> +<span class="sourceLineNo">713</span> this.index = indexOfMarker;<a name="line.713"></a> +<span class="sourceLineNo">714</span> return this;<a name="line.714"></a> +<span class="sourceLineNo">715</span> }<a name="line.715"></a> +<span class="sourceLineNo">716</span><a name="line.716"></a> +<span class="sourceLineNo">717</span> /**<a name="line.717"></a> +<span class="sourceLineNo">718</span> * Update desired Position with increment.<a name="line.718"></a> +<span class="sourceLineNo">719</span> */<a name="line.719"></a> +<span class="sourceLineNo">720</span> private void updateDesiredPosition() {<a name="line.720"></a> +<span class="sourceLineNo">721</span> desiredMarkerPosition += desiredMarkerIncrement;<a name="line.721"></a> +<span class="sourceLineNo">722</span> }<a name="line.722"></a> +<span class="sourceLineNo">723</span><a name="line.723"></a> +<span class="sourceLineNo">724</span> /**<a name="line.724"></a> +<span class="sourceLineNo">725</span> * Increment Position by d.<a name="line.725"></a> +<span class="sourceLineNo">726</span> *<a name="line.726"></a> +<span class="sourceLineNo">727</span> * @param d a delta value to increment<a name="line.727"></a> +<span class="sourceLineNo">728</span> */<a name="line.728"></a> +<span class="sourceLineNo">729</span> private void incrementPosition(final int d) {<a name="line.729"></a> +<span class="sourceLineNo">730</span> intMarkerPosition += d;<a name="line.730"></a> +<span class="sourceLineNo">731</span> }<a name="line.731"></a> +<span class="sourceLineNo">732</span><a name="line.732"></a> +<span class="sourceLineNo">733</span> /**<a name="line.733"></a> +<span class="sourceLineNo">734</span> * Difference between desired and actual position<a name="line.734"></a> +<span class="sourceLineNo">735</span> *<a name="line.735"></a> +<span class="sourceLineNo">736</span> * @return difference between desired and actual position<a name="line.736"></a> +<span class="sourceLineNo">737</span> */<a name="line.737"></a> +<span class="sourceLineNo">738</span> private double difference() {<a name="line.738"></a> +<span class="sourceLineNo">739</span> return desiredMarkerPosition - intMarkerPosition;<a name="line.739"></a> +<span class="sourceLineNo">740</span> }<a name="line.740"></a> +<span class="sourceLineNo">741</span><a name="line.741"></a> +<span class="sourceLineNo">742</span> /**<a name="line.742"></a> +<span class="sourceLineNo">743</span> * Estimate the quantile for the current marker.<a name="line.743"></a> +<span class="sourceLineNo">744</span> *<a name="line.744"></a> +<span class="sourceLineNo">745</span> * @return estimated quantile<a name="line.745"></a> +<span class="sourceLineNo">746</span> */<a name="line.746"></a> +<span class="sourceLineNo">747</span> private double estimate() {<a name="line.747"></a> +<span class="sourceLineNo">748</span> final double di = difference();<a name="line.748"></a> +<span class="sourceLineNo">749</span> final boolean isNextHigher =<a name="line.749"></a> +<span class="sourceLineNo">750</span> next.intMarkerPosition - intMarkerPosition > 1;<a name="line.750"></a> +<span class="sourceLineNo">751</span> final boolean isPreviousLower =<a name="line.751"></a> +<span class="sourceLineNo">752</span> previous.intMarkerPosition - intMarkerPosition < -1;<a name="line.752"></a> +<span class="sourceLineNo">753</span><a name="line.753"></a> +<span class="sourceLineNo">754</span> if (di >= 1 && isNextHigher || di <= -1 && isPreviousLower) {<a name="line.754"></a> +<span class="sourceLineNo">755</span> final int d = di >= 0 ? 1 : -1;<a name="line.755"></a> +<span class="sourceLineNo">756</span> final double[] xval =<a name="line.756"></a> +<span class="sourceLineNo">757</span> new double[] { previous.intMarkerPosition,<a name="line.757"></a> +<span class="sourceLineNo">758</span> intMarkerPosition, next.intMarkerPosition };<a name="line.758"></a> +<span class="sourceLineNo">759</span> final double[] yval =<a name="line.759"></a> +<span class="sourceLineNo">760</span> new double[] { previous.markerHeight, markerHeight,<a name="line.760"></a> +<span class="sourceLineNo">761</span> next.markerHeight };<a name="line.761"></a> +<span class="sourceLineNo">762</span> final double xD = intMarkerPosition + d;<a name="line.762"></a> +<span class="sourceLineNo">763</span><a name="line.763"></a> +<span class="sourceLineNo">764</span> UnivariateFunction univariateFunction =<a name="line.764"></a> +<span class="sourceLineNo">765</span> nonLinear.interpolate(xval, yval);<a name="line.765"></a> +<span class="sourceLineNo">766</span> markerHeight = univariateFunction.value(xD);<a name="line.766"></a> +<span class="sourceLineNo">767</span><a name="line.767"></a> +<span class="sourceLineNo">768</span> // If parabolic estimate is bad then turn linear<a name="line.768"></a> +<span class="sourceLineNo">769</span> if (isEstimateBad(yval, markerHeight)) {<a name="line.769"></a> +<span class="sourceLineNo">770</span> int delta = xD - xval[1] > 0 ? 1 : -1;<a name="line.770"></a> +<span class="sourceLineNo">771</span> final double[] xBad =<a name="line.771"></a> +<span class="sourceLineNo">772</span> new double[] { xval[1], xval[1 + delta] };<a name="line.772"></a> +<span class="sourceLineNo">773</span> final double[] yBad =<a name="line.773"></a> +<span class="sourceLineNo">774</span> new double[] { yval[1], yval[1 + delta] };<a name="line.774"></a> +<span class="sourceLineNo">775</span> MathArrays.sortInPlace(xBad, yBad);// since d can be +/- 1<a name="line.775"></a> +<span class="sourceLineNo">776</span> univariateFunction = linear.interpolate(xBad, yBad);<a name="line.776"></a> +<span class="sourceLineNo">777</span> markerHeight = univariateFunction.value(xD);<a name="line.777"></a> +<span class="sourceLineNo">778</span> }<a name="line.778"></a> +<span class="sourceLineNo">779</span> incrementPosition(d);<a name="line.779"></a> +<span class="sourceLineNo">780</span> }<a name="line.780"></a> +<span class="sourceLineNo">781</span> return markerHeight;<a name="line.781"></a> +<span class="sourceLineNo">782</span> }<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> * Check if parabolic/nonlinear estimate is bad by checking if the<a name="line.785"></a> +<span class="sourceLineNo">786</span> * ordinate found is beyond the y[0] and y[2].<a name="line.786"></a> +<span class="sourceLineNo">787</span> *<a name="line.787"></a> +<span class="sourceLineNo">788</span> * @param y the array to get the bounds<a name="line.788"></a> +<span class="sourceLineNo">789</span> * @param yD the estimate<a name="line.789"></a> +<span class="sourceLineNo">790</span> * @return true if yD is a bad estimate<a name="line.790"></a> +<span class="sourceLineNo">791</span> */<a name="line.791"></a> +<span class="sourceLineNo">792</span> private boolean isEstimateBad(final double[] y, final double yD) {<a name="line.792"></a> +<span class="sourceLineNo">793</span> return yD <= y[0] || yD >= y[2];<a name="line.793"></a> +<span class="sourceLineNo">794</span> }<a name="line.794"></a> +<span class="sourceLineNo">795</span><a name="line.795"></a> +<span class="sourceLineNo">796</span> /**<a name="line.796"></a> +<span class="sourceLineNo">797</span> * {@inheritDoc}<i>This equals method checks for marker attributes and<a name="line.797"></a> +<span class="sourceLineNo">798</span> * as well checks if navigation pointers (next and previous) are the same<a name="line.798"></a> +<span class="sourceLineNo">799</span> * between this and passed in object</i><a name="line.799"></a> +<span class="sourceLineNo">800</span> *<a name="line.800"></a> +<span class="sourceLineNo">801</span> * @param o Other object<a name="line.801"></a> +<span class="sourceLineNo">802</span> * @return true if this equals passed in other object o<a name="line.802"></a> +<span class="sourceLineNo">803</span> */<a name="line.803"></a> +<span class="sourceLineNo">804</span> @Override<a name="line.804"></a> +<span class="sourceLineNo">805</span> public boolean equals(Object o) {<a name="line.805"></a> +<span class="sourceLineNo">806</span> boolean result = false;<a name="line.806"></a> +<span class="sourceLineNo">807</span> if (this == o) {<a name="line.807"></a> +<span class="sourceLineNo">808</span> result = true;<a name="line.808"></a> +<span class="sourceLineNo">809</span> } else if (o != null && o instanceof Marker) {<a name="line.809"></a> +<span class="sourceLineNo">810</span> Marker that = (Marker) o;<a name="line.810"></a> +<span class="sourceLineNo">811</span><a name="line.811"></a> +<span class="sourceLineNo">812</span> result = Double.compare(markerHeight, that.markerHeight) == 0;<a name="line.812"></a> +<span class="sourceLineNo">813</span> result =<a name="line.813"></a> +<span class="sourceLineNo">814</span> result &&<a name="line.814"></a> +<span class="sourceLineNo">815</span> Double.compare(intMarkerPosition,<a name="line.815"></a> +<span class="sourceLineNo">816</span> that.intMarkerPosition) == 0;<a name="line.816"></a> +<span class="sourceLineNo">817</span> result =<a name="line.817"></a> +<span class="sourceLineNo">818</span> result &&<a name="line.818"></a> +<span class="sourceLineNo">819</span> Double.compare(desiredMarkerPosition,<a name="line.819"></a> +<span class="sourceLineNo">820</span> that.desiredMarkerPosition) == 0;<a name="line.820"></a> +<span class="sourceLineNo">821</span> result =<a name="line.821"></a> +<span class="sourceLineNo">822</span> result &&<a name="line.822"></a> +<span class="sourceLineNo">823</span> Double.compare(desiredMarkerIncrement,<a name="line.823"></a> +<span class="sourceLineNo">824</span> that.desiredMarkerIncrement) == 0;<a name="line.824"></a> +<span class="sourceLineNo">825</span><a name="line.825"></a> +<span class="sourceLineNo">826</span> result = result && next.index == that.next.index;<a name="line.826"></a> +<span class="sourceLineNo">827</span> result = result && previous.index == that.previous.index;<a name="line.827"></a> +<span class="sourceLineNo">828</span> }<a name="line.828"></a> +<span class="sourceLineNo">829</span> return result;<a name="line.829"></a> +<span class="sourceLineNo">830</span> }<a name="line.830"></a> +<span class="sourceLineNo">831</span><a name="line.831"></a> +<span class="sourceLineNo">832</span> @Override<a name="line.832"></a> +<span class="sourceLineNo">833</span> public int hashCode() {<a name="line.833"></a> +<span class="sourceLineNo">834</span> return Arrays.hashCode(new double[] {markerHeight, intMarkerPosition,<a name="line.834"></a> +<span class="sourceLineNo">835</span> desiredMarkerIncrement, desiredMarkerPosition, previous.index, next.index});<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> * Read Object to deserialize.<a name="line.839"></a> +<span class="sourceLineNo">840</span> *<a name="line.840"></a> +<span class="sourceLineNo">841</span> * @param anInstream Stream Object data<a name="line.841"></a> +<span class="sourceLineNo">842</span> * @throws IOException thrown for IO Errors<a name="line.842"></a> +<span class="sourceLineNo">843</span> * @throws ClassNotFoundException thrown for class not being found<a name="line.843"></a> +<span class="sourceLineNo">844</span> */<a name="line.844"></a> +<span class="sourceLineNo">845</span> private void readObject(ObjectInputStream anInstream)<a name="line.845"></a> +<span class="sourceLineNo">846</span> throws ClassNotFoundException, IOException {<a name="line.846"></a> +<span class="sourceLineNo">847</span> anInstream.defaultReadObject();<a name="line.847"></a> +<span class="sourceLineNo">848</span> previous=next=this;<a name="line.848"></a> +<span class="sourceLineNo">849</span> linear = new LinearInterpolator();<a name="line.849"></a> +<span class="sourceLineNo">850</span> }<a name="line.850"></a> +<span class="sourceLineNo">851</span><a name="line.851"></a> +<span class="sourceLineNo">852</span> /**<a name="line.852"></a> +<span class="sourceLineNo">853</span> * Clone this instance.<a name="line.853"></a> +<span class="sourceLineNo">854</span> *<a name="line.854"></a> +<span class="sourceLineNo">855</span> * @return cloned marker<a name="line.855"></a> +<span class="sourceLineNo">856</span> */<a name="line.856"></a> +<span class="sourceLineNo">857</span> @Override<a name="line.857"></a> +<span class="sourceLineNo">858</span> public Object clone() {<a name="line.858"></a> +<span class="sourceLineNo">859</span> return new Marker(markerHeight, desiredMarkerPosition,<a name="line.859"></a> +<span class="sourceLineNo">860</span> desiredMarkerIncrement, intMarkerPosition);<a name="line.860"></a> +<span class="sourceLineNo">861</span> }<a name="line.861"></a> +<span class="sourceLineNo">862</span><a name="line.862"></a> +<span class="sourceLineNo">863</span> /**<a name="line.863"></a> +<span class="sourceLineNo">864</span> * {@inheritDoc}<a name="line.864"></a> +<span class="sourceLineNo">865</span> */<a name="line.865"></a> +<span class="sourceLineNo">866</span> @Override<a name="line.866"></a> +<span class="sourceLineNo">867</span> public String toString() {<a name="line.867"></a> +<span class="sourceLineNo">868</span> return String.format(<a name="line.868"></a> +<span class="sourceLineNo">869</span> "index=%.0f,n=%.0f,np=%.2f,q=%.2f,dn=%.2f,prev=%d,next=%d",<a name="line.869"></a> +<span class="sourceLineNo">870</span> (double) index, Precision.round(intMarkerPosition, 0),<a name="line.870"></a> +<span class="sourceLineNo">871</span> Precision.round(desiredMarkerPosition, 2),<a name="line.871"></a> +<span class="sourceLineNo">872</span> Precision.round(markerHeight, 2),<a name="line.872"></a> +<span class="sourceLineNo">873</span> Precision.round(desiredMarkerIncrement, 2), previous.index,<a name="line.873"></a> +<span class="sourceLineNo">874</span> next.index);<a name="line.874"></a> +<span class="sourceLineNo">875</span> }<a name="line.875"></a> +<span class="sourceLineNo">876</span> }<a name="line.876"></a> +<span class="sourceLineNo">877</span><a name="line.877"></a> +<span class="sourceLineNo">878</span> /**<a name="line.878"></a> +<span class="sourceLineNo">879</span> * A simple fixed capacity list that has an upper bound to growth.<a name="line.879"></a> +<span class="sourceLineNo">880</span> * Once its capacity is reached, {@code add} is a no-op, returning<a name="line.880"></a> +<span class="sourceLineNo">881</span> * {@code false}.<a name="line.881"></a> +<span class="sourceLineNo">882</span> *<a name="line.882"></a> +<span class="sourceLineNo">883</span> * @param <E><a name="line.883"></a> +<span class="sourceLineNo">884</span> */<a name="line.884"></a> +<span class="sourceLineNo">885</span> private static class FixedCapacityList<E> extends ArrayList<E> implements<a name="line.885"></a> +<span class="sourceLineNo">886</span> Serializable {<a name="line.886"></a> +<span class="sourceLineNo">887</span> /**<a name="line.887"></a> +<span class="sourceLineNo">888</span> * Serialization Version Id<a name="line.888"></a> +<span class="sourceLineNo">889</span> */<a name="line.889"></a> +<span class="sourceLineNo">890</span> private static final long serialVersionUID = 2283952083075725479L;<a name="line.890"></a> +<span class="sourceLineNo">891</span> /**<a name="line.891"></a> +<span class="sourceLineNo">892</span> * Capacity of the list<a name="line.892"></a> +<span class="sourceLineNo">893</span> */<a name="line.893"></a> +<span class="sourceLineNo">894</span> private final int capacity;<a name="line.894"></a> +<span class="sourceLineNo">895</span><a name="line.895"></a> +<span class="sourceLineNo">896</span> /**<a name="line.896"></a> +<span class="sourceLineNo">897</span> * This constructor constructs the list with given capacity and as well<a name="line.897"></a> +<span class="sourceLineNo">898</span> * as stores the capacity<a name="line.898"></a> +<span class="sourceLineNo">899</span> *<a name="line.899"></a> +<span class="sourceLineNo">900</span> * @param fixedCapacity the capacity to be fixed for this list<a name="line.900"></a> +<span class="sourceLineNo">901</span> */<a name="line.901"></a> +<span class="sourceLineNo">902</span> public FixedCapacityList(final int fixedCapacity) {<a name="line.902"></a> +<span class="sourceLineNo">903</span> super(fixedCapacity);<a name="line.903"></a> +<span class="sourceLineNo">904</span> this.capacity = fixedCapacity;<a name="line.904"></a> +<span class="sourceLineNo">905</span> }<a name="line.905"></a> +<span class="sourceLineNo">906</span><a name="line.906"></a> +<span class="sourceLineNo">907</span> /**<a name="line.907"></a> +<span class="sourceLineNo">908</span> * {@inheritDoc} In addition it checks if the {@link #size()} returns a<a name="line.908"></a> +<span class="sourceLineNo">909</span> * size that is within capacity and if true it adds; otherwise the list<a name="line.909"></a> +<span class="sourceLineNo">910</span> * contents are unchanged and {@code false} is returned.<a name="line.910"></a> +<span class="sourceLineNo">911</span> *<a name="line.911"></a> +<span class="sourceLineNo">912</span> * @return true if addition is successful and false otherwise<a name="line.912"></a> +<span class="sourceLineNo">913</span> */<a name="line.913"></a> +<span class="sourceLineNo">914</span> @Override<a name="line.914"></a> +<span class="sourceLineNo">915</span> public boolean add(final E e) {<a name="line.915"></a> +<span class="sourceLineNo">916</span> return size() < capacity ? super.add(e) : false;<a name="line.916"></a> +<span class="sourceLineNo">917</span> }<a name="line.917"></a> +<span class="sourceLineNo">918</span><a name="line.918"></a> +<span class="sourceLineNo">919</span> /**<a name="line.919"></a> +<span class="sourceLineNo">920</span> * {@inheritDoc} In addition it checks if the sum of Collection size and<a name="line.920"></a> +<span class="sourceLineNo">921</span> * this instance's {@link #size()} returns a value that is within<a name="line.921"></a> +<span class="sourceLineNo">922</span> * capacity and if true it adds the collection; otherwise the list<a name="line.922"></a> +<span class="sourceLineNo">923</span> * contents are unchanged and {@code false} is returned.<a name="line.923"></a> +<span class="sourceLineNo">924</span> *<a name="line.924"></a> +<span class="sourceLineNo">925</span> * @return true if addition is successful and false otherwise<a name="line.925"></a> +<span class="sourceLineNo">926</span> */<a name="line.926"></a> +<span class="sourceLineNo">927</span> @Override<a name="line.927"></a> +<span class="sourceLineNo">928</span> public boolean addAll(Collection<? extends E> collection) {<a name="line.928"></a> +<span class="sourceLineNo">929</span> boolean isCollectionLess =<a name="line.929"></a> +<span class="sourceLineNo">930</span> collection != null &&<a name="line.930"></a> +<span class="sourceLineNo">931</span> collection.size() + size() <= capacity;<a name="line.931"></a> +<span class="sourceLineNo">932</span> return isCollectionLess ? super.addAll(collection) : false;<a name="line.932"></a> +<span class="sourceLineNo">933</span> }<a name="line.933"></a> +<span class="sourceLineNo">934</span> }<a name="line.934"></a>
[... 127 lines stripped ...]
