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 import org.apache.commons.math.MathException;
     20 
     21 /**
     22  * Computes the cumulative, inverse cumulative and density functions for the beta distribuiton.
     23  *
     24  * @see <a href="http://en.wikipedia.org/wiki/Beta_distribution">Beta_distribution</a>
     25  * @version $Revision: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $
     26  * @since 2.0
     27  */
     28 public interface BetaDistribution extends ContinuousDistribution, HasDensity<Double> {
     29     /**
     30      * Modify the shape parameter, alpha.
     31      * @param alpha the new shape parameter.
     32      * @deprecated as of 2.1
     33      */
     34     @Deprecated
     35     void setAlpha(double alpha);
     36 
     37      /**
     38       * Access the shape parameter, alpha
     39       * @return alpha.
     40       */
     41      double getAlpha();
     42 
     43      /**
     44       * Modify the shape parameter, beta.
     45       * @param beta the new scale parameter.
     46       * @deprecated as of 2.1
     47       */
     48      @Deprecated
     49      void setBeta(double beta);
     50 
     51      /**
     52       * Access the shape parameter, beta
     53       * @return beta.
     54       */
     55      double getBeta();
     56 
     57      /**
     58       * Return the probability density for a particular point.
     59       * @param x  The point at which the density should be computed.
     60       * @return  The pdf at point x.
     61       * @exception MathException if probability density cannot be computed
     62       */
     63      double density(Double x) throws MathException;
     64 
     65 }
     66