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 $Revision: 670469 $ $Date: 2008-06-23 04:01:38 -0400 (Mon, 23 Jun 2008) $
032     */
033    public interface HypergeometricDistribution extends IntegerDistribution {
034        /**
035         * Access the number of successes.
036         * @return the number of successes.
037         */
038        public abstract int getNumberOfSuccesses();
039        
040        /**
041         * Access the population size.
042         * @return the population size.
043         */
044        public abstract int getPopulationSize();
045        
046        /**
047         * Access the sample size.
048         * @return the sample size.
049         */
050        public abstract int getSampleSize();
051        
052        /**
053         * Modify the number of successes.
054         * @param num the new number of successes.
055         */
056        public abstract void setNumberOfSuccesses(int num);
057        
058        /**
059         * Modify the population size.
060         * @param size the new population size.
061         */
062        public abstract void setPopulationSize(int size);
063        
064        /**
065         * Modify the sample size.
066         * @param size the new sample size.
067         */
068        public abstract void setSampleSize(int size);
069    }