Package pal.mep

Class ConstantMutationRate

    • Constructor Detail

      • ConstantMutationRate

        public ConstantMutationRate​(int units,
                                    double maximumMutationRate)
        Construct demographic model with default settings
        Parameters:
        maximumMutationRate - The maximum Mutation rate should be selected wisely - too small and it might not include the "true" rate, too high and the optimisers may have trouble optimising
      • ConstantMutationRate

        public ConstantMutationRate​(double rate,
                                    int units,
                                    double maximumMutationRate)
        Construct mutation rate model of a give rate in given units
        Parameters:
        maximumMutationRate - The maximum Mutation rate should be selected wisely - too small and it might not include the "true" rate, too high and the optimisers may have trouble optimising
      • ConstantMutationRate

        public ConstantMutationRate​(double rate,
                                    int units,
                                    double minimumMu,
                                    double maximumMu)
        Construct mutation rate model of a give rate in given units, with a given range of possible values
    • Method Detail

      • getMu

        public double getMu()
        returns initial population size.
      • setMu

        public void setMu​(double m)
      • getEndTime

        public final double getEndTime​(double expectedSubs,
                                       double startTime)
        Description copied from class: MutationRateModel
        Return the end time at which expected substitutions has occurred, given we start at start time
        Specified by:
        getEndTime in class MutationRateModel
      • scale

        public final void scale​(double scale)
        Linearly scales this mutation rate model.
        Specified by:
        scale in class MutationRateModel
        Parameters:
        scale - getExpectedSubstitutions should return scale instead of 1.0 at time t.
      • getNumParameters

        public int getNumParameters()
        Description copied from interface: Parameterized
        get number of parameters
        Specified by:
        getNumParameters in interface Parameterized
        Returns:
        number of parameters
      • getParameter

        public double getParameter​(int k)
        Description copied from interface: Parameterized
        get model parameter
        Specified by:
        getParameter in interface Parameterized
        Parameters:
        k - parameter number
        Returns:
        parameter value
      • getUpperLimit

        public double getUpperLimit​(int k)
        Description copied from interface: Parameterized
        get upper parameter limit
        Specified by:
        getUpperLimit in interface Parameterized
        Parameters:
        k - parameter number
        Returns:
        upper bound
      • getLowerLimit

        public double getLowerLimit​(int k)
        Description copied from interface: Parameterized
        get lower parameter limit
        Specified by:
        getLowerLimit in interface Parameterized
        Parameters:
        k - parameter number
        Returns:
        lower bound
      • getDefaultValue

        public double getDefaultValue​(int k)
        Description copied from interface: Parameterized
        get default value of parameter
        Specified by:
        getDefaultValue in interface Parameterized
        Parameters:
        k - parameter number
        Returns:
        default value
      • setParameter

        public void setParameter​(double value,
                                 int k)
        Description copied from interface: Parameterized
        set model parameter
        Specified by:
        setParameter in interface Parameterized
        Parameters:
        value - parameter value
        k - parameter number
      • setParameterSE

        public void setParameterSE​(double value,
                                   int k)
        Description copied from interface: Parameterized
        set standard errors for model parameter
        Specified by:
        setParameterSE in interface Parameterized
        Parameters:
        value - standard error of parameter value
        k - parameter number
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • report

        public void report​(java.io.PrintWriter out)
        Description copied from interface: Report
        print human readable report (e.g., on parameters and associated model)
        Specified by:
        report in interface Report
        Parameters:
        out - output stream
      • getFixedFactory

        public static final MutationRateModel.Factory getFixedFactory​(double rate,
                                                                      int units)
        Generate a MutationRateModel.Factory class for a ConstantMutationRate
      • getFreeFactory

        public static final MutationRateModel.Factory getFreeFactory​(int units,
                                                                     double maximumMutationRate)
        Generate a MutationRateModel.Factory class for a ConstantMutationRate
      • getFreeFactory

        public static final MutationRateModel.Factory getFreeFactory​(double initialRate,
                                                                     int units,
                                                                     double maximumMutationRate)
        Generate a MutationRateModel.Factory class for a ConstantMutationRate
      • getFreeFactory

        public static final MutationRateModel.Factory getFreeFactory​(double initialRate,
                                                                     int units,
                                                                     double minimumRate,
                                                                     double maximumRate)
        Generate a MutationRateModel.Factory class for a ConstantMutationRate
      • createFixed

        public static final ConstantMutationRate createFixed​(double rate,
                                                             int units)
        Returns:
        A ConstantMutationRate with a fixed rate (no parameters)