org.mymedialite.eval
Enum CandidateItems

java.lang.Object
  extended by java.lang.Enum<CandidateItems>
      extended by org.mymedialite.eval.CandidateItems
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CandidateItems>

public enum CandidateItems
extends java.lang.Enum<CandidateItems>

Different modes for choosing candidate items in item recommender evaluation.


Enum Constant Summary
EXPLICIT
          Use items provided in a list given by the user.
OVERLAP
          Use all items that are both in the training and the test set.
TEST
          Use all items in the test set.
TRAINING
          Use all items in the training set.
UNION
          Use all items that are both in the training and the test set.
 
Method Summary
static CandidateItems valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CandidateItems[] 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

TRAINING

public static final CandidateItems TRAINING
Use all items in the training set.


TEST

public static final CandidateItems TEST
Use all items in the test set.


OVERLAP

public static final CandidateItems OVERLAP
Use all items that are both in the training and the test set.


UNION

public static final CandidateItems UNION
Use all items that are both in the training and the test set.


EXPLICIT

public static final CandidateItems EXPLICIT
Use items provided in a list given by the user.

Method Detail

values

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

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

valueOf

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