Package moa.streams.generators

Class AgrawalGenerator

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.streams.generators.AgrawalGenerator

All Implemented Interfaces:

Configurable, java.io.Serializable, CapabilitiesHandler, MOAObject, OptionHandler, ExampleStream<Example<Instance>>, InstanceStream

public class AgrawalGenerator
extends AbstractOptionHandler
implements InstanceStream, CapabilitiesHandler

Stream generator for Agrawal dataset. Generator described in paper:
Rakesh Agrawal, Tomasz Imielinksi, and Arun Swami, "Database Mining: A Performance Perspective", IEEE Transactions on Knowledge and Data Engineering, 5(6), December 1993.

Public C source code available at:
http://www.almaden.ibm.com/cs/projects/iis/hdb/Projects/data_mining/datasets/syndata.html

Notes:
The built in functions are based on the paper (page 924), which turn out to be functions pred20 thru pred29 in the public C implementation. Perturbation function works like C implementation rather than description in paper.

Version:

$Revision: 7 $

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AgrawalGenerator.ClassFunction

Field Summary

Fields

Modifier and Type	Field	Description
FlagOption	balanceClassesOption
protected static AgrawalGenerator.ClassFunction[]	classificationFunctions
IntOption	functionOption
protected java.util.Random	instanceRandom
IntOption	instanceRandomSeedOption
protected boolean	nextClassShouldBeZero
FloatOption	peturbFractionOption
protected InstancesHeader	streamHeader

Fields inherited from class moa.options.AbstractOptionHandler

config

Constructor Summary

Constructors

Constructor	Description
AgrawalGenerator()

Method Summary

Modifier and Type	Method	Description
ImmutableCapabilities	defineImmutableCapabilities()	Defines the set of capabilities the object has.
long	estimatedRemainingInstances()	Gets the estimated number of remaining instances in this stream
void	getDescription(java.lang.StringBuilder sb, int indent)	Returns a string representation of this object.
InstancesHeader	getHeader()	Gets the header of this stream.
java.lang.String	getPurposeString()	Dictionary with option texts and objects
boolean	hasMoreInstances()	Gets whether this stream has more instances to output.
boolean	isRestartable()	Gets whether this stream can restart.
InstanceExample	nextInstance()	Gets the next example from this stream.
protected double	perturbValue(double val, double min, double max)
protected double	perturbValue(double val, double range, double min, double max)
protected void	prepareForUseImpl(TaskMonitor monitor, ObjectRepository repository)	This method describes the implementation of how to prepare this object for use.
void	restart()	Restarts this stream.

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class moa.options.AbstractOptionHandler

copy, getCLICreationString, getOptions, getPreparedClassOption, prepareClassOptions, prepareForUse, prepareForUse

Methods inherited from interface moa.capabilities.CapabilitiesHandler

getCapabilities

Methods inherited from interface moa.MOAObject

copy, measureByteSize

Methods inherited from class java.lang.Object

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

Field Detail

functionOption

public IntOption functionOption

instanceRandomSeedOption

public IntOption instanceRandomSeedOption

peturbFractionOption

public FloatOption peturbFractionOption

balanceClassesOption

public FlagOption balanceClassesOption

classificationFunctions

protected static AgrawalGenerator.ClassFunction[] classificationFunctions

streamHeader

protected InstancesHeader streamHeader

instanceRandom

protected java.util.Random instanceRandom

nextClassShouldBeZero

protected boolean nextClassShouldBeZero

Constructor Detail

AgrawalGenerator

public AgrawalGenerator()

Method Detail

getPurposeString

public java.lang.String getPurposeString()

Description copied from class: AbstractOptionHandler

Dictionary with option texts and objects

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractOptionHandler

Returns:

the string with the purpose of this object

prepareForUseImpl

protected void prepareForUseImpl(TaskMonitor monitor,
                                 ObjectRepository repository)

Description copied from class: AbstractOptionHandler

This method describes the implementation of how to prepare this object for use. All classes that extends this class have to implement prepareForUseImpl and not prepareForUse since prepareForUse calls prepareForUseImpl.

Specified by:

prepareForUseImpl in class AbstractOptionHandler

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

estimatedRemainingInstances

public long estimatedRemainingInstances()

Description copied from interface: ExampleStream

Gets the estimated number of remaining instances in this stream

Specified by:

estimatedRemainingInstances in interface ExampleStream<Example<Instance>>

Returns:

the estimated number of instances to get from this stream

getHeader

public InstancesHeader getHeader()

Description copied from interface: ExampleStream

Gets the header of this stream. This is useful to know attributes and classes. InstancesHeader is an extension of weka.Instances.

Specified by:

getHeader in interface ExampleStream<Example<Instance>>

Returns:

the header of this stream

hasMoreInstances

public boolean hasMoreInstances()

Description copied from interface: ExampleStream

Gets whether this stream has more instances to output. This is useful when reading streams from files.

Specified by:

hasMoreInstances in interface ExampleStream<Example<Instance>>

Returns:

true if this stream has more instances to output

isRestartable

public boolean isRestartable()

Description copied from interface: ExampleStream

Gets whether this stream can restart.

Specified by:

isRestartable in interface ExampleStream<Example<Instance>>

Returns:

true if this stream can restart

nextInstance

public InstanceExample nextInstance()

Description copied from interface: ExampleStream

Gets the next example from this stream.

Specified by:

nextInstance in interface ExampleStream<Example<Instance>>

Returns:

the next example of this stream

perturbValue

protected double perturbValue(double val,
                              double min,
                              double max)

perturbValue

protected double perturbValue(double val,
                              double range,
                              double min,
                              double max)

restart

public void restart()

Description copied from interface: ExampleStream

Restarts this stream. It must be similar to starting a new stream from scratch.

Specified by:

restart in interface ExampleStream<Example<Instance>>

getDescription

public void getDescription(java.lang.StringBuilder sb,
                           int indent)

Description copied from interface: MOAObject

Returns a string representation of this object. Used in AbstractMOAObject.toString to give a string representation of the object.

Specified by:

getDescription in interface MOAObject

Parameters:

sb - the stringbuilder to add the description

indent - the number of characters to indent

defineImmutableCapabilities

public ImmutableCapabilities defineImmutableCapabilities()

Description copied from interface: CapabilitiesHandler

Defines the set of capabilities the object has. Should be overridden if the object's capabilities do not change.

Specified by:

defineImmutableCapabilities in interface CapabilitiesHandler

Specified by:

defineImmutableCapabilities in interface ExampleStream<Example<Instance>>

Returns:

The capabilities of the object.