org.grouplens.lenskit.eval.data.subsample

Enum SubsampleMode

java.lang.Object

java.lang.Enum<SubsampleMode>

org.grouplens.lenskit.eval.data.subsample.SubsampleMode

All Implemented Interfaces:

Serializable, Comparable<SubsampleMode>

public enum SubsampleMode
extends Enum<SubsampleMode>

The mode of the subsample file. It can be chosen as Ratings, Items or Users so that the data source file can be subsampled according to Rating, Item or User.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ITEM
RATING
USER

Method Summary

Modifier and Type	Method and Description
abstract void	doSample(DataSource source, RatingWriter output, double fraction, Random rng) Write a random subset of all objects chosen by mode to the output file.
static SubsampleMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubsampleMode[]	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

RATING

public static final SubsampleMode RATING

ITEM

public static final SubsampleMode ITEM

USER

public static final SubsampleMode USER

Method Detail

values

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

Returns:

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

valueOf

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

doSample

public abstract void doSample(DataSource source,
                              RatingWriter output,
                              double fraction,
                              Random rng)
                       throws IOException

Write a random subset of all objects chosen by mode to the output file.

Parameters:

source - The DAO of the data source file

output - The table output to output the rating

fraction - The fraction of data to keep.

Throws:

IOException - if there is an error sampling the data set.