org.lenskit.eval.crossfold

Enum SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

org.lenskit.eval.crossfold.SortOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortOrder>

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

Sort order for partitioning events per user or item.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RANDOM
TIMESTAMP

Method Summary

Modifier and Type	Method and Description
abstract void	apply(java.util.List<? extends Rating> list, java.util.Random rng) Apply the ordering.
static SortOrder	fromString(java.lang.String str)
static SortOrder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SortOrder[]	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

RANDOM

public static final SortOrder RANDOM

TIMESTAMP

public static final SortOrder TIMESTAMP

Method Detail

values

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

Returns:

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

valueOf

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

apply

public abstract void apply(java.util.List<? extends Rating> list,
                           java.util.Random rng)

Apply the ordering.

Parameters:

list - The list to order.

rng - The random number generator to use, if necessary.

fromString

public static SortOrder fromString(java.lang.String str)