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  
18  package org.apache.commons.math.distribution;
19  
20  /**
21   * Cauchy Distribution.
22   *
23   * <p>
24   * References:
25   * <ul>
26   * <li><a href="http://mathworld.wolfram.com/CauchyDistribution.html">
27   * Cauchy Distribution</a></li>
28   * </ul>
29   * </p>
30   *
31   * @since 1.1
32   * @version $Revision: 670469 $ $Date: 2008-06-23 04:01:38 -0400 (Mon, 23 Jun 2008) $
33   */
34  public interface CauchyDistribution extends ContinuousDistribution {
35      
36      /**
37       * Access the median.
38       * @return median for this distribution
39       */
40      double getMedian();
41      
42      /**
43       * Access the scale parameter.
44       * @return scale parameter for this distribution
45       */
46      double getScale();
47      
48      /**
49       * Modify the median.
50       * @param median for this distribution
51       */
52      void setMedian(double median);
53      
54      /**
55       * Modify the scale parameter.
56       * @param s scale parameter for this distribution
57       */
58      void setScale(double s);
59  }