weka.core.setupgenerator
Class MathParameter

java.lang.Object
  weka.core.setupgenerator.AbstractParameter
      weka.core.setupgenerator.MathParameter

All Implemented Interfaces:

Serializable, Cloneable, weka.core.OptionHandler

public class MathParameter
extends AbstractParameter

Container class for search parameters.

Version:

$Revision: 4521 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected double	m_Base the base.
protected String	m_Expression The expression for the property.
protected double	m_Max the maximum.
protected double	m_Min the minimum.
protected double	m_Step the step.

Fields inherited from class weka.core.setupgenerator.AbstractParameter

m_Property

Constructor Summary

MathParameter()

Method Summary

String	baseTipText() Returns the tip text for this property.
String	expressionTipText() Returns the tip text for this property.
double	getBase() Get the value of the base.
String	getExpression() Get the expression.
double	getMax() Get the value of the Maximum.
double	getMin() Get the value of the minimum.
String[]	getOptions() returns the options of the current setup.
double	getStep() Get the value of the step size.
String	globalInfo() Returns a string describing the object.
Enumeration	listOptions() Gets an enumeration describing the available options.
String	maxTipText() Returns the tip text for this property.
String	minTipText() Returns the tip text for this property.
void	setBase(double value) Set the value of the base.
void	setExpression(String value) Set the expression.
void	setMax(double value) Set the value of the Maximum.
void	setMin(double value) Set the value of the minimum.
void	setOptions(String[] options) Parses the options for this object.
void	setStep(double value) Set the value of the step size.
String	stepTipText() Returns the tip text for this property.
String	toString() Returns a string representation of the search parameter.

Methods inherited from class weka.core.setupgenerator.AbstractParameter

clone, getProperty, propertyTipText, setProperty, typeTipText

Methods inherited from class java.lang.Object

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

Field Detail

m_Min

protected double m_Min

the minimum.

m_Max

protected double m_Max

the maximum.

m_Step

protected double m_Step

the step.

m_Base

protected double m_Base

the base.

m_Expression

protected String m_Expression

The expression for the property. Available parameters for the expression:

• BASE
• FROM (= min)
• TO (= max)
• STEP
• I - the current value (from 'from' to 'to' with stepsize 'step')

See Also:

MathematicalExpression, MathExpression

Constructor Detail

MathParameter

public MathParameter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractParameter

Returns:

a description suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractParameter

Returns:

an enumeration of all the available options.

getOptions

public String[] getOptions()

returns the options of the current setup.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class AbstractParameter

Returns:

the current options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses the options for this object.

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class AbstractParameter

Parameters:

options - the options to use

Throws:

Exception - if setting of options fails

minTipText

public String minTipText()

Returns the tip text for this property.

Returns:

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

getMin

public double getMin()

Get the value of the minimum.

Returns:

Value of the minimum.

setMin

public void setMin(double value)

Set the value of the minimum.

Parameters:

value - Value to use as minimum.

maxTipText

public String maxTipText()

Returns the tip text for this property.

Returns:

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

getMax

public double getMax()

Get the value of the Maximum.

Returns:

Value of the Maximum.

setMax

public void setMax(double value)

Set the value of the Maximum.

Parameters:

value - Value to use as Maximum.

stepTipText

public String stepTipText()

Returns the tip text for this property.

Returns:

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

getStep

public double getStep()

Get the value of the step size.

Returns:

Value of the step size.

setStep

public void setStep(double value)

Set the value of the step size.

Parameters:

value - Value to use as the step size.

baseTipText

public String baseTipText()

Returns the tip text for this property.

Returns:

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

getBase

public double getBase()

Get the value of the base.

Returns:

Value of the base.

setBase

public void setBase(double value)

Set the value of the base.

Parameters:

value - Value to use as the base.

expressionTipText

public String expressionTipText()

Returns the tip text for this property.

Returns:

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

getExpression

public String getExpression()

Get the expression.

Returns:

Expression.

setExpression

public void setExpression(String value)

Set the expression.

Parameters:

value - Expression.

toString

public String toString()

Returns a string representation of the search parameter.

Overrides:

toString in class AbstractParameter

Returns:

a string representation