View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.math.distribution;
18  
19  /**
20   * Weibull Distribution.  This interface defines the two parameter form of the
21   * distribution as defined by
22   * <a href="http://mathworld.wolfram.com/WeibullDistribution.html">
23   * Weibull Distribution</a>, equations (1) and (2).
24   *
25   * Instances of WeibullDistribution objects should be created using
26   * {@link DistributionFactory#createWeibullDistribution(double, double)}
27   *
28   * <p>
29   * References:
30   * <ul>
31   * <li><a href="http://mathworld.wolfram.com/WeibullDistribution.html">
32   * Weibull Distribution</a></li>
33   * </ul>
34   * </p>
35   *
36   * @since 1.1
37   * @version $Revision: 1.12 $ $Date: 2004-06-23 11:26:18 -0500 (Wed, 23 Jun 2004) $
38   */
39  public interface WeibullDistribution extends ContinuousDistribution {
40  
41      /**
42       * Access the shape parameter.
43       * @return the shape parameter.
44       */
45      double getShape();
46      
47      /**
48       * Access the scale parameter.
49       * @return the scale parameter.
50       */
51      double getScale();
52      
53      /**
54       * Modify the shape parameter.
55       * @param alpha The new shape parameter value.
56       */
57      void setShape(double alpha);
58      
59      /**
60       * Modify the scale parameter.
61       * @param beta The new scale parameter value.
62       */
63      void setScale(double beta);
64  }