From 81b1571ad38e8648f004ca4ac06d253495f3207b Mon Sep 17 00:00:00 2001
From: Brent Worden <brentworden@apache.org>
Date: Tue, 9 Nov 2004 02:26:55 +0000
Subject: [PATCH] added poisson description to user guide.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@141501 13f79535-47bb-0310-9956-ffa450edef68
---
 xdocs/userguide/distribution.xml | 20 +++++++++++++++++++-
 xdocs/userguide/index.xml        |  4 ++--
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/xdocs/userguide/distribution.xml b/xdocs/userguide/distribution.xml
index 43e4798d3..b188c3370 100644
--- a/xdocs/userguide/distribution.xml
+++ b/xdocs/userguide/distribution.xml
@@ -17,7 +17,7 @@
   -->
   
 <?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?>
-<!-- $Revision: 1.1 $ $Date: 2004/04/26 20:06:50 $ -->
+<!-- $Revision: 1.2 $ $Date: 2004/11/09 02:26:55 $ -->
 <document url="stat.html">
   <properties>
     <title>The Commons Math User Guide - Statistics</title>
@@ -60,6 +60,7 @@ BinomialDistribution binomial = factory.createBinomialDistribution(10, .75);</so
             <tr><td>Gamma</td><td>createGammaDistribution</td><td><div>Alpha</div><div>Beta</div></td></tr>
             <tr><td>Hypergeometric</td><td>createHypogeometricDistribution</td><td><div>Population size</div><div>Number of successes in population</div><div>Sample size</div></td></tr>
             <tr><td>Normal (Gaussian)</td><td>createNormalDistribution</td><td><div>Mean</div><div>Standard Deviation</div></td></tr>
+            <tr><td>Poisson</td><td>createPoissonDistribution</td><td><div>Mean</div></td></tr>
             <tr><td>t</td><td>createTDistribution</td><td><div>Degrees of freedom</div></td></tr>
           </table>
         </p>
@@ -89,6 +90,23 @@ double upperTail = 1.0 - t.cumulativeProbability(2.75); // P(T &gt;= 2.75)</sour
           less-than or equal to the given probability.
         </p>
       </subsection>
+      <subsection name="8.3 User Defined Distributions" href="userdefined">
+        <p>
+        Since there are numerous distributions and Commons-Math only directly supports a handfull,
+        it may be necessary to extend the distribution framework to satisfy individual needs.  It
+        is recommended that the <code>Distribution</code>, <code>ContinuousDistribution</code>,
+        <code>DiscreteDistribution</code>, and <code>IntegerDistribution</code> interfaces serve as
+        base types for any extension.  These serve as the basis for all the distributions directly
+        supported by Commons-Math and using those interfaces for implementation purposes will
+        insure any extension is compatible with the remainder of Commons-Math.  To aid in
+        implementing a distribution extension, the <code>AbstractDistribution</code>,
+        <code>AbstractContinuousDistribution</code>, and <code>AbstractIntegerDistribution</code>
+        provide implementation building blocks and offer a lot of default distribution
+        functionality.  By extending these abstract classes directly, a good portion of the
+        repetative distribution implementation is already developed and should same time and effort
+        in developing user defined distributions.
+        </p>
+      </subsection>
     </section>
   </body>
 </document>
diff --git a/xdocs/userguide/index.xml b/xdocs/userguide/index.xml
index 7c97527f7..be2f42ba3 100644
--- a/xdocs/userguide/index.xml
+++ b/xdocs/userguide/index.xml
@@ -17,7 +17,7 @@
   -->
   
 <?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?>
-<!-- $Revision: 1.12 $ $Date: 2004/10/08 05:08:21 $ -->
+<!-- $Revision: 1.13 $ $Date: 2004/11/09 02:26:55 $ -->
 <document url="index.html">
   <properties>
     <title>The Commons Math User Guide - Table of Contents</title>
@@ -43,7 +43,6 @@
                 <li><a href="stat.html#frequency">1.3 Frequency distributions</a></li>
                 <li><a href="stat.html#regression">1.4 Simple regression</a></li>
                 <li><a href="stat.html#tests">1.5 Statistical tests</a></li>
-                <li><a href="stat.html#distributions">1.6 Distribution framework</a></li>
                 </ul></li>
             <li><a href="random.html">2. Data Generation</a>
                 <ul>
@@ -91,6 +90,7 @@
                 <ul>
                 <li><a href="distribution.html#overview">8.1 Overview</a></li>
                 <li><a href="distribution.html#distributions">8.2 Distribution Framework</a></li>
+                <li><a href="distribution.html#userdefined">8.3 User Defined Distributions</a></li>
                 </ul></li>                                 
         </ul>
       </section>