uk.ac.gla.dcs.renaissance.iqir
Enum RankChooser

java.lang.Object
  extended by java.lang.Enum<RankChooser>
      extended by uk.ac.gla.dcs.renaissance.iqir.RankChooser
All Implemented Interfaces:
Serializable, Comparable<RankChooser>

public enum RankChooser
extends Enum<RankChooser>

Choice of a trimming function

Author:
B. Piwowarski

Nested Class Summary
static class RankChooser.Abstract
           
static class RankChooser.First
           
static class RankChooser.Max
           
static class RankChooser.Mean
           
static class RankChooser.None
           
static class RankChooser.Ratio
          Remove the eigenvalues whose absolute value is below the highest eigenvalue multiplied by a given ratio
 
Enum Constant Summary
FIRST
           
MAX
           
MEAN
           
NONE
           
RATIO
           
 
Method Summary
static RankChooser valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RankChooser[] 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

NONE

public static final RankChooser NONE

MAX

public static final RankChooser MAX

FIRST

public static final RankChooser FIRST

RATIO

public static final RankChooser RATIO

MEAN

public static final RankChooser MEAN
Method Detail

values

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

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

valueOf

public static RankChooser 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


Copyright © 2011. All Rights Reserved.