001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.math.distribution;
019    
020    /**
021     * The Hypergeometric Distribution.
022     *
023     * <p>
024     * References:
025     * <ul>
026     * <li><a href="http://mathworld.wolfram.com/HypergeometricDistribution.html">
027     * Hypergeometric Distribution</a></li>
028     * </ul>
029     * </p>
030     *
031     * @version $Id: HypergeometricDistribution.java 1131229 2011-06-03 20:49:25Z luc $
032     */
033    public interface HypergeometricDistribution extends IntegerDistribution {
034        /**
035         * Access the number of successes.
036         *
037         * @return the number of successes.
038         */
039        int getNumberOfSuccesses();
040    
041        /**
042         * Access the population size.
043         *
044         * @return the population size.
045         */
046        int getPopulationSize();
047    
048        /**
049         * Access the sample size.
050         *
051         * @return the sample size.
052         */
053        int getSampleSize();
054    }