All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.RandomizeFilter 

java.lang.Object
   |
   +----weka.filters.Filter
           |
           +----weka.filters.RandomizeFilter
public class RandomizeFilter
extends Filter
implements OptionHandler
This filter randomly shuffles the order of instances passed through it. The random number generator is reset with the seed value whenever inputFormat() is called.

Valid filter-specific options are:

-S num
Specify the random number seed (default 42).

Version:
$Revision: 1.2 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Constructor Index

o RandomizeFilter()

Method Index

o batchFinished()
Signify that this batch of input to the filter is finished.
o getOptions()
Gets the current settings of the filter.
o getRandomSeed()
Get the random number generator seed value.
o inputFormat(Instances)
Sets the format of the input instances.
o listOptions()
Returns an enumeration describing the available options
o main(String[])
Main method for testing this class.
o setOptions(String[])
Parses a list of options for this object.
o setRandomSeed(int)
Set the random number generator seed value.

Constructors

o RandomizeFilter 
 public RandomizeFilter()

Methods

o listOptions 
 public Enumeration listOptions()
Returns an enumeration describing the available options

Returns:
an enumeration of all the available options
o setOptions 
 public void setOptions(String options[]) throws Exception
Parses a list of options for this object. Valid options are:

-S num
Specify the random number seed (default 42).

Parameters:
options - the list of options as an array of strings
Throws: Exception
if an option is not supported
o getOptions 
 public String[] getOptions()
Gets the current settings of the filter.

Returns:
an array of strings suitable for passing to setOptions
o getRandomSeed 
 public int getRandomSeed()
Get the random number generator seed value.

Returns:
random number generator seed value.
o setRandomSeed 
 public void setRandomSeed(int newRandomSeed)
Set the random number generator seed value.

Parameters:
newRandomSeed - value to use as the random number generator seed.
o inputFormat 
 public boolean inputFormat(Instances instanceInfo)
Sets the format of the input instances.

Parameters:
instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).
Returns:
true if the outputFormat may be collected immediately
Overrides:
inputFormat in class Filter
o batchFinished 
 public boolean batchFinished() throws Exception
Signify that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances. Any subsequent instances filtered should be filtered based on setting obtained from the first batch (unless the inputFormat has been re-assigned or new options have been set). This implementation randomizes all the instances received in the batch.

Returns:
true if there are instances pending output
Throws: Exception
if no input structure has been defined
Overrides:
batchFinished in class Filter
o main 
 public static void main(String argv[])
Main method for testing this class.

Parameters:
argv - should contain arguments to the filter: use -h for help 
All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home