Package pal.substmodel
Class F84
java.lang.Object
pal.substmodel.AbstractRateMatrix
pal.substmodel.NucleotideModel
pal.substmodel.F84
- All Implemented Interfaces:
Serializable,Cloneable,ExternalParameterListener,NamedParameterized,Parameterized,Report,RateMatrix,XMLConstants
Felsenstein 1984 (PHYLIP) model of nucleotide evolution
- Version:
- $Id: F84.java,v 1.12 2003/11/30 05:29:22 matt Exp $
Parameters
- ExpectedTsTv
- Author:
- Korbinian Strimmer, Alexei Drummond
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface pal.misc.Parameterized
Parameterized.Null, Parameterized.ParameterizedBase, Parameterized.ParameterizedUser, Parameterized.Utils -
Field Summary
FieldsFields inherited from class pal.substmodel.AbstractRateMatrix
formatFields inherited from interface pal.util.XMLConstants
A_TO_C, A_TO_G, A_TO_T, ALIGNMENT, ALPHA, ANCESTRAL_MU_RATE, ANCESTRAL_POP_SIZE, ATTRIBUTE, BACKWARDS, BLOSUM62, C_TO_G, C_TO_T, COALESCENT, CONST_EXP_CONST, CONST_EXP_GROWTH, CONSTANT_MUTATION_RATE, CONSTANT_POPULATION, CPREV, CURRENT_POP_SIZE_DURATION, DATA_TYPE, DATA_TYPE_ID, DAYHOFF, DAYS, DEMOGRAPHIC_MODEL, DIRECTION, EDGE, EXPANDING_POPULATION, EXPONENTIAL_GROWTH, F81, F84, FREQUENCIES, G_TO_T, GAMMA_ALPHA, GAMMA_DISTRIBUTION, GENERATIONS, GROWTH_PHASE_DURATION, GROWTH_RATE, GTR, HEIGHT, HKY, ID, JC, JTT, KAPPA, LENGTH, MISSING, MODEL, MONTHS, MTREV24, MU_STEP_TIME, MUTATION_RATE, MUTATION_RATE_MODEL, MUTATIONS, NAME, NODE, NUMBER_CATEGORIES, OMEGA, ORIGIN, PARAMETER, POPULATION_SIZE, PYRIMIDINE_PURINE_RATIO, RATE_DISTRIBUTION, RATE_MATRIX, SEQUENCE, SPACES_PER_LEVEL, STEPPED_MUTATION_RATE, TIME, TIME_DATA, TN, TREE, TS_TV_RATIO, TWO_STATE, TYPE, UNIFORM, UNIFORM_RATE_DISTRIBUTION, UNITS, UNKNOWN, VALUE, VT, WAG, YANG_CODON_MODEL, YEARS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondoublegetDefaultValue(int n) get default value of parameterdoublegetLowerLimit(int n) get lower parameter limitintget numerical code describing the model typeintget number of parametersgetParameterName(int i) doublegetUpperLimit(int n) get upper parameter limitprotected voidrebuildRateMatrix(double[][] rate, double[] parameters) voidreport(PrintWriter out) print human readable report (e.g., on parameters and associated model)voidsetParameterSE(double paramSE, int n) set standard errors for model parametertoString()Methods inherited from class pal.substmodel.NucleotideModel
getInstance, printFrequencies, printRatiosMethods inherited from class pal.substmodel.AbstractRateMatrix
addPalObjectListener, clone, fireParametersChangedEvent, fireParametersChangedEvent, getDataType, getDimension, getEquilibriumFrequencies, getEquilibriumFrequency, getFrequencies, getOrthogonalHints, getParameter, getRelativeRates, getTransitionProbabilities, getTransitionProbability, getTypeID, parameterChanged, rebuild, removePalObjectListener, scale, setDataType, setDistance, setDistanceTranspose, setFrequencies, setParameter, setParameters, setParametersNoScale, updateMatrixExpMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface pal.misc.Parameterized
getParameter, setParameterMethods inherited from interface pal.substmodel.RateMatrix
addPalObjectListener, clone, getDataType, getDimension, getEquilibriumFrequencies, getEquilibriumFrequency, getOrthogonalHints, getRelativeRates, getTransitionProbabilities, getTransitionProbability, getTypeID, removePalObjectListener, scale, setDistance, setDistanceTranspose, setParametersNoScale
-
Field Details
-
EXPECTED_TS_TV_PARAMETER_INDEX
public static final int EXPECTED_TS_TV_PARAMETER_INDEX- See Also:
-
-
Constructor Details
-
F84
public F84(double expectedTsTv, double[] freq) constructor 1- Parameters:
expectedTsTv- expected transition-transversion ratiofreq- nucleotide frequencies
-
F84
public F84(double[] params, double[] freq) Constructor 2- Parameters:
params- parameter listfreq- nucleotide frequencies
-
-
Method Details
-
getModelID
public int getModelID()Description copied from class:AbstractRateMatrixget numerical code describing the model type- Specified by:
getModelIDin interfaceRateMatrix- Specified by:
getModelIDin classAbstractRateMatrix- Returns:
- integer code identifying a substitution model
-
report
Description copied from interface:Reportprint human readable report (e.g., on parameters and associated model) -
getNumParameters
public int getNumParameters()Description copied from interface:Parameterizedget number of parameters- Specified by:
getNumParametersin interfaceParameterized- Returns:
- number of parameters
-
setParameterSE
public void setParameterSE(double paramSE, int n) Description copied from interface:Parameterizedset standard errors for model parameter- Specified by:
setParameterSEin interfaceParameterized- Parameters:
paramSE- standard error of parameter valuen- parameter number
-
getLowerLimit
public double getLowerLimit(int n) Description copied from interface:Parameterizedget lower parameter limit- Specified by:
getLowerLimitin interfaceParameterized- Parameters:
n- parameter number- Returns:
- lower bound
-
getUpperLimit
public double getUpperLimit(int n) Description copied from interface:Parameterizedget upper parameter limit- Specified by:
getUpperLimitin interfaceParameterized- Parameters:
n- parameter number- Returns:
- upper bound
-
getDefaultValue
public double getDefaultValue(int n) Description copied from interface:Parameterizedget default value of parameter- Specified by:
getDefaultValuein interfaceParameterized- Parameters:
n- parameter number- Returns:
- default value
-
getUniqueName
- Specified by:
getUniqueNamein interfaceRateMatrix- Returns:
- the name of this rate matrix
-
getParameterName
- Specified by:
getParameterNamein interfaceNamedParameterized- Returns:
- a short identifier for this parameter type. Should be the same for all instances of a given class!
-
rebuildRateMatrix
protected void rebuildRateMatrix(double[][] rate, double[] parameters) - Specified by:
rebuildRateMatrixin classAbstractRateMatrix
-
toString
-