01: /*
02: * Copyright 2005 The Apache Software Foundation.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: * Cauchy Distribution.
21: * Instances of CauchyDistribution objects should be created using
22: * {@link DistributionFactory#createCauchyDistribution(double, double)}.<p>
23: *
24: * <p>
25: * References:<p>
26: * <ul>
27: * <li><a href="http://mathworld.wolfram.com/CauchyDistribution.html">
28: * Cauchy Distribution</a></li>
29: * </ul>
30: * </p>
31: *
32: * @since 1.1
33: * @version $Revision: 201915 $ $Date: 2005-06-26 15:20:57 -0700 (Sun, 26 Jun 2005) $
34: */
35: public interface CauchyDistribution extends ContinuousDistribution {
36:
37: /**
38: * Access the median.
39: * @return median for this distribution
40: */
41: double getMedian();
42:
43: /**
44: * Access the scale parameter.
45: * @return scale parameter for this distribution
46: */
47: double getScale();
48:
49: /**
50: * Modify the median.
51: * @param median for this distribution
52: */
53: void setMedian(double median);
54:
55: /**
56: * Modify the scale parameter.
57: * @param s scale parameter for this distribution
58: */
59: void setScale(double s);
60: }
|