Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/distribution/AbstractIntegerDistribution.html @ 13:cbf34dd4d7e6
commons-math-2.1 added
author | dwinter |
---|---|
date | Tue, 04 Jan 2011 10:02:07 +0100 |
parents | |
children |
line wrap: on
line source
<HTML> <BODY BGCOLOR="white"> <PRE> <FONT color="green">001</FONT> /*<a name="line.1"></a> <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a> <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> <FONT color="green">008</FONT> *<a name="line.8"></a> <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> <FONT color="green">010</FONT> *<a name="line.10"></a> <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a> <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a> <FONT color="green">016</FONT> */<a name="line.16"></a> <FONT color="green">017</FONT> package org.apache.commons.math.distribution;<a name="line.17"></a> <FONT color="green">018</FONT> <a name="line.18"></a> <FONT color="green">019</FONT> import java.io.Serializable;<a name="line.19"></a> <FONT color="green">020</FONT> <a name="line.20"></a> <FONT color="green">021</FONT> import org.apache.commons.math.FunctionEvaluationException;<a name="line.21"></a> <FONT color="green">022</FONT> import org.apache.commons.math.MathException;<a name="line.22"></a> <FONT color="green">023</FONT> import org.apache.commons.math.MathRuntimeException;<a name="line.23"></a> <FONT color="green">024</FONT> <a name="line.24"></a> <FONT color="green">025</FONT> <a name="line.25"></a> <FONT color="green">026</FONT> /**<a name="line.26"></a> <FONT color="green">027</FONT> * Base class for integer-valued discrete distributions. Default<a name="line.27"></a> <FONT color="green">028</FONT> * implementations are provided for some of the methods that do not vary<a name="line.28"></a> <FONT color="green">029</FONT> * from distribution to distribution.<a name="line.29"></a> <FONT color="green">030</FONT> *<a name="line.30"></a> <FONT color="green">031</FONT> * @version $Revision: 920558 $ $Date: 2010-03-08 17:57:32 -0500 (Mon, 08 Mar 2010) $<a name="line.31"></a> <FONT color="green">032</FONT> */<a name="line.32"></a> <FONT color="green">033</FONT> public abstract class AbstractIntegerDistribution extends AbstractDistribution<a name="line.33"></a> <FONT color="green">034</FONT> implements IntegerDistribution, Serializable {<a name="line.34"></a> <FONT color="green">035</FONT> <a name="line.35"></a> <FONT color="green">036</FONT> /** Message for endpoints in wrong order. */<a name="line.36"></a> <FONT color="green">037</FONT> private static final String WRONG_ORDER_ENDPOINTS_MESSAGE =<a name="line.37"></a> <FONT color="green">038</FONT> "lower endpoint ({0}) must be less than or equal to upper endpoint ({1})";<a name="line.38"></a> <FONT color="green">039</FONT> <a name="line.39"></a> <FONT color="green">040</FONT> /** Message for out of range point. */<a name="line.40"></a> <FONT color="green">041</FONT> private static final String OUT_OF_RANGE_POINT =<a name="line.41"></a> <FONT color="green">042</FONT> "{0} out of [{1}, {2}] range";<a name="line.42"></a> <FONT color="green">043</FONT> <a name="line.43"></a> <FONT color="green">044</FONT> /** Serializable version identifier */<a name="line.44"></a> <FONT color="green">045</FONT> private static final long serialVersionUID = -1146319659338487221L;<a name="line.45"></a> <FONT color="green">046</FONT> <a name="line.46"></a> <FONT color="green">047</FONT> /**<a name="line.47"></a> <FONT color="green">048</FONT> * Default constructor.<a name="line.48"></a> <FONT color="green">049</FONT> */<a name="line.49"></a> <FONT color="green">050</FONT> protected AbstractIntegerDistribution() {<a name="line.50"></a> <FONT color="green">051</FONT> super();<a name="line.51"></a> <FONT color="green">052</FONT> }<a name="line.52"></a> <FONT color="green">053</FONT> <a name="line.53"></a> <FONT color="green">054</FONT> /**<a name="line.54"></a> <FONT color="green">055</FONT> * For a random variable X whose values are distributed according<a name="line.55"></a> <FONT color="green">056</FONT> * to this distribution, this method returns P(X &le; x). In other words,<a name="line.56"></a> <FONT color="green">057</FONT> * this method represents the (cumulative) distribution function, or<a name="line.57"></a> <FONT color="green">058</FONT> * CDF, for this distribution.<a name="line.58"></a> <FONT color="green">059</FONT> * <p><a name="line.59"></a> <FONT color="green">060</FONT> * If <code>x</code> does not represent an integer value, the CDF is<a name="line.60"></a> <FONT color="green">061</FONT> * evaluated at the greatest integer less than x.<a name="line.61"></a> <FONT color="green">062</FONT> *<a name="line.62"></a> <FONT color="green">063</FONT> * @param x the value at which the distribution function is evaluated.<a name="line.63"></a> <FONT color="green">064</FONT> * @return cumulative probability that a random variable with this<a name="line.64"></a> <FONT color="green">065</FONT> * distribution takes a value less than or equal to <code>x</code><a name="line.65"></a> <FONT color="green">066</FONT> * @throws MathException if the cumulative probability can not be<a name="line.66"></a> <FONT color="green">067</FONT> * computed due to convergence or other numerical errors.<a name="line.67"></a> <FONT color="green">068</FONT> */<a name="line.68"></a> <FONT color="green">069</FONT> public double cumulativeProbability(double x) throws MathException {<a name="line.69"></a> <FONT color="green">070</FONT> return cumulativeProbability((int) Math.floor(x));<a name="line.70"></a> <FONT color="green">071</FONT> }<a name="line.71"></a> <FONT color="green">072</FONT> <a name="line.72"></a> <FONT color="green">073</FONT> /**<a name="line.73"></a> <FONT color="green">074</FONT> * For a random variable X whose values are distributed according<a name="line.74"></a> <FONT color="green">075</FONT> * to this distribution, this method returns P(x0 &le; X &le; x1).<a name="line.75"></a> <FONT color="green">076</FONT> *<a name="line.76"></a> <FONT color="green">077</FONT> * @param x0 the (inclusive) lower bound<a name="line.77"></a> <FONT color="green">078</FONT> * @param x1 the (inclusive) upper bound<a name="line.78"></a> <FONT color="green">079</FONT> * @return the probability that a random variable with this distribution<a name="line.79"></a> <FONT color="green">080</FONT> * will take a value between <code>x0</code> and <code>x1</code>,<a name="line.80"></a> <FONT color="green">081</FONT> * including the endpoints.<a name="line.81"></a> <FONT color="green">082</FONT> * @throws MathException if the cumulative probability can not be<a name="line.82"></a> <FONT color="green">083</FONT> * computed due to convergence or other numerical errors.<a name="line.83"></a> <FONT color="green">084</FONT> * @throws IllegalArgumentException if <code>x0 > x1</code><a name="line.84"></a> <FONT color="green">085</FONT> */<a name="line.85"></a> <FONT color="green">086</FONT> @Override<a name="line.86"></a> <FONT color="green">087</FONT> public double cumulativeProbability(double x0, double x1)<a name="line.87"></a> <FONT color="green">088</FONT> throws MathException {<a name="line.88"></a> <FONT color="green">089</FONT> if (x0 > x1) {<a name="line.89"></a> <FONT color="green">090</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.90"></a> <FONT color="green">091</FONT> WRONG_ORDER_ENDPOINTS_MESSAGE, x0, x1);<a name="line.91"></a> <FONT color="green">092</FONT> }<a name="line.92"></a> <FONT color="green">093</FONT> if (Math.floor(x0) < x0) {<a name="line.93"></a> <FONT color="green">094</FONT> return cumulativeProbability(((int) Math.floor(x0)) + 1,<a name="line.94"></a> <FONT color="green">095</FONT> (int) Math.floor(x1)); // don't want to count mass below x0<a name="line.95"></a> <FONT color="green">096</FONT> } else { // x0 is mathematical integer, so use as is<a name="line.96"></a> <FONT color="green">097</FONT> return cumulativeProbability((int) Math.floor(x0),<a name="line.97"></a> <FONT color="green">098</FONT> (int) Math.floor(x1));<a name="line.98"></a> <FONT color="green">099</FONT> }<a name="line.99"></a> <FONT color="green">100</FONT> }<a name="line.100"></a> <FONT color="green">101</FONT> <a name="line.101"></a> <FONT color="green">102</FONT> /**<a name="line.102"></a> <FONT color="green">103</FONT> * For a random variable X whose values are distributed according<a name="line.103"></a> <FONT color="green">104</FONT> * to this distribution, this method returns P(X &le; x). In other words,<a name="line.104"></a> <FONT color="green">105</FONT> * this method represents the probability distribution function, or PDF,<a name="line.105"></a> <FONT color="green">106</FONT> * for this distribution.<a name="line.106"></a> <FONT color="green">107</FONT> *<a name="line.107"></a> <FONT color="green">108</FONT> * @param x the value at which the PDF is evaluated.<a name="line.108"></a> <FONT color="green">109</FONT> * @return PDF for this distribution.<a name="line.109"></a> <FONT color="green">110</FONT> * @throws MathException if the cumulative probability can not be<a name="line.110"></a> <FONT color="green">111</FONT> * computed due to convergence or other numerical errors.<a name="line.111"></a> <FONT color="green">112</FONT> */<a name="line.112"></a> <FONT color="green">113</FONT> public abstract double cumulativeProbability(int x) throws MathException;<a name="line.113"></a> <FONT color="green">114</FONT> <a name="line.114"></a> <FONT color="green">115</FONT> /**<a name="line.115"></a> <FONT color="green">116</FONT> * For a random variable X whose values are distributed according<a name="line.116"></a> <FONT color="green">117</FONT> * to this distribution, this method returns P(X = x). In other words, this<a name="line.117"></a> <FONT color="green">118</FONT> * method represents the probability mass function, or PMF, for the distribution.<a name="line.118"></a> <FONT color="green">119</FONT> * <p><a name="line.119"></a> <FONT color="green">120</FONT> * If <code>x</code> does not represent an integer value, 0 is returned.<a name="line.120"></a> <FONT color="green">121</FONT> *<a name="line.121"></a> <FONT color="green">122</FONT> * @param x the value at which the probability density function is evaluated<a name="line.122"></a> <FONT color="green">123</FONT> * @return the value of the probability density function at x<a name="line.123"></a> <FONT color="green">124</FONT> */<a name="line.124"></a> <FONT color="green">125</FONT> public double probability(double x) {<a name="line.125"></a> <FONT color="green">126</FONT> double fl = Math.floor(x);<a name="line.126"></a> <FONT color="green">127</FONT> if (fl == x) {<a name="line.127"></a> <FONT color="green">128</FONT> return this.probability((int) x);<a name="line.128"></a> <FONT color="green">129</FONT> } else {<a name="line.129"></a> <FONT color="green">130</FONT> return 0;<a name="line.130"></a> <FONT color="green">131</FONT> }<a name="line.131"></a> <FONT color="green">132</FONT> }<a name="line.132"></a> <FONT color="green">133</FONT> <a name="line.133"></a> <FONT color="green">134</FONT> /**<a name="line.134"></a> <FONT color="green">135</FONT> * For a random variable X whose values are distributed according<a name="line.135"></a> <FONT color="green">136</FONT> * to this distribution, this method returns P(x0 &le; X &le; x1).<a name="line.136"></a> <FONT color="green">137</FONT> *<a name="line.137"></a> <FONT color="green">138</FONT> * @param x0 the inclusive, lower bound<a name="line.138"></a> <FONT color="green">139</FONT> * @param x1 the inclusive, upper bound<a name="line.139"></a> <FONT color="green">140</FONT> * @return the cumulative probability.<a name="line.140"></a> <FONT color="green">141</FONT> * @throws MathException if the cumulative probability can not be<a name="line.141"></a> <FONT color="green">142</FONT> * computed due to convergence or other numerical errors.<a name="line.142"></a> <FONT color="green">143</FONT> * @throws IllegalArgumentException if x0 > x1<a name="line.143"></a> <FONT color="green">144</FONT> */<a name="line.144"></a> <FONT color="green">145</FONT> public double cumulativeProbability(int x0, int x1) throws MathException {<a name="line.145"></a> <FONT color="green">146</FONT> if (x0 > x1) {<a name="line.146"></a> <FONT color="green">147</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.147"></a> <FONT color="green">148</FONT> WRONG_ORDER_ENDPOINTS_MESSAGE, x0, x1);<a name="line.148"></a> <FONT color="green">149</FONT> }<a name="line.149"></a> <FONT color="green">150</FONT> return cumulativeProbability(x1) - cumulativeProbability(x0 - 1);<a name="line.150"></a> <FONT color="green">151</FONT> }<a name="line.151"></a> <FONT color="green">152</FONT> <a name="line.152"></a> <FONT color="green">153</FONT> /**<a name="line.153"></a> <FONT color="green">154</FONT> * For a random variable X whose values are distributed according<a name="line.154"></a> <FONT color="green">155</FONT> * to this distribution, this method returns the largest x, such<a name="line.155"></a> <FONT color="green">156</FONT> * that P(X &le; x) &le; <code>p</code>.<a name="line.156"></a> <FONT color="green">157</FONT> *<a name="line.157"></a> <FONT color="green">158</FONT> * @param p the desired probability<a name="line.158"></a> <FONT color="green">159</FONT> * @return the largest x such that P(X &le; x) <= p<a name="line.159"></a> <FONT color="green">160</FONT> * @throws MathException if the inverse cumulative probability can not be<a name="line.160"></a> <FONT color="green">161</FONT> * computed due to convergence or other numerical errors.<a name="line.161"></a> <FONT color="green">162</FONT> * @throws IllegalArgumentException if p < 0 or p > 1<a name="line.162"></a> <FONT color="green">163</FONT> */<a name="line.163"></a> <FONT color="green">164</FONT> public int inverseCumulativeProbability(final double p) throws MathException{<a name="line.164"></a> <FONT color="green">165</FONT> if (p < 0.0 || p > 1.0) {<a name="line.165"></a> <FONT color="green">166</FONT> throw MathRuntimeException.createIllegalArgumentException(<a name="line.166"></a> <FONT color="green">167</FONT> OUT_OF_RANGE_POINT, p, 0.0, 1.0);<a name="line.167"></a> <FONT color="green">168</FONT> }<a name="line.168"></a> <FONT color="green">169</FONT> <a name="line.169"></a> <FONT color="green">170</FONT> // by default, do simple bisection.<a name="line.170"></a> <FONT color="green">171</FONT> // subclasses can override if there is a better method.<a name="line.171"></a> <FONT color="green">172</FONT> int x0 = getDomainLowerBound(p);<a name="line.172"></a> <FONT color="green">173</FONT> int x1 = getDomainUpperBound(p);<a name="line.173"></a> <FONT color="green">174</FONT> double pm;<a name="line.174"></a> <FONT color="green">175</FONT> while (x0 < x1) {<a name="line.175"></a> <FONT color="green">176</FONT> int xm = x0 + (x1 - x0) / 2;<a name="line.176"></a> <FONT color="green">177</FONT> pm = checkedCumulativeProbability(xm);<a name="line.177"></a> <FONT color="green">178</FONT> if (pm > p) {<a name="line.178"></a> <FONT color="green">179</FONT> // update x1<a name="line.179"></a> <FONT color="green">180</FONT> if (xm == x1) {<a name="line.180"></a> <FONT color="green">181</FONT> // this can happen with integer division<a name="line.181"></a> <FONT color="green">182</FONT> // simply decrement x1<a name="line.182"></a> <FONT color="green">183</FONT> --x1;<a name="line.183"></a> <FONT color="green">184</FONT> } else {<a name="line.184"></a> <FONT color="green">185</FONT> // update x1 normally<a name="line.185"></a> <FONT color="green">186</FONT> x1 = xm;<a name="line.186"></a> <FONT color="green">187</FONT> }<a name="line.187"></a> <FONT color="green">188</FONT> } else {<a name="line.188"></a> <FONT color="green">189</FONT> // update x0<a name="line.189"></a> <FONT color="green">190</FONT> if (xm == x0) {<a name="line.190"></a> <FONT color="green">191</FONT> // this can happen with integer division<a name="line.191"></a> <FONT color="green">192</FONT> // simply increment x0<a name="line.192"></a> <FONT color="green">193</FONT> ++x0;<a name="line.193"></a> <FONT color="green">194</FONT> } else {<a name="line.194"></a> <FONT color="green">195</FONT> // update x0 normally<a name="line.195"></a> <FONT color="green">196</FONT> x0 = xm;<a name="line.196"></a> <FONT color="green">197</FONT> }<a name="line.197"></a> <FONT color="green">198</FONT> }<a name="line.198"></a> <FONT color="green">199</FONT> }<a name="line.199"></a> <FONT color="green">200</FONT> <a name="line.200"></a> <FONT color="green">201</FONT> // insure x0 is the correct critical point<a name="line.201"></a> <FONT color="green">202</FONT> pm = checkedCumulativeProbability(x0);<a name="line.202"></a> <FONT color="green">203</FONT> while (pm > p) {<a name="line.203"></a> <FONT color="green">204</FONT> --x0;<a name="line.204"></a> <FONT color="green">205</FONT> pm = checkedCumulativeProbability(x0);<a name="line.205"></a> <FONT color="green">206</FONT> }<a name="line.206"></a> <FONT color="green">207</FONT> <a name="line.207"></a> <FONT color="green">208</FONT> return x0;<a name="line.208"></a> <FONT color="green">209</FONT> }<a name="line.209"></a> <FONT color="green">210</FONT> <a name="line.210"></a> <FONT color="green">211</FONT> /**<a name="line.211"></a> <FONT color="green">212</FONT> * Computes the cumulative probablity function and checks for NaN values returned.<a name="line.212"></a> <FONT color="green">213</FONT> * Throws MathException if the value is NaN. Wraps and rethrows any MathException encountered<a name="line.213"></a> <FONT color="green">214</FONT> * evaluating the cumulative probability function in a FunctionEvaluationException. Throws<a name="line.214"></a> <FONT color="green">215</FONT> * FunctionEvaluationException of the cumulative probability function returns NaN.<a name="line.215"></a> <FONT color="green">216</FONT> *<a name="line.216"></a> <FONT color="green">217</FONT> * @param argument input value<a name="line.217"></a> <FONT color="green">218</FONT> * @return cumulative probability<a name="line.218"></a> <FONT color="green">219</FONT> * @throws FunctionEvaluationException if a MathException occurs computing the cumulative probability<a name="line.219"></a> <FONT color="green">220</FONT> */<a name="line.220"></a> <FONT color="green">221</FONT> private double checkedCumulativeProbability(int argument) throws FunctionEvaluationException {<a name="line.221"></a> <FONT color="green">222</FONT> double result = Double.NaN;<a name="line.222"></a> <FONT color="green">223</FONT> try {<a name="line.223"></a> <FONT color="green">224</FONT> result = cumulativeProbability(argument);<a name="line.224"></a> <FONT color="green">225</FONT> } catch (MathException ex) {<a name="line.225"></a> <FONT color="green">226</FONT> throw new FunctionEvaluationException(ex, argument, ex.getPattern(), ex.getArguments());<a name="line.226"></a> <FONT color="green">227</FONT> }<a name="line.227"></a> <FONT color="green">228</FONT> if (Double.isNaN(result)) {<a name="line.228"></a> <FONT color="green">229</FONT> throw new FunctionEvaluationException(argument,<a name="line.229"></a> <FONT color="green">230</FONT> "Discrete cumulative probability function returned NaN for argument {0}", argument);<a name="line.230"></a> <FONT color="green">231</FONT> }<a name="line.231"></a> <FONT color="green">232</FONT> return result;<a name="line.232"></a> <FONT color="green">233</FONT> }<a name="line.233"></a> <FONT color="green">234</FONT> <a name="line.234"></a> <FONT color="green">235</FONT> /**<a name="line.235"></a> <FONT color="green">236</FONT> * Access the domain value lower bound, based on <code>p</code>, used to<a name="line.236"></a> <FONT color="green">237</FONT> * bracket a PDF root. This method is used by<a name="line.237"></a> <FONT color="green">238</FONT> * {@link #inverseCumulativeProbability(double)} to find critical values.<a name="line.238"></a> <FONT color="green">239</FONT> *<a name="line.239"></a> <FONT color="green">240</FONT> * @param p the desired probability for the critical value<a name="line.240"></a> <FONT color="green">241</FONT> * @return domain value lower bound, i.e.<a name="line.241"></a> <FONT color="green">242</FONT> * P(X &lt; <i>lower bound</i>) &lt; <code>p</code><a name="line.242"></a> <FONT color="green">243</FONT> */<a name="line.243"></a> <FONT color="green">244</FONT> protected abstract int getDomainLowerBound(double p);<a name="line.244"></a> <FONT color="green">245</FONT> <a name="line.245"></a> <FONT color="green">246</FONT> /**<a name="line.246"></a> <FONT color="green">247</FONT> * Access the domain value upper bound, based on <code>p</code>, used to<a name="line.247"></a> <FONT color="green">248</FONT> * bracket a PDF root. This method is used by<a name="line.248"></a> <FONT color="green">249</FONT> * {@link #inverseCumulativeProbability(double)} to find critical values.<a name="line.249"></a> <FONT color="green">250</FONT> *<a name="line.250"></a> <FONT color="green">251</FONT> * @param p the desired probability for the critical value<a name="line.251"></a> <FONT color="green">252</FONT> * @return domain value upper bound, i.e.<a name="line.252"></a> <FONT color="green">253</FONT> * P(X &lt; <i>upper bound</i>) &gt; <code>p</code><a name="line.253"></a> <FONT color="green">254</FONT> */<a name="line.254"></a> <FONT color="green">255</FONT> protected abstract int getDomainUpperBound(double p);<a name="line.255"></a> <FONT color="green">256</FONT> }<a name="line.256"></a> </PRE> </BODY> </HTML>