blob: bd1df5e68945c8693bf2accbdd457948ecc596b1 [file] [log] [blame]
Raymonddee08492015-04-02 10:43:13 -07001/*
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
18package org.apache.commons.math.distribution;
19
20/**
21 * Weibull Distribution. This interface defines the two parameter form of the
22 * distribution as defined by
23 * <a href="http://mathworld.wolfram.com/WeibullDistribution.html">
24 * Weibull Distribution</a>, equations (1) and (2).
25 *
26 * <p>
27 * References:
28 * <ul>
29 * <li><a href="http://mathworld.wolfram.com/WeibullDistribution.html">
30 * Weibull Distribution</a></li>
31 * </ul>
32 * </p>
33 *
34 * @since 1.1
35 * @version $Revision: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $
36 */
37public interface WeibullDistribution extends ContinuousDistribution {
38
39 /**
40 * Access the shape parameter.
41 * @return the shape parameter.
42 */
43 double getShape();
44
45 /**
46 * Access the scale parameter.
47 * @return the scale parameter.
48 */
49 double getScale();
50
51 /**
52 * Modify the shape parameter.
53 * @param alpha The new shape parameter value.
54 * @deprecated as of v2.1
55 */
56 @Deprecated
57 void setShape(double alpha);
58
59 /**
60 * Modify the scale parameter.
61 * @param beta The new scale parameter value.
62 * @deprecated as of v2.1
63 */
64 @Deprecated
65 void setScale(double beta);
66}