pal.misc
Interface Parameterized

All Known Subinterfaces:
NamedParameterized, RateMatrix, SubstitutionModel
All Known Implementing Classes:
ConstantMutationRate, MutationRateModel, ParameterizedDouble, SteppedMutationRate, WindowedMutationRate, RateDistribution, ParameterizedTree, DemographicModel, ConstantPopulation, ExponentialGrowth, ConstExpGrowth, ExpandingPopulation

public interface Parameterized

interface for class with (optimizable) parameters


Method Summary
 double getDefaultValue(int n)
          get default value of parameter
 double getLowerLimit(int n)
          get lower parameter limit
 int getNumParameters()
          get number of parameters
 double getParameter(int n)
          get model parameter
 double getUpperLimit(int n)
          get upper parameter limit
 void setParameter(double param, int n)
          set model parameter
 void setParameterSE(double paramSE, int n)
          set standard errors for model parameter
 

Method Detail

getNumParameters

public int getNumParameters()
get number of parameters
Returns:
number of parameters

setParameter

public void setParameter(double param,
                         int n)
set model parameter
Parameters:
param - parameter value
n - parameter number

getParameter

public double getParameter(int n)
get model parameter
Parameters:
n - parameter number
Returns:
parameter value

setParameterSE

public void setParameterSE(double paramSE,
                           int n)
set standard errors for model parameter
Parameters:
paramSE - standard error of parameter value
n - parameter number

getLowerLimit

public double getLowerLimit(int n)
get lower parameter limit
Parameters:
n - parameter number
Returns:
lower bound

getUpperLimit

public double getUpperLimit(int n)
get upper parameter limit
Parameters:
n - parameter number
Returns:
upper bound

getDefaultValue

public double getDefaultValue(int n)
get default value of parameter
Parameters:
n - parameter number
Returns:
default value