Added: dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/ContinuousDistribution.html ============================================================================== --- dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/ContinuousDistribution.html (added) +++ dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/ContinuousDistribution.html Thu Dec 1 16:47:12 2022 @@ -0,0 +1,235 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>ContinuousDistribution xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/statistics/distribution/ContinuousDistribution.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.statistics.distribution; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.stream.DoubleStream; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.rng.UniformRandomProvider; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * Interface for distributions on the reals.</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="ContinuousDistribution" href="../../../../../org/apache/commons/statistics/distribution/ContinuousDistribution.html#ContinuousDistribution">ContinuousDistribution</a> { +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * Returns the probability density function (PDF) of this distribution</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * evaluated at the specified point {@code x}.</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * In general, the PDF is the derivative of the {@link #cumulativeProbability(double) CDF}.</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * If the derivative does not exist at {@code x}, then an appropriate</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * replacement should be returned, e.g. {@link Double#POSITIVE_INFINITY},</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * {@link Double#NaN}, or the limit inferior or limit superior of the</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * difference quotient.</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @param x Point at which the PDF is evaluated.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @return the value of the probability density function at {@code x}.</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">double</strong> density(<strong class="jxr_keyword">double</strong> x); +<a class="jxr_linenumber" name="L39" href="#L39">39</a> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(x0 < X <= x1)}.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * The default implementation uses the identity</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * {@code P(x0 < X <= x1) = P(X <= x1) - P(X <= x0)}</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @param x0 Lower bound (exclusive).</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param x1 Upper bound (inclusive).</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this distribution</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * takes a value between {@code x0} and {@code x1}, excluding the lower</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * and including the upper endpoint.</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code x0 > x1}.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> probability(<strong class="jxr_keyword">double</strong> x0, +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">double</strong> x1) { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">if</strong> (x0 > x1) { +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="DistributionException" href="../../../../../org/apache/commons/statistics/distribution/DistributionException.html#DistributionException">DistributionException</a>(DistributionException.INVALID_RANGE_LOW_GT_HIGH, x0, x1); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> cumulativeProbability(x1) - cumulativeProbability(x0); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Returns the natural logarithm of the probability density function</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * (PDF) of this distribution evaluated at the specified point {@code x}.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param x Point at which the PDF is evaluated.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @return the logarithm of the value of the probability density function</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * at {@code x}.</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> logDensity(<strong class="jxr_keyword">double</strong> x) { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> Math.log(density(x)); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(X <= x)}.</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * In other words, this method represents the (cumulative) distribution</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * function (CDF) for this distribution.</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param x Point at which the CDF is evaluated.</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * distribution takes a value less than or equal to {@code x}.</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">double</strong> cumulativeProbability(<strong class="jxr_keyword">double</strong> x); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(X > x)}.</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * In other words, this method represents the complementary cumulative</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * distribution function.</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * <p>By default, this is defined as {@code 1 - cumulativeProbability(x)}, but</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * the specific implementation may be more accurate.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param x Point at which the survival function is evaluated.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * distribution takes a value greater than {@code x}.</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> survivalProbability(<strong class="jxr_keyword">double</strong> x) { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> 1.0 - cumulativeProbability(x); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Computes the quantile function of this distribution. For a random</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * variable {@code X} distributed according to this distribution, the</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * returned value is:</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * <p>\[ x = \begin{cases}</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb R : P(X \le x) \ge p\} &amp; \text{for } 0 \lt p \le 1 \\</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb R : P(X \le x) \gt 0 \} &amp; \text{for } p = 0</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * \end{cases} \]</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @param p Cumulative probability.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @return the smallest {@code p}-quantile of this distribution</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * (largest 0-quantile for {@code p = 0}).</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code p < 0} or {@code p > 1}.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">double</strong> inverseCumulativeProbability(<strong class="jxr_keyword">double</strong> p); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Computes the inverse survival probability function of this distribution. For a random</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * variable {@code X} distributed according to this distribution, the</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * returned value is:</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * <p>\[ x = \begin{cases}</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb R : P(X \ge x) \le p\} &amp; \text{for } 0 \le p \lt 1 \\</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb R : P(X \ge x) \lt 1 \} &amp; \text{for } p = 1</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * \end{cases} \]</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <p>By default, this is defined as {@code inverseCumulativeProbability(1 - p)}, but</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * the specific implementation may be more accurate.</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param p Survival probability.</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @return the smallest {@code (1-p)}-quantile of this distribution</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * (largest 0-quantile for {@code p = 1}).</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code p < 0} or {@code p > 1}.</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> inverseSurvivalProbability(<strong class="jxr_keyword">double</strong> p) { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> inverseCumulativeProbability(1 - p); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Gets the mean of this distribution.</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @return the mean.</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">double</strong> getMean(); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Gets the variance of this distribution.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @return the variance.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">double</strong> getVariance(); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Gets the lower bound of the support.</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * It must return the same value as</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * {@code inverseCumulativeProbability(0)}, i.e.</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * \( \inf \{ x \in \mathbb R : P(X \le x) \gt 0 \} \).</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @return the lower bound of the support.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">double</strong> getSupportLowerBound(); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Gets the upper bound of the support.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * It must return the same</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * value as {@code inverseCumulativeProbability(1)}, i.e.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * \( \inf \{ x \in \mathbb R : P(X \le x) = 1 \} \).</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @return the upper bound of the support.</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">double</strong> getSupportUpperBound(); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * Creates a sampler.</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param rng Generator of uniformly distributed numbers.</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @return a sampler that produces random numbers according this</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * distribution.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> Sampler createSampler(UniformRandomProvider rng); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * Distribution sampling functionality.</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> @FunctionalInterface +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">interface</strong> Sampler { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * Generates a random value sampled from this distribution.</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @return a random value.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">double</strong> sample(); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * Returns an effectively unlimited stream of {@code double} sample values.</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * <p>The default implementation produces a sequential stream that repeatedly</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * calls {@link #sample sample}().</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @return a stream of {@code double} values.</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">default</strong> DoubleStream samples() { +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> DoubleStream.generate(<strong class="jxr_keyword">this</strong>::sample).sequential(); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> } +<a class="jxr_linenumber" name="L207" href="#L207">207</a> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * Returns a stream producing the given {@code streamSize} number of {@code double}</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * sample values.</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * <p>The default implementation produces a sequential stream that repeatedly</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * calls {@link #sample sample}(); the stream is limited to the given {@code streamSize}.</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @param streamSize Number of values to generate.</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @return a stream of {@code double} values.</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">default</strong> DoubleStream samples(<strong class="jxr_keyword">long</strong> streamSize) { +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">return</strong> samples().limit(streamSize); +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
Added: dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DiscreteDistribution.html ============================================================================== --- dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DiscreteDistribution.html (added) +++ dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DiscreteDistribution.html Thu Dec 1 16:47:12 2022 @@ -0,0 +1,258 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>DiscreteDistribution xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/statistics/distribution/DiscreteDistribution.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.statistics.distribution; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.stream.IntStream; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.rng.UniformRandomProvider; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * Interface for distributions on the integers.</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="DiscreteDistribution" href="../../../../../org/apache/commons/statistics/distribution/DiscreteDistribution.html#DiscreteDistribution">DiscreteDistribution</a> { +<a class="jxr_linenumber" name="L26" href="#L26">26</a> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(X = x)}.</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * In other words, this method represents the probability mass function (PMF)</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * for the distribution.</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @param x Point at which the PMF is evaluated.</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @return the value of the probability mass function at {@code x}.</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">double</strong> probability(<strong class="jxr_keyword">int</strong> x); +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(x0 < X <= x1)}.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * The default implementation uses the identity</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * {@code P(x0 < X <= x1) = P(X <= x1) - P(X <= x0)}</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <p>Special cases:</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <li>returns {@code 0.0} if {@code x0 == x1};</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <li>returns {@code probability(x1)} if {@code x0 + 1 == x1};</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @param x0 Lower bound (exclusive).</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param x1 Upper bound (inclusive).</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this distribution</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * takes a value between {@code x0} and {@code x1}, excluding the lower</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * and including the upper endpoint.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code x0 > x1}.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> probability(<strong class="jxr_keyword">int</strong> x0, +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">int</strong> x1) { +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">if</strong> (x0 > x1) { +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="DistributionException" href="../../../../../org/apache/commons/statistics/distribution/DistributionException.html#DistributionException">DistributionException</a>(DistributionException.INVALID_RANGE_LOW_GT_HIGH, x0, x1); +<a class="jxr_linenumber" name="L61" href="#L61">61</a> } +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// Long addition avoids overflow</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (x0 + 1L >= x1) { +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">return</strong> x0 == x1 ? 0.0 : probability(x1); +<a class="jxr_linenumber" name="L65" href="#L65">65</a> } +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> cumulativeProbability(x1) - cumulativeProbability(x0); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> } +<a class="jxr_linenumber" name="L68" href="#L68">68</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code log(P(X = x))}, where</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * {@code log} is the natural logarithm.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @param x Point at which the PMF is evaluated.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @return the logarithm of the value of the probability mass function at</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * {@code x}.</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> logProbability(<strong class="jxr_keyword">int</strong> x) { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> Math.log(probability(x)); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> } +<a class="jxr_linenumber" name="L81" href="#L81">81</a> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(X <= x)}.</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * In other, words, this method represents the (cumulative) distribution</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * function (CDF) for this distribution.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param x Point at which the CDF is evaluated.</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this distribution</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * takes a value less than or equal to {@code x}.</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">double</strong> cumulativeProbability(<strong class="jxr_keyword">int</strong> x); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} whose values are distributed according</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * to this distribution, this method returns {@code P(X > x)}.</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * In other words, this method represents the complementary cumulative</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * distribution function.</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <p>By default, this is defined as {@code 1 - cumulativeProbability(x)}, but</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * the specific implementation may be more accurate.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @param x Point at which the survival function is evaluated.</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return the probability that a random variable with this</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * distribution takes a value greater than {@code x}.</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">double</strong> survivalProbability(<strong class="jxr_keyword">int</strong> x) { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> 1.0 - cumulativeProbability(x); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> } +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * Computes the quantile function of this distribution.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} distributed according to this distribution,</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * the returned value is:</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * <p>\[ x = \begin{cases}</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb Z : P(X \le x) \ge p\} &amp; \text{for } 0 \lt p \le 1 \\</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb Z : P(X \le x) \gt 0 \} &amp; \text{for } p = 0</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * \end{cases} \]</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <p>If the result exceeds the range of the data type {@code int},</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * then {@link Integer#MIN_VALUE} or {@link Integer#MAX_VALUE} is returned.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * In this case the result of {@link #cumulativeProbability(int) cumulativeProbability(x)}</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * called using the returned {@code p}-quantile may not compute the original {@code p}.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param p Cumulative probability.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @return the smallest {@code p}-quantile of this distribution</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * (largest 0-quantile for {@code p = 0}).</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code p < 0} or {@code p > 1}.</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">int</strong> inverseCumulativeProbability(<strong class="jxr_keyword">double</strong> p); +<a class="jxr_linenumber" name="L132" href="#L132">132</a> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Computes the inverse survival probability function of this distribution.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * For a random variable {@code X} distributed according to this distribution,</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * the returned value is:</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * <p>\[ x = \begin{cases}</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb Z : P(X \ge x) \le p\} &amp; \text{for } 0 \le p \lt 1 \\</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * \inf \{ x \in \mathbb Z : P(X \ge x) \lt 1 \} &amp; \text{for } p = 1</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * \end{cases} \]</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * <p>If the result exceeds the range of the data type {@code int},</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * then {@link Integer#MIN_VALUE} or {@link Integer#MAX_VALUE} is returned.</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * In this case the result of {@link #survivalProbability(int) survivalProbability(x)}</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * called using the returned {@code (1-p)}-quantile may not compute the original {@code p}.</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * <p>By default, this is defined as {@code inverseCumulativeProbability(1 - p)}, but</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * the specific implementation may be more accurate.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @param p Cumulative probability.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @return the smallest {@code (1-p)}-quantile of this distribution</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * (largest 0-quantile for {@code p = 1}).</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code p < 0} or {@code p > 1}.</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">default</strong> <strong class="jxr_keyword">int</strong> inverseSurvivalProbability(<strong class="jxr_keyword">double</strong> p) { +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">return</strong> inverseCumulativeProbability(1 - p); +<a class="jxr_linenumber" name="L158" href="#L158">158</a> } +<a class="jxr_linenumber" name="L159" href="#L159">159</a> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Gets the mean of this distribution.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @return the mean.</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">double</strong> getMean(); +<a class="jxr_linenumber" name="L166" href="#L166">166</a> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * Gets the variance of this distribution.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @return the variance.</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">double</strong> getVariance(); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * Gets the lower bound of the support.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * This method must return the same value as</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * {@code inverseCumulativeProbability(0)}, i.e.</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * \( \inf \{ x \in \mathbb Z : P(X \le x) \gt 0 \} \).</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * By convention, {@link Integer#MIN_VALUE} should be substituted</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * for negative infinity.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @return the lower bound of the support.</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">int</strong> getSupportLowerBound(); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Gets the upper bound of the support.</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * This method must return the same value as</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * {@code inverseCumulativeProbability(1)}, i.e.</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * \( \inf \{ x \in \mathbb Z : P(X \le x) = 1 \} \).</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * By convention, {@link Integer#MAX_VALUE} should be substituted</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * for positive infinity.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @return the upper bound of the support.</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">int</strong> getSupportUpperBound(); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * Creates a sampler.</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @param rng Generator of uniformly distributed numbers.</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @return a sampler that produces random numbers according this</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * distribution.</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> Sampler createSampler(UniformRandomProvider rng); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * Distribution sampling functionality.</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> @FunctionalInterface +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">interface</strong> Sampler { +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * Generates a random value sampled from this distribution.</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @return a random value.</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">int</strong> sample(); +<a class="jxr_linenumber" name="L218" href="#L218">218</a> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Returns an effectively unlimited stream of {@code int} sample values.</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * <p>The default implementation produces a sequential stream that repeatedly</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * calls {@link #sample sample}().</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @return a stream of {@code int} values.</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">default</strong> IntStream samples() { +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> IntStream.generate(<strong class="jxr_keyword">this</strong>::sample).sequential(); +<a class="jxr_linenumber" name="L229" href="#L229">229</a> } +<a class="jxr_linenumber" name="L230" href="#L230">230</a> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * Returns a stream producing the given {@code streamSize} number of {@code int}</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * sample values.</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * <p>The default implementation produces a sequential stream that repeatedly</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * calls {@link #sample sample}(); the stream is limited to the given {@code streamSize}.</em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param streamSize Number of values to generate.</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * @return a stream of {@code int} values.</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">default</strong> IntStream samples(<strong class="jxr_keyword">long</strong> streamSize) { +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">return</strong> samples().limit(streamSize); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } +<a class="jxr_linenumber" name="L244" href="#L244">244</a> } +<a class="jxr_linenumber" name="L245" href="#L245">245</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> Added: dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DistributionException.html ============================================================================== --- dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DistributionException.html (added) +++ dev/commons/statistics/1.0-RC1/site/xref/org/apache/commons/statistics/distribution/DistributionException.html Thu Dec 1 16:47:12 2022 @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>DistributionException xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/statistics/distribution/DistributionException.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.statistics.distribution; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> * Package private exception class with constants for frequently used messages.</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">class</strong> <a name="DistributionException" href="../../../../../org/apache/commons/statistics/distribution/DistributionException.html#DistributionException">DistributionException</a> <strong class="jxr_keyword">extends</strong> IllegalArgumentException { +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/** Error message for "too large" condition when "x > y". */</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TOO_LARGE = <span class="jxr_string">"%s > %s"</span>; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/** Error message for "too small" condition when "x < y". */</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TOO_SMALL = <span class="jxr_string">"%s < %s"</span>; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/** Error message for "out of range" condition when "x not in [a, b]". */</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String OUT_OF_RANGE = <span class="jxr_string">"Number %s is out of range [%s, %s]"</span>; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/** Error message for "invalid range" condition when "lower >= upper". */</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INVALID_RANGE_LOW_GTE_HIGH = <span class="jxr_string">"Lower bound %s >= upper bound %s"</span>; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/** Error message for "invalid range" condition when "lower > upper". */</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INVALID_RANGE_LOW_GT_HIGH = <span class="jxr_string">"Lower bound %s > upper bound %s"</span>; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/** Error message for "invalid probability" condition when "x not in [0, 1]". */</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INVALID_PROBABILITY = <span class="jxr_string">"Not a probability: %s is out of range [0, 1]"</span>; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/** Error message for "invalid non-zero probability" condition when "x not in (0, 1]". */</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String INVALID_NON_ZERO_PROBABILITY = <span class="jxr_string">"Not a non-zero probability: %s is out of range (0, 1]"</span>; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/** Error message for "negative" condition when "x < 0". */</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NEGATIVE = <span class="jxr_string">"Number %s is negative"</span>; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/** Error message for "not strictly positive" condition when "x <= 0". */</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NOT_STRICTLY_POSITIVE = <span class="jxr_string">"Number %s is not greater than 0"</span>; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/** Error message for "not strictly positive" condition when "x <= 0". */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NOT_STRICTLY_POSITIVE_FINITE = <span class="jxr_string">"Number %s is not greater than 0 and finite"</span>; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/** Serializable version identifier. */</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 20180119L; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Creates an exception.</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param message Exception message with replaceable parameters.</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param formatArguments Arguments for formatting the message.</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <a name="DistributionException" href="../../../../../org/apache/commons/statistics/distribution/DistributionException.html#DistributionException">DistributionException</a>(String message, Object... formatArguments) { +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">super</strong>(String.format(Locale.ROOT, message, formatArguments)); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
