View Javadoc

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: 705239 $ $Date: 2008-10-16 09:32:32 -0400 (Thu, 16 Oct 2008) $
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        */
33       void setAlpha(double alpha);
34  
35       /**
36        * Access the shape parameter, alpha
37        * @return alpha.
38        */
39       double getAlpha();
40  
41       /**
42        * Modify the shape parameter, beta.
43        * @param beta the new scale parameter.
44        */
45       void setBeta(double beta);
46  
47       /**
48        * Access the shape parameter, beta
49        * @return beta.
50        */
51       double getBeta();
52  
53       /**
54        * Return the probability density for a particular point.
55        * @param x  The point at which the density should be computed.
56        * @return  The pdf at point x.
57        * @exception MathException if probability density cannot be computed
58        */
59       double density(Double x) throws MathException;
60  
61  }