Likelihood
Class Likelihood.SiteLikelihood

java.lang.Object
  extended by Likelihood.Likelihood.SiteLikelihood
All Implemented Interfaces:
java.io.Serializable
Enclosing class:
Likelihood

public static class Likelihood.SiteLikelihood
extends java.lang.Object
implements java.io.Serializable

Stored the result of a likelihood calculation for a single site

Version:
1.0
See Also:
Serialized Form

Method Summary
 double getLikelihood()
          Get the likelihood
 RateCategory getMostProbableRateCategory()
          Gets the most probable rate category
 double getRateCategoryProbability(RateCategory rc)
          Gets the probability of being in a rate category
 Likelihood.RateLikelihood getRateLikelihood(RateCategory rate)
          Get the likelihood for a single rate class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLikelihood

public double getLikelihood()
Get the likelihood

Returns:
The likelihood

getRateLikelihood

public Likelihood.RateLikelihood getRateLikelihood(RateCategory rate)
                                            throws Likelihood.LikelihoodException
Get the likelihood for a single rate class

Parameters:
rate - Rate class to get the likelihood for
Returns:
The likelihood results for a given rate
Throws:
Likelihood.LikelihoodException - Thrown if no likelihood has been calculated for the given rate

getRateCategoryProbability

public double getRateCategoryProbability(RateCategory rc)
Gets the probability of being in a rate category

Parameters:
rc - The rate category
Returns:
The probability of being in that rate category

getMostProbableRateCategory

public RateCategory getMostProbableRateCategory()
Gets the most probable rate category

Returns:
The most probable rate category