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
18 package org.apache.commons.math.distribution;
19
20 /**
21 * The Hypergeometric Distribution.
22 *
23 * <p>
24 * References:
25 * <ul>
26 * <li><a href="http://mathworld.wolfram.com/HypergeometricDistribution.html">
27 * Hypergeometric Distribution</a></li>
28 * </ul>
29 * </p>
30 *
31 * @version $Revision: 545192 $ $Date: 2007-06-07 07:35:04 -0700 (Thu, 07 Jun 2007) $
32 */
33 public interface HypergeometricDistribution extends IntegerDistribution {
34 /**
35 * Access the number of successes.
36 * @return the number of successes.
37 */
38 public abstract int getNumberOfSuccesses();
39
40 /**
41 * Access the population size.
42 * @return the population size.
43 */
44 public abstract int getPopulationSize();
45
46 /**
47 * Access the sample size.
48 * @return the sample size.
49 */
50 public abstract int getSampleSize();
51
52 /**
53 * Modify the number of successes.
54 * @param num the new number of successes.
55 */
56 public abstract void setNumberOfSuccesses(int num);
57
58 /**
59 * Modify the population size.
60 * @param size the new population size.
61 */
62 public abstract void setPopulationSize(int size);
63
64 /**
65 * Modify the sample size.
66 * @param size the new sample size.
67 */
68 public abstract void setSampleSize(int size);
69 }