View Javadoc

1   /*
2    * Copyright 2003-2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.math.distribution;
17  
18  /**
19   * The Binomial Distribution.
20   *
21   * Instances of BinomialDistribution objects should be created using
22   * {@link DistributionFactory#createBinomialDistribution(int, double)}.
23   *
24   * <p>
25   * References:
26   * <ul>
27   * <li><a href="http://mathworld.wolfram.com/BinomialDistribution.html">
28   * Binomial Distribution</a></li>
29   * </ul>
30   * </p>
31   *
32   * @version $Revision: 155427 $ $Date: 2005-02-26 06:11:52 -0700 (Sat, 26 Feb 2005) $
33   */
34  public interface BinomialDistribution extends IntegerDistribution {
35      /**
36       * Access the number of trials for this distribution.
37       * @return the number of trials.
38       */
39      int getNumberOfTrials();
40      
41      /**
42       * Access the probability of success for this distribution.
43       * @return the probability of success.
44       */
45      double getProbabilityOfSuccess();
46      
47      /**
48       * Change the number of trials for this distribution.
49       * @param trials the new number of trials.
50       */
51      void setNumberOfTrials(int trials);
52      
53      /**
54       * Change the probability of success for this distribution.
55       * @param p the new probability of success.
56       */
57      void setProbabilityOfSuccess(double p);
58  }