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: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $ 32 */ 33 public interface HypergeometricDistribution extends IntegerDistribution { 34 35 /** 36 * Access the number of successes. 37 * @return the number of successes. 38 */ 39 int getNumberOfSuccesses(); 40 41 /** 42 * Access the population size. 43 * @return the population size. 44 */ 45 int getPopulationSize(); 46 47 /** 48 * Access the sample size. 49 * @return the sample size. 50 */ 51 int getSampleSize(); 52 53 /** 54 * Modify the number of successes. 55 * @param num the new number of successes. 56 * @deprecated as of v2.1 57 */ 58 @Deprecated 59 void setNumberOfSuccesses(int num); 60 61 /** 62 * Modify the population size. 63 * @param size the new population size. 64 * @deprecated as of v2.1 65 */ 66 @Deprecated 67 void setPopulationSize(int size); 68 69 /** 70 * Modify the sample size. 71 * @param size the new sample size. 72 * @deprecated as of v2.1 73 */ 74 @Deprecated 75 void setSampleSize(int size); 76 } 77
