|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.filters.Filter
weka.filters.unsupervised.instance.ReservoirSample
public class ReservoirSample
Produces a random subsample of a dataset using the reservoir sampling Algorithm "R" by Vitter. The original data set does not have to fit into main memory, but the reservoir does.
BibTeX:
@article{Vitter1985,
author = {J. S. Vitter},
journal = {ACM Transactions on Mathematical Software},
number = {1}
volume = {11}
pages = {37-57},
title = {Random Sampling with a Reservoir},
year = {1985}
}
Valid options are:
-S <num> Specify the random number seed (default 1)
-Z <num> The size of the output dataset - number of instances (default 100)
| Constructor Summary | |
|---|---|
ReservoirSample()
|
|
| Method Summary | |
|---|---|
boolean |
batchFinished()
Signify that this batch of input to the filter is finished. |
Capabilities |
getCapabilities()
Returns the Capabilities of this filter. |
java.lang.String[] |
getOptions()
Gets the current settings of the filter. |
int |
getRandomSeed()
Gets the random number seed. |
java.lang.String |
getRevision()
Returns the revision string. |
int |
getSampleSize()
Gets the subsample size. |
java.lang.String |
globalInfo()
Returns a string describing this filter |
boolean |
input(Instance instance)
Input an instance for filtering. |
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options. |
static void |
main(java.lang.String[] argv)
Main method for testing this class. |
java.lang.String |
randomSeedTipText()
Returns the tip text for this property |
java.lang.String |
sampleSizeTipText()
Returns the tip text for this property |
boolean |
setInputFormat(Instances instanceInfo)
Sets the format of the input instances. |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
setRandomSeed(int newSeed)
Sets the random number seed. |
void |
setSampleSize(int newSampleSize)
Sets the size of the subsample. |
| Methods inherited from class weka.filters.Filter |
|---|
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ReservoirSample()
| Method Detail |
|---|
public java.lang.String globalInfo()
public java.util.Enumeration listOptions()
listOptions in interface OptionHandler
public void setOptions(java.lang.String[] options)
throws java.lang.Exception
-S <num> Specify the random number seed (default 1)
-Z <num> The size of the output dataset - number of instances (default 100)
setOptions in interface OptionHandleroptions - the list of options as an array of strings
java.lang.Exception - if an option is not supportedpublic java.lang.String[] getOptions()
getOptions in interface OptionHandlerpublic java.lang.String randomSeedTipText()
public int getRandomSeed()
public void setRandomSeed(int newSeed)
newSeed - the new random number seed.public java.lang.String sampleSizeTipText()
public int getSampleSize()
public void setSampleSize(int newSampleSize)
newSampleSize - size of the subsample.public Capabilities getCapabilities()
getCapabilities in interface CapabilitiesHandlergetCapabilities in class FilterCapabilities
public boolean setInputFormat(Instances instanceInfo)
throws java.lang.Exception
setInputFormat in class FilterinstanceInfo - an Instances object containing the input
instance structure (any instances contained in the object are
ignored - only the structure is required).
java.lang.Exception - if the input format can't be set
successfullypublic boolean input(Instance instance)
input in class Filterinstance - the input instance
java.lang.IllegalStateException - if no input structure has been definedpublic boolean batchFinished()
batchFinished in class Filterjava.lang.IllegalStateException - if no input structure has been definedpublic java.lang.String getRevision()
getRevision in interface RevisionHandlergetRevision in class Filterpublic static void main(java.lang.String[] argv)
argv - should contain arguments to the filter:
use -h for help
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||