Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## de.jstacs.motifDiscovery
Enum MutableMotifDiscovererToolbox.InitMethodForScoringFunction

    java.lang.Object
      java.lang.Enum<MutableMotifDiscovererToolbox.InitMethodForScoringFunction>
          de.jstacs.motifDiscovery.MutableMotifDiscovererToolbox.InitMethodForScoringFunction

All Implemented Interfaces:
  Serializable, Comparable<MutableMotifDiscovererToolbox.InitMethodForScoringFunction>

Enclosing class:
  MutableMotifDiscovererToolbox

    public static enum MutableMotifDiscovererToolbox.InitMethodForScoringFunction

extends Enum<MutableMotifDiscovererToolbox.InitMethodForScoringFunction>

This enum defines some constants for the method `MutableMotifDiscovererToolbox.getSortedInitialParameters( ScoringFunction[], InitMethodForScoringFunction[], SFBasedOptimizableFunction, int, SafeOutputStream, int)`. These constants define how to initialize the `ScoringFunction`s.

Author:
  Jens Keilwagen

Enum Constant Summary
`MOTIF_RANDOMLY` This constants indicates that the motifs of a `MutableMotifDiscoverer` should be initialized using `MutableMotifDiscoverer.initializeMotifRandomly(int)`.
`NOTHING` This constants indicates that a `ScoringFunction` should not be initialized, i.e. the instance is not changed and uses the current parameters.
`PLUG_IN` This constants indicates that a `ScoringFunction` should be initialized using `ScoringFunction.initializeFunction(int, boolean, Sample[], double[][])`.
`RANDOMLY` This constants indicates that a `ScoringFunction` should be initialized using `ScoringFunction.initializeFunctionRandomly(boolean)`.

Method Summary
`static MutableMotifDiscovererToolbox.InitMethodForScoringFunction` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MutableMotifDiscovererToolbox.InitMethodForScoringFunction[]` | `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

### PLUG_IN

    public static final MutableMotifDiscovererToolbox.InitMethodForScoringFunction PLUG_IN

  This constants indicates that a `ScoringFunction` should be initialized using `ScoringFunction.initializeFunction(int, boolean, Sample[], double[][])`.

### MOTIF_RANDOMLY

    public static final MutableMotifDiscovererToolbox.InitMethodForScoringFunction MOTIF_RANDOMLY

  This constants indicates that the motifs of a `MutableMotifDiscoverer` should be initialized using `MutableMotifDiscoverer.initializeMotifRandomly(int)`.

### RANDOMLY

    public static final MutableMotifDiscovererToolbox.InitMethodForScoringFunction RANDOMLY

  This constants indicates that a `ScoringFunction` should be initialized using `ScoringFunction.initializeFunctionRandomly(boolean)`.

### NOTHING

    public static final MutableMotifDiscovererToolbox.InitMethodForScoringFunction NOTHING

  This constants indicates that a `ScoringFunction` should not be initialized, i.e. the instance is not changed and uses the current parameters.

Method Detail

### values

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

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

### valueOf

    public static MutableMotifDiscovererToolbox.InitMethodForScoringFunction 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD