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

java.lang.Object
  de.lmu.ifi.dbs.elki.datasource.filter.ShuffleObjectsFilter

All Implemented Interfaces:

ObjectFilter

public class ShuffleObjectsFilter
extends Object
implements ObjectFilter

A filter to shuffle the dataset.

Nested Class Summary

static class

ShuffleObjectsFilter.Parameterizer Parameterization class.

Field Summary

private static Logging	logger Class logger
(package private) Long	seed Seed for randomly shuffling the rows of the database.
static OptionID	SEED_ID Optional parameter to specify a seed for randomly shuffling the rows of the database.

Constructor Summary

ShuffleObjectsFilter(Long seed)
Constructor.

Method Summary

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

logger

private static final Logging logger

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 unused, no shuffling will be performed. Shuffling takes time linearly dependent from the size of the database.

Key: -dbc.seed

seed

final Long seed

Seed for randomly shuffling the rows of the database. If null, no shuffling will be performed. Shuffling takes time linearly dependent from the size of the database.

Constructor Detail

ShuffleObjectsFilter

public ShuffleObjectsFilter(Long seed)

Constructor.

Parameters:

seed - Seed value, may be null for a random seed.

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