    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: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $
    032     */
    033    public interface HypergeometricDistribution extends IntegerDistribution {
    034
    035        /**
    036         * Access the number of successes.
    037         * @return the number of successes.
    038         */
    039        int getNumberOfSuccesses();
    040
    041        /**
    042         * Access the population size.
    043         * @return the population size.
    044         */
    045        int getPopulationSize();
    046
    047        /**
    048         * Access the sample size.
    049         * @return the sample size.
    050         */
    051        int getSampleSize();
    052
    053        /**
    054         * Modify the number of successes.
    055         * @param num the new number of successes.
    056         * @deprecated as of v2.1
    057         */
    058        @Deprecated
    059        void setNumberOfSuccesses(int num);
    060
    061        /**
    062         * Modify the population size.
    063         * @param size the new population size.
    064         * @deprecated as of v2.1
    065         */
    066        @Deprecated
    067        void setPopulationSize(int size);
    068
    069        /**
    070         * Modify the sample size.
    071         * @param size the new sample size.
    072         * @deprecated as of v2.1
    073         */
    074        @Deprecated
    075        void setSampleSize(int size);
    076    }