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

Class weka.experiment.AveragingResultProducer

java.lang.Object
   |
   +----weka.experiment.AveragingResultProducer

public class AveragingResultProducer

extends Object

implements ResultListener, ResultProducer, OptionHandler, AdditionalMeasureProducer

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

AveragingResultProducer()

acceptResult(ResultProducer, Object[], Object[])

Accepts results from a ResultProducer.

calculateStdDevsTipText()

Returns the tip text for this property

determineColumnConstraints(ResultProducer)

Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers.

doRun(int)

Gets the results for a specified run number.

doRunKeys(int)

Gets the keys for a specified run number.

enumerateMeasures()

Returns an enumeration of any additional measure names that might be in the result producer

expectedResultsPerAverageTipText()

Returns the tip text for this property

getCalculateStdDevs()

Get the value of CalculateStdDevs.

getCompatibilityState()

Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface).

getExpectedResultsPerAverage()

Get the value of ExpectedResultsPerAverage.

getKeyFieldName()

Get the value of KeyFieldName.

getKeyNames()

Gets the names of each of the columns produced for a single run.

getKeyTypes()

Gets the data types of each of the columns produced for a single run.

getMeasure(String)

Returns the value of the named measure

getOptions()

Gets the current settings of the result producer.

getResultNames()

Gets the names of each of the columns produced for a single run.

getResultProducer()

Get the ResultProducer.

getResultTypes()

Gets the data types of each of the columns produced for a single run.

globalInfo()

Returns a string describing this result producer

isResultRequired(ResultProducer, Object[])

Determines whether the results for a specified key must be generated.

keyFieldNameTipText()

Returns the tip text for this property

listOptions()

Returns an enumeration describing the available options.

postProcess()

When this method is called, it indicates that no more requests to generate results for the current experiment will be sent.

postProcess(ResultProducer)

When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.

preProcess()

Prepare to generate results.

preProcess(ResultProducer)

Prepare for the results to be received.

resultProducerTipText()

Returns the tip text for this property

setAdditionalMeasures(String[])

Set a list of method names for additional measures to look for in SplitEvaluators.

setCalculateStdDevs(boolean)

Set the value of CalculateStdDevs.

setExpectedResultsPerAverage(int)

Set the value of ExpectedResultsPerAverage.

setInstances(Instances)

Sets the dataset that results will be obtained for.

setKeyFieldName(String)

Set the value of KeyFieldName.

setOptions(String[])

Parses a given list of options.

setResultListener(ResultListener)

Sets the object to send results of each run to.

setResultProducer(ResultProducer)

Set the ResultProducer.

toString()

Gets a text descrption of the result producer.

 public AveragingResultProducer()

 public String globalInfo()

Returns a string describing this result producer

Returns:

a description of the result producer suitable for displaying in the explorer/experimenter gui

 public String[] determineColumnConstraints(ResultProducer rp) throws Exception

Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers. Null should be returned if there are NO constraints, otherwise a list of column names should be returned as an array of Strings.

Parameters:

rp - the ResultProducer to which the constraints will apply

Returns:

an array of column names to which resutltProducer's results will be restricted.

Throws: Exception

if constraints can't be determined

 public void doRunKeys(int run) throws Exception

Gets the keys for a specified run number. Different run numbers correspond to different randomizations of the data. Keys produced should be sent to the current ResultListener

Parameters:

run - the run number to get keys for.

Throws: Exception

if a problem occurs while getting the keys

 public void doRun(int run) throws Exception

Gets the results for a specified run number. Different run numbers correspond to different randomizations of the data. Results produced should be sent to the current ResultListener

Parameters:

run - the run number to get results for.

Throws: Exception

if a problem occurs while getting the results

 public void preProcess(ResultProducer rp) throws Exception

Prepare for the results to be received.

Parameters:

rp - the ResultProducer that will generate the results

Throws: Exception

if an error occurs during preprocessing.

 public void preProcess() throws Exception

Prepare to generate results. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.

Throws: Exception

if an error occurs during preprocessing.

 public void postProcess(ResultProducer rp) throws Exception

When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.

Parameters:

rp - the ResultProducer that generated the results

Throws: Exception

if an error occurs

 public void postProcess() throws Exception

When this method is called, it indicates that no more requests to generate results for the current experiment will be sent. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.

Throws: Exception

if an error occurs

 public void acceptResult(ResultProducer rp,
                          Object key[],
                          Object result[]) throws Exception

Accepts results from a ResultProducer.

Parameters:

rp - the ResultProducer that generated the results

key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState

result - the results stored in an array. The objects stored in the array may be Strings, Doubles, or null (for the missing value).

Throws: Exception

if the result could not be accepted.

 public boolean isResultRequired(ResultProducer rp,
                                 Object key[]) throws Exception

Determines whether the results for a specified key must be generated.

Parameters:

rp - the ResultProducer wanting to generate the results

key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState

Returns:

true if the result should be generated

Throws: Exception

if it could not be determined if the result is needed.

 public String[] getKeyNames() throws Exception

Gets the names of each of the columns produced for a single run.

Returns:

an array containing the name of each column

Throws: Exception

if key names cannot be generated

 public Object[] getKeyTypes() throws Exception

Gets the data types of each of the columns produced for a single run. This method should really be static.

Returns:

an array containing objects of the type of each column. The objects should be Strings, or Doubles.

Throws: Exception

if the key types could not be determined (perhaps because of a problem from a nested sub-resultproducer)

 public String[] getResultNames() throws Exception

Gets the names of each of the columns produced for a single run. A new result field is added for the number of results used to produce each average. If only averages are being produced the names are not altered, if standard deviations are produced then "Dev_" and "Avg_" are prepended to each result deviation and average field respectively.

Returns:

an array containing the name of each column

Throws: Exception

if the result names could not be determined (perhaps because of a problem from a nested sub-resultproducer)

 public Object[] getResultTypes() throws Exception

Gets the data types of each of the columns produced for a single run.

Returns:

an array containing objects of the type of each column. The objects should be Strings, or Doubles.

Throws: Exception

if the result types could not be determined (perhaps because of a problem from a nested sub-resultproducer)

 public String getCompatibilityState()

Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface). For example, a cross-validation ResultProducer may have a setting for the number of folds. For a given state, the results produced should be compatible. Typically if a ResultProducer is an OptionHandler, this string will represent the command line arguments required to set the ResultProducer to that state.

Returns:

the description of the ResultProducer state, or null if no state is defined

 public Enumeration listOptions()

Returns an enumeration describing the available options.

Returns:

an enumeration of all the available options

 public void setOptions(String options[]) throws Exception

Parses a given list of options. Valid options are:

-F name
The field name that will be unique for a run (default "Fold")

-X num_results
The expected number of results per run. (default 10)

-S
Calculate standard deviations. (default only averages)

-W classname
Specify the full class name of the result producer.

All option after -- will be passed to the result producer.

Parameters:

options - the list of options as an array of strings

Throws: Exception

if an option is not supported

 public String[] getOptions()

Gets the current settings of the result producer.

Returns:

an array of strings suitable for passing to setOptions

 public void setAdditionalMeasures(String additionalMeasures[])

Set a list of method names for additional measures to look for in SplitEvaluators. This could contain many measures (of which only a subset may be produceable by the current resultProducer) if an experiment is the type that iterates over a set of properties.

Parameters:

additionalMeasures - an array of measure names, null if none

 public Enumeration enumerateMeasures()

Returns an enumeration of any additional measure names that might be in the result producer

Returns:

an enumeration of the measure names

 public double getMeasure(String additionalMeasureName)

Returns the value of the named measure

Parameters:

measureName - the name of the measure to query for its value

Returns:

the value of the named measure

Throws: IllegalArgumentException

if the named measure is not supported

 public void setInstances(Instances instances)

Sets the dataset that results will be obtained for.

Parameters:

instances - a value of type 'Instances'.

 public String calculateStdDevsTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

 public boolean getCalculateStdDevs()

Get the value of CalculateStdDevs.

Returns:

Value of CalculateStdDevs.

 public void setCalculateStdDevs(boolean newCalculateStdDevs)

Set the value of CalculateStdDevs.

Parameters:

newCalculateStdDevs - Value to assign to CalculateStdDevs.

 public String expectedResultsPerAverageTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

 public int getExpectedResultsPerAverage()

Get the value of ExpectedResultsPerAverage.

Returns:

Value of ExpectedResultsPerAverage.

 public void setExpectedResultsPerAverage(int newExpectedResultsPerAverage)

Set the value of ExpectedResultsPerAverage.

Parameters:

newExpectedResultsPerAverage - Value to assign to ExpectedResultsPerAverage.

 public String keyFieldNameTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

 public String getKeyFieldName()

Get the value of KeyFieldName.

Returns:

Value of KeyFieldName.

 public void setKeyFieldName(String newKeyFieldName)

Set the value of KeyFieldName.

Parameters:

newKeyFieldName - Value to assign to KeyFieldName.

 public void setResultListener(ResultListener listener)

Sets the object to send results of each run to.

Parameters:

listener - a value of type 'ResultListener'

 public String resultProducerTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

 public ResultProducer getResultProducer()

Get the ResultProducer.

Returns:

the ResultProducer.

 public void setResultProducer(ResultProducer newResultProducer)

Set the ResultProducer.

Parameters:

newResultProducer - new ResultProducer to use.

 public String toString()

Gets a text descrption of the result producer.

Returns:

a text description of the result producer.

Overrides:

toString in class Object

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