View Javadoc
1   /*
2    * The baseCode project
3    * 
4    * Copyright (c) 2006 University of British Columbia
5    * 
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *       http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   *
18   */
19  package ubic.basecode.math.distribution;
20  
21  /**
22   * An interface that describes objects that can produce probabilities according to some distribution.
23   * 
24   * @author pavlidis
25   * 
26   */
27  public interface ProbabilityComputer {
28  
29      /**
30       * Return the probability associated with a certain value.The upper tail of the associated distribution is returned.
31       * 
32       * @param value
33       * @return
34       */
35      public double probability( double value );
36  
37      /**
38       * Return the probability associated with a certain value, with choice of tail.
39       * 
40       * @param value
41       * @param upperTail
42       * @return
43       */
44      public double probability( double value, boolean upperTail );
45  
46  }