Package pal.treesearch
Class SRDTGlobalClockModel
java.lang.Object
pal.treesearch.SRDTGlobalClockModel
- All Implemented Interfaces:
MolecularClockLikelihoodModel.HeightConverter,NeoParameterized,ConstraintModel,ConstraintModel.GroupManager
public class SRDTGlobalClockModel
extends Object
implements ConstraintModel, ConstraintModel.GroupManager, NeoParameterized, MolecularClockLikelihoodModel.HeightConverter
-
Nested Class Summary
Nested classes/interfaces inherited from interface pal.treesearch.ConstraintModel
ConstraintModel.GroupManager -
Constructor Summary
ConstructorsConstructorDescriptionSRDTGlobalClockModel(SampleInformation sampleInformation, MolecularClockLikelihoodModel.Instance likelihoodModel) SRDTGlobalClockModel(SampleInformation sampleInformation, MolecularClockLikelihoodModel.Instance likelihoodModel, boolean allowMetaRate) -
Method Summary
Modifier and TypeMethodDescriptioncreateAppropriateConditionalProbabilityStore(boolean isForLeaf) createNewClockLeaf(PatternInfo pattern, int[] patternStateMatchup) createNewFreeLeaf(int[] patternStateMatchup, int numberOfPatterns) doublegetBaseHeight(double originalExpectSubstitutionHeight) intString[][]getCladeConstraints(String[] allLabelSet) Obtain the permanent clade sets.voidgetDefaultValues(double[] store, int startIndex) get default value parameter valuesdoublegetExpectedSubstitutionDistance(double lowerBaseHeight, double upperBaseHeight) doublegetExpectedSubstitutionHeight(double baseHeight) getGlobalClockConstraintGrouping(String[] leafLabelSet) Enquire about the clock constraint grouping of the leafdoublegetLeafBaseHeight(String leafLabel) doublegetLowerLimit(int n) get lower parameter limitintget number of parametersvoidgetParameters(double[] store, int startIndex) get model parameterdoubledoublegetUpperLimit(int n) get upper parameter limitvoidinitialiseParameters(String[] leafNames, double[] leafHeights) voidsetParameters(double[] parameters, int startIndex) set model parametervoidsetSubstitutionRate(double rate)
-
Constructor Details
-
SRDTGlobalClockModel
public SRDTGlobalClockModel(SampleInformation sampleInformation, MolecularClockLikelihoodModel.Instance likelihoodModel) -
SRDTGlobalClockModel
public SRDTGlobalClockModel(SampleInformation sampleInformation, MolecularClockLikelihoodModel.Instance likelihoodModel, boolean allowMetaRate)
-
-
Method Details
-
getRateModelSummary
- Specified by:
getRateModelSummaryin interfaceConstraintModel
-
getGlobalClockConstraintGrouping
Description copied from interface:ConstraintModelEnquire about the clock constraint grouping of the leaf- Specified by:
getGlobalClockConstraintGroupingin interfaceConstraintModel- Returns:
- the grouping of the leaf, or null if outside the leaf is unconstrained (free)
-
getCladeConstraints
Description copied from interface:ConstraintModelObtain the permanent clade sets. That is, when randomly building the tree, and when tree searching, what labels must always form a clade.- Specified by:
getCladeConstraintsin interfaceConstraintModel- Parameters:
allLabelSet- The set of all leaf labels in the tree- Returns:
- An array of string arrays dividing up the label set
-
createNewFreeLeaf
public UnconstrainedLikelihoodModel.Leaf createNewFreeLeaf(int[] patternStateMatchup, int numberOfPatterns) - Specified by:
createNewFreeLeafin interfaceConstraintModel
-
createNewFreeExternal
- Specified by:
createNewFreeExternalin interfaceConstraintModel
-
createNewFreeInternal
- Specified by:
createNewFreeInternalin interfaceConstraintModel
-
createAppropriateConditionalProbabilityStore
- Specified by:
createAppropriateConditionalProbabilityStorein interfaceConstraintModel
-
getSubstitutionRate
public double getSubstitutionRate() -
setSubstitutionRate
public void setSubstitutionRate(double rate) -
getGlobalParameterAccess
- Specified by:
getGlobalParameterAccessin interfaceConstraintModel
-
getLeafBaseHeight
- Specified by:
getLeafBaseHeightin interfaceConstraintModel.GroupManager
-
getBaseHeight
public double getBaseHeight(double originalExpectSubstitutionHeight) - Specified by:
getBaseHeightin interfaceConstraintModel.GroupManager
-
getBaseHeightUnits
public int getBaseHeightUnits()- Specified by:
getBaseHeightUnitsin interfaceConstraintModel.GroupManager
-
initialiseParameters
- Specified by:
initialiseParametersin interfaceConstraintModel.GroupManager
-
getAllGroupRelatedParameterAccess
- Specified by:
getAllGroupRelatedParameterAccessin interfaceConstraintModel.GroupManager
-
getPrimaryGroupRelatedParameterAccess
- Specified by:
getPrimaryGroupRelatedParameterAccessin interfaceConstraintModel.GroupManager
-
getSecondaryGroupRelatedParameterAccess
- Specified by:
getSecondaryGroupRelatedParameterAccessin interfaceConstraintModel.GroupManager
-
createNewClockLeaf
public MolecularClockLikelihoodModel.Leaf createNewClockLeaf(PatternInfo pattern, int[] patternStateMatchup) - Specified by:
createNewClockLeafin interfaceConstraintModel.GroupManager
-
createNewClockExternal
- Specified by:
createNewClockExternalin interfaceConstraintModel.GroupManager
-
createNewClockInternal
- Specified by:
createNewClockInternalin interfaceConstraintModel.GroupManager
-
getExpectedSubstitutionHeight
public double getExpectedSubstitutionHeight(double baseHeight) - Specified by:
getExpectedSubstitutionHeightin interfaceConstraintModel.GroupManager- Specified by:
getExpectedSubstitutionHeightin interfaceMolecularClockLikelihoodModel.HeightConverter
-
getExpectedSubstitutionDistance
public double getExpectedSubstitutionDistance(double lowerBaseHeight, double upperBaseHeight) - Specified by:
getExpectedSubstitutionDistancein interfaceMolecularClockLikelihoodModel.HeightConverter
-
getNumberOfParameters
public int getNumberOfParameters()Description copied from interface:NeoParameterizedget number of parameters- Specified by:
getNumberOfParametersin interfaceNeoParameterized- Returns:
- number of parameters
-
setParameters
public void setParameters(double[] parameters, int startIndex) Description copied from interface:NeoParameterizedset model parameter- Specified by:
setParametersin interfaceNeoParameterized- Parameters:
parameters- the array holding the parametersstartIndex- the index into the array that the related parameters start at
-
getParameters
public void getParameters(double[] store, int startIndex) Description copied from interface:NeoParameterizedget model parameter- Specified by:
getParametersin interfaceNeoParameterizedstartIndex- the index into the array that the related parameters start at
-
getLowerLimit
public double getLowerLimit(int n) Description copied from interface:NeoParameterizedget lower parameter limit- Specified by:
getLowerLimitin interfaceNeoParameterized- Parameters:
n- parameter number- Returns:
- lower bound
-
getUpperLimit
public double getUpperLimit(int n) Description copied from interface:NeoParameterizedget upper parameter limit- Specified by:
getUpperLimitin interfaceNeoParameterized- Parameters:
n- parameter number- Returns:
- upper bound
-
getDefaultValues
public void getDefaultValues(double[] store, int startIndex) Description copied from interface:NeoParameterizedget default value parameter values- Specified by:
getDefaultValuesin interfaceNeoParameterized
-