moa.streams

Class CachedInstancesStream

java.lang.Object

moa.AbstractMOAObject

moa.streams.CachedInstancesStream

All Implemented Interfaces:

Serializable, MOAObject, InstanceStream

public class CachedInstancesStream
extends AbstractMOAObject
implements InstanceStream

Stream generator for representing a stream that is cached in memory. This generator is used with the task CacheShuffledStream that stores and shuffles examples in memory.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	streamPos
protected weka.core.Instances	toStream

Constructor Summary

Constructors

Constructor and Description
CachedInstancesStream(weka.core.Instances toStream)

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.
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.
void	restart() Restarts this stream.

Methods inherited from class moa.AbstractMOAObject

copy, 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

toStream

protected weka.core.Instances toStream

streamPos

protected int streamPos

Constructor Detail

CachedInstancesStream

public CachedInstancesStream(weka.core.Instances toStream)

Method Detail

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

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

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

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

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

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