View Javadoc

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