View Javadoc

1   /*
2    * Copyright 2006 - 2012 Christina Bohk and Roland Ewald
3    *  
4    * Licensed under the Apache License, Version 2.0 (the "License"); 
5    * you may not use this file except in compliance with the License. 
6    * You may obtain a copy of the License at 
7    *  
8    *  http://www.apache.org/licenses/LICENSE-2.0
9    *  
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  package p3j.pppm;
17  
18  /**
19   * This is an interface for all objects that might occur by some probability.
20   * E.g., sets and parameter assignments.
21   * 
22   * Created on January 21, 2007
23   * 
24   * @author Christina Bohk
25   * @author Roland Ewald
26   * 
27   */
28  public interface IStochasticOccurrence {
29  
30    /**
31     * Get the probability that this entity will be chosen.
32     * 
33     * @return probability to be chosen, in [0,1]
34     */
35    double getProbability();
36  
37    /**
38     * Set probability for being chosen.
39     * 
40     * @param probability
41     *          the probability (in [0,1])
42     */
43    void setProbability(double probability);
44  
45  }