Likelihood

Class Calculator.SiteCalculator

java.lang.Object

Likelihood.Calculator.SiteCalculator

All Implemented Interfaces:

java.util.concurrent.Callable<SiteLikelihood>

Enclosing class:

Calculator<R extends Likelihood>

public class Calculator.SiteCalculator
extends java.lang.Object
implements java.util.concurrent.Callable<SiteLikelihood>

Calculates the likelihood of a single site. Implemeted like this as it allows parrallel calculation.

Version:

2.0

Constructor Summary

Constructors

Constructor and Description
Calculator.SiteCalculator(Site s, Tree t, Parameters p, Probabilities tp, java.util.Map<java.lang.String,SiteLikelihood.NodeLikelihood> nl) Standard constructor

Method Summary

Methods

Modifier and Type	Method and Description
SiteLikelihood	call()
SiteLikelihood	getResult() Gets the computed result

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Calculator.SiteCalculator

public Calculator.SiteCalculator(Site s,
                         Tree t,
                         Parameters p,
                         Probabilities tp,
                         java.util.Map<java.lang.String,SiteLikelihood.NodeLikelihood> nl)

Standard constructor

Parameters:

s - The site to calculate the likelihood for

t - The tree to be used in the calculation

p - The parameters to be used in the calculation

tp - Pre-computed datastructure containing probabilities

nl - Initialised node likelihoods based on the site. See Site.getInitialNodeLikelihoods(Trees.Tree, java.util.Map).

Method Detail

call

public SiteLikelihood call()
                    throws Parameters.ParameterException

Specified by:

call in interface java.util.concurrent.Callable<SiteLikelihood>

Throws:

Parameters.ParameterException

getResult

public SiteLikelihood getResult()
                         throws Likelihood.Calculator.ResultNotComputed

Gets the computed result

Returns:

The computed result

Throws:

Likelihood.Calculator.ResultNotComputed - If the result has not been computed for any reason.