Package org.biojava.nbio.phylo
Enum TreeConstructorType
- java.lang.Object
-
- java.lang.Enum<TreeConstructorType>
-
- org.biojava.nbio.phylo.TreeConstructorType
-
- All Implemented Interfaces:
Serializable
,Comparable<TreeConstructorType>
public enum TreeConstructorType extends Enum<TreeConstructorType>
The TreeConstructorType specifies the aligorithm used to construct the tree (clustering algorithm). Only support for the NJ algorithm (from forester) is currently implemented.- Since:
- 4.1.1
- Author:
- Aleix Lafita
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TreeConstructorType
valueOf(String name)
Returns the enum constant of this type with the specified name.static TreeConstructorType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NJ
public static final TreeConstructorType NJ
Neighbor Joining Algorithm
-
UPGMA
public static final TreeConstructorType UPGMA
Unweighted Pair-Group Method with Arithmetic mean
-
AV
public static final TreeConstructorType AV
What does this stand for? (Aleix: Nov 2015)
-
-
Method Detail
-
values
public static TreeConstructorType[] 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 (TreeConstructorType c : TreeConstructorType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TreeConstructorType valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-