Package pal.substmodel
Class GeneralPoissonRateMatrix
java.lang.Object
pal.substmodel.GeneralPoissonRateMatrix
- All Implemented Interfaces:
Serializable
,NeoRateMatrix
A general rate matrix class for JC69/F81 style rate matrices (but for all data types)
- Version:
- $Id: GeneralPoissonRateMatrix.java,v 1.3 2004/08/15 03:00:37 matt Exp $
- Author:
- Matthew Goode
- 11 May 2004 - Created file
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
createRelativeRates
(double[][] rateStore, double[] rateParameters, int startIndex) Create the relative rates arrayvoid
getDefaultRateParameters
(double[] store, int startIndex) int
int
double
getRateParameterLowerBound
(int parameter) double
getRateParameterUpperBound
(int parameter) boolean
Check the compatibility of a data type to be used with the rate matrixboolean
Is the relative rate matrix described by this rate matrix meant to represent a reversible process? If true only the upper part of the rate matrix needs to be filled in (eg in matrix[i][j], for all where j > i );
-
Constructor Details
-
GeneralPoissonRateMatrix
public GeneralPoissonRateMatrix(int dimension)
-
-
Method Details
-
getUniqueName
- Specified by:
getUniqueName
in interfaceNeoRateMatrix
- Returns:
- a short unique human-readable identifier for this rate matrix.
-
isReversible
public boolean isReversible()Description copied from interface:NeoRateMatrix
Is the relative rate matrix described by this rate matrix meant to represent a reversible process? If true only the upper part of the rate matrix needs to be filled in (eg in matrix[i][j], for all where j > i );- Specified by:
isReversible
in interfaceNeoRateMatrix
- Returns:
- true (doesn't really matter)
-
getDimension
public int getDimension()- Specified by:
getDimension
in interfaceNeoRateMatrix
- Returns:
- the dimension of this rate matrix. (as for construction)
-
isDataTypeCompatible
Check the compatibility of a data type to be used with the rate matrix- Specified by:
isDataTypeCompatible
in interfaceNeoRateMatrix
- Parameters:
dt
- the data type to test- Returns:
- true if data type state count is equal to dimension
-
createRelativeRates
public void createRelativeRates(double[][] rateStore, double[] rateParameters, int startIndex) Description copied from interface:NeoRateMatrix
Create the relative rates array- Specified by:
createRelativeRates
in interfaceNeoRateMatrix
- Parameters:
rateStore
- The place where the relative rates are stored (should be assumed to be large enough - based on dimension)rateParameters
- The parameters to be used to construct the rate storestartIndex
- The index into the rateParameters to start reading parameters
-
getNumberOfRateParameters
public int getNumberOfRateParameters()- Specified by:
getNumberOfRateParameters
in interfaceNeoRateMatrix
-
getRateParameterLowerBound
public double getRateParameterLowerBound(int parameter) - Specified by:
getRateParameterLowerBound
in interfaceNeoRateMatrix
-
getRateParameterUpperBound
public double getRateParameterUpperBound(int parameter) - Specified by:
getRateParameterUpperBound
in interfaceNeoRateMatrix
-
getDefaultRateParameters
public void getDefaultRateParameters(double[] store, int startIndex) - Specified by:
getDefaultRateParameters
in interfaceNeoRateMatrix
-