Distribution.java
01 /*
02  * Java Genetic Algorithm Library (jenetics-1.6.0).
03  * Copyright (c) 2007-2014 Franz Wilhelmstötter
04  *
05  * Licensed under the Apache License, Version 2.0 (the "License");
06  * you may not use this file except in compliance with the License.
07  * You may obtain a copy of the License at
08  *
09  *      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  * Author:
18  *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
19  */
20 package org.jenetics.stat;
21 
22 import org.jscience.mathematics.number.Float64;
23 
24 import org.jenetics.util.Function;
25 import org.jenetics.util.Range;
26 
27 /**
28  * Defines the <i>domain</i><i>PDF</i> and <i>CDF</i> of a probability
29  * distribution.
30  *
31  @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
32  @since 1.0
33  @version 1.0 &mdash; <em>$Date: 2013-08-29 $</em>
34  */
35 public interface Distribution<C extends Comparable<? super C>> {
36 
37     /**
38      * Return the domain of this probability distribution.
39      *
40      @return the domain of this probability distribution.
41      */
42     public Range<C> getDomain();
43 
44     /**
45      * Return a new instance of the <i>Cumulative Distribution Function</i> (CDF).
46      *
47      @see <a href="http://en.wikipedia.org/wiki/Cumulative_distribution_function">CDF</a>
48      *
49      @return the <i>Cumulative Distribution Function</i>.
50      */
51     public Function<C, Float64> getCDF();
52 
53     /**
54      * Return a new instance of the <i>Probability Density Function</i> (PDF).
55      *
56      @see <a href="http://en.wikipedia.org/wiki/Probability_density_function">PDF</a>
57      *
58      @return the <i>Probability Density Function</i>.
59      */
60     public Function<C, Float64> getPDF();
61 
62 }