moa.streams.generators

Class SEAGenerator

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.streams.generators.SEAGenerator

All Implemented Interfaces:

Serializable, MOAObject, OptionHandler, InstanceStream

public class SEAGenerator
extends AbstractOptionHandler
implements InstanceStream

Stream generator for SEA concepts functions. Generator described in the paper:
W. Nick Street and YongSeog Kim "A streaming ensemble algorithm (SEA) for large-scale classification", KDD '01: Proceedings of the seventh ACM SIGKDD international conference on Knowledge discovery and data mining 377-382 2001.

Notes:
The built in functions are based on the paper.

Version:

$Revision: 7 $

Author:

Albert Bifet (abifet at cs dot waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	SEAGenerator.ClassFunction

Field Summary

Fields

Modifier and Type	Field and Description
FlagOption	balanceClassesOption
protected static SEAGenerator.ClassFunction[]	classificationFunctions
IntOption	functionOption
protected Random	instanceRandom
IntOption	instanceRandomSeedOption
protected boolean	nextClassShouldBeZero
IntOption	noisePercentageOption
IntOption	numInstancesConcept
protected InstancesHeader	streamHeader

Fields inherited from class moa.options.AbstractOptionHandler

classOptionNamesToPreparedObjects, options

Constructor Summary

Constructors

Constructor and Description
SEAGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
long	estimatedRemainingInstances() Gets the estimated number of remaining instances in this stream
void	getDescription(StringBuilder sb, int indent) Returns a string representation of this object.
InstancesHeader	getHeader() Gets the header of this stream.
String	getPurposeString() Gets the purpose of this object
boolean	hasMoreInstances() Gets whether this stream has more instances to output.
boolean	isRestartable() Gets whether this stream can restart.
weka.core.Instance	nextInstance() Gets the next instance from this stream.
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.options.AbstractOptionHandler

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

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.MOAObject

copy, measureByteSize

Field Detail

functionOption

public IntOption functionOption

instanceRandomSeedOption

public IntOption instanceRandomSeedOption

balanceClassesOption

public FlagOption balanceClassesOption

numInstancesConcept

public IntOption numInstancesConcept

noisePercentageOption

public IntOption noisePercentageOption

classificationFunctions

protected static SEAGenerator.ClassFunction[] classificationFunctions

streamHeader

protected InstancesHeader streamHeader

instanceRandom

protected Random instanceRandom

nextClassShouldBeZero

protected boolean nextClassShouldBeZero

Constructor Detail

SEAGenerator

public SEAGenerator()

Method Detail

getPurposeString

public String getPurposeString()

Description copied from interface: OptionHandler

Gets the purpose of this object

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: InstanceStream

Gets the estimated number of remaining instances in this stream

Specified by:

estimatedRemainingInstances in interface InstanceStream

Returns:

the estimated number of instances to get from this stream

getHeader

public InstancesHeader getHeader()

Description copied from interface: InstanceStream

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 InstanceStream

Returns:

the header of this stream

hasMoreInstances

public boolean hasMoreInstances()

Description copied from interface: InstanceStream

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

Specified by:

hasMoreInstances in interface InstanceStream

Returns:

true if this stream has more instances to output

isRestartable

public boolean isRestartable()

Description copied from interface: InstanceStream

Gets whether this stream can restart.

Specified by:

isRestartable in interface InstanceStream

Returns:

true if this stream can restart

nextInstance

public weka.core.Instance nextInstance()

Description copied from interface: InstanceStream

Gets the next instance from this stream.

Specified by:

nextInstance in interface InstanceStream

Returns:

the next instance of this stream

restart

public void restart()

Description copied from interface: InstanceStream

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

Specified by:

restart in interface InstanceStream

getDescription

public void getDescription(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