Models

Enum RateCategory.FrequencyType

java.lang.Object

java.lang.Enum<RateCategory.FrequencyType>

Models.RateCategory.FrequencyType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RateCategory.FrequencyType>

Enclosing class:

RateCategory

public static enum RateCategory.FrequencyType
extends java.lang.Enum<RateCategory.FrequencyType>

Enumeration of the different ways of defining the root frequency

Enum Constant Summary

Enum Constants

Enum Constant and Description
FITZJOHN Use the method of FitzJohn et al 2009
MODEL Uses the values defined in the model
QSTAT Use the quasi-stationary distribution of the rate matrix
STATIONARY Use the stationary distribution of the rate matrix

Method Summary

Methods

Modifier and Type	Method and Description
static RateCategory.FrequencyType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RateCategory.FrequencyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODEL

public static final RateCategory.FrequencyType MODEL

Uses the values defined in the model

STATIONARY

public static final RateCategory.FrequencyType STATIONARY

Use the stationary distribution of the rate matrix

QSTAT

public static final RateCategory.FrequencyType QSTAT

Use the quasi-stationary distribution of the rate matrix

FITZJOHN

public static final RateCategory.FrequencyType FITZJOHN

Use the method of FitzJohn et al 2009

Method Detail

values

public static RateCategory.FrequencyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RateCategory.FrequencyType c : RateCategory.FrequencyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RateCategory.FrequencyType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null