de.lmu.ifi.dbs.elki.datasource.filter

Class ShuffleObjectsFilter

java.lang.Object

de.lmu.ifi.dbs.elki.datasource.filter.ShuffleObjectsFilter

All Implemented Interfaces:

ObjectFilter, InspectionUtilFrequentlyScanned

public class ShuffleObjectsFilter
extends Object
implements ObjectFilter

A filter to shuffle the dataset.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShuffleObjectsFilter.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG Class logger
(package private) RandomFactory	rnd Random generator.
static OptionID	SEED_ID Optional parameter to specify a seed for randomly shuffling the rows of the database.

Constructor Summary

Constructors

Constructor and Description
ShuffleObjectsFilter(RandomFactory rnd) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MultipleObjectsBundle	filter(MultipleObjectsBundle objects) Filter a set of object packages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final Logging LOG

Class logger

SEED_ID

public static final OptionID SEED_ID

Optional parameter to specify a seed for randomly shuffling the rows of the database. If not set, a random seed will be used. Shuffling takes time linearly dependent from the size of the database.

Key: -shuffle.seed

rnd

final RandomFactory rnd

Random generator.

Constructor Detail

ShuffleObjectsFilter

public ShuffleObjectsFilter(RandomFactory rnd)

Constructor.

Parameters:

rnd - Random generator

Method Detail

filter

public MultipleObjectsBundle filter(MultipleObjectsBundle objects)

Description copied from interface: ObjectFilter

Filter a set of object packages.

Specified by:

filter in interface ObjectFilter

Parameters:

objects - Object to filter

Returns:

Filtered objects