weka.core.setupgenerator

Class FunctionSpaceDimension

java.lang.Object

weka.core.setupgenerator.SpaceDimension

weka.core.setupgenerator.FunctionSpaceDimension

All Implemented Interfaces:

Serializable

public class FunctionSpaceDimension
extends SpaceDimension

Represents a single dimension in a multi-dimensional space.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FunctionSpaceDimension(double min, double max, double step, String label) initializes the dimension (for numeric values).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Tests itself against the provided dimension object.
int	getLocation(Object value) returns the closest index for the given value in the dimension.
Object	getValue(int x) returns the value at the given point in the dimension.
FunctionSpaceDimension	subdimension(int left, int right) returns a sub-dimension with the same type/step/list, but different borders.
String	toString() Returns a string representation of the dimension.

Methods inherited from class weka.core.setupgenerator.SpaceDimension

getLabel, getMax, getMin, getStep, isOnBorder, isOnBorder, width

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionSpaceDimension

public FunctionSpaceDimension(double min,
                              double max,
                              double step,
                              String label)

initializes the dimension (for numeric values).

Parameters:

min - the minimum on the axis

max - the maximum on the axis

step - the step size for the axis

label - the label for the axis

Method Detail

equals

public boolean equals(Object o)

Tests itself against the provided dimension object.

Specified by:

equals in class SpaceDimension

Parameters:

o - the dimension object to compare against

Returns:

if the two dimensions have the same setup

getValue

public Object getValue(int x)

returns the value at the given point in the dimension.

Specified by:

getValue in class SpaceDimension

Parameters:

x - the x-th point on the axis

Returns:

the value at the given position

getLocation

public int getLocation(Object value)

returns the closest index for the given value in the dimension.

Specified by:

getLocation in class SpaceDimension

Parameters:

value - the value to get the index for

Returns:

the closest index in the dimension

subdimension

public FunctionSpaceDimension subdimension(int left,
                                           int right)

returns a sub-dimension with the same type/step/list, but different borders.

Specified by:

subdimension in class SpaceDimension

Parameters:

left - the left index

right - the right index

Returns:

the sub-dimension

toString

public String toString()

Returns a string representation of the dimension.

Specified by:

toString in class SpaceDimension

Returns:

a string representation