Home | History | Annotate | Download | only in distribution
      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 package org.apache.commons.math.distribution;
     18 
     19 /**
     20  * The Gamma Distribution.
     21  *
     22  * <p>
     23  * References:
     24  * <ul>
     25  * <li><a href="http://mathworld.wolfram.com/GammaDistribution.html">
     26  * Gamma Distribution</a></li>
     27  * </ul>
     28  * </p>
     29  *
     30  * @version $Revision: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $
     31  */
     32 public interface GammaDistribution extends ContinuousDistribution, HasDensity<Double> {
     33     /**
     34      * Modify the shape parameter, alpha.
     35      * @param alpha the new shape parameter.
     36      * @deprecated as of v2.1
     37      */
     38     @Deprecated
     39     void setAlpha(double alpha);
     40 
     41     /**
     42      * Access the shape parameter, alpha
     43      * @return alpha.
     44      */
     45     double getAlpha();
     46 
     47     /**
     48      * Modify the scale parameter, beta.
     49      * @param beta the new scale parameter.
     50      * @deprecated as of v2.1
     51      */
     52     @Deprecated
     53     void setBeta(double beta);
     54 
     55     /**
     56      * Access the scale parameter, beta
     57      * @return beta.
     58      */
     59     double getBeta();
     60 
     61     /**
     62      * Return the probability density for a particular point.
     63      * @param x  The point at which the density should be computed.
     64      * @return  The pdf at point x.
     65      */
     66     double density(Double x);
     67 }
     68