weka.core.setupgenerator

Class ListSpaceDimension

java.lang.Object

weka.core.setupgenerator.SpaceDimension

weka.core.setupgenerator.ListSpaceDimension

All Implemented Interfaces:

Serializable

public class ListSpaceDimension
extends SpaceDimension

Represents a single dimension in a multi-dimensional space that is based on a list of values.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListSpaceDimension(int min, int max, String[] list, String label) initializes the dimension (for list values).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Tests itself against the provided dimension object.
String[]	getList() Returns the list of values, null in case of a numeric dimension that is based on a mathematical function.
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.
ListSpaceDimension	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

ListSpaceDimension

public ListSpaceDimension(int min,
                          int max,
                          String[] list,
                          String label)

initializes the dimension (for list values).

Parameters:

min - the minimum index in the list (0-based index)

max - the maximum index in the list (0-based index)

list - the available values

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

getList

public String[] getList()

Returns the list of values, null in case of a numeric dimension that is based on a mathematical function.

Returns:

the list

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 ListSpaceDimension 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