de.bioforscher.singa.structure.algorithms.superimposition.scores

Enum SubstitutionMatrix

java.lang.Object

java.lang.Enum<SubstitutionMatrix>

de.bioforscher.singa.structure.algorithms.superimposition.scores.SubstitutionMatrix

All Implemented Interfaces:

Serializable, Comparable<SubstitutionMatrix>

public enum SubstitutionMatrix
extends Enum<SubstitutionMatrix>

Author:

fk

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOSUM_45
MC_LACHLAN

Method Summary

Modifier and Type	Method and Description
LabeledSymmetricMatrix<StructuralFamily>	getMatrix()
LabeledSymmetricMatrix<StructuralFamily>	toCostMatrix()
static SubstitutionMatrix	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubstitutionMatrix[]	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

BLOSUM_45

public static final SubstitutionMatrix BLOSUM_45

MC_LACHLAN

public static final SubstitutionMatrix MC_LACHLAN

Method Detail

values

public static SubstitutionMatrix[] 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 (SubstitutionMatrix c : SubstitutionMatrix.values())
    System.out.println(c);

Returns:

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

valueOf

public static SubstitutionMatrix 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 name

NullPointerException - if the argument is null

toCostMatrix

public LabeledSymmetricMatrix<StructuralFamily> toCostMatrix()

getMatrix

public LabeledSymmetricMatrix<StructuralFamily> getMatrix()