weka.core.setupgenerator

Class SpaceDimension

java.lang.Object

weka.core.setupgenerator.SpaceDimension

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FunctionSpaceDimension, ListSpaceDimension

public abstract class SpaceDimension
extends Object
implements Serializable

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
SpaceDimension()

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(Object o) Tests itself against the provided dimension object.
String	getLabel() returns the label for the axis.
abstract int	getLocation(Object value) returns the closest index for the given value in the dimension.
double	getMax() returns the right border.
double	getMin() returns the left border.
double	getStep() returns the step size on the axis.
abstract Object	getValue(int x) returns the value at the given point in the dimension.
boolean	isOnBorder(double value) checks whether the given value is on the border of the dimension.
boolean	isOnBorder(int location) checks whether the given location is on the border of the dimension.
abstract SpaceDimension	subdimension(int left, int right) returns a sub-dimension with the same type/step/list, but different borders.
abstract String	toString() Returns a string representation of the dimension.
int	width() returns the number of points on the axis (incl.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceDimension

public SpaceDimension()

Method Detail

equals

public abstract boolean equals(Object o)

Tests itself against the provided dimension object.

Overrides:

equals in class Object

Parameters:

o - the dimension object to compare against

Returns:

if the two dimensions have the same setup

getMin

public double getMin()

returns the left border.

Returns:

the left border

getMax

public double getMax()

returns the right border.

Returns:

the right border

getStep

public double getStep()

returns the step size on the axis.

Returns:

the step size

getLabel

public String getLabel()

returns the label for the axis.

Returns:

the label

width

public int width()

returns the number of points on the axis (incl. borders)

Returns:

the number of points on the axis

getValue

public abstract Object getValue(int x)

returns the value at the given point in the dimension.

Parameters:

x - the x-th point on the axis

Returns:

the value at the given position

getLocation

public abstract int getLocation(Object value)

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

Parameters:

value - the value to get the index for

Returns:

the closest index in the dimension

isOnBorder

public boolean isOnBorder(double value)

checks whether the given value is on the border of the dimension.

Parameters:

value - the value to check

Returns:

true if the the value is on the border

isOnBorder

public boolean isOnBorder(int location)

checks whether the given location is on the border of the dimension.

Parameters:

location - the location to check

Returns:

true if the the location is on the border

subdimension

public abstract SpaceDimension subdimension(int left,
                                            int right)

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

Parameters:

left - the left index

right - the right index

Returns:

the sub-dimension

toString

public abstract String toString()

Returns a string representation of the dimension.

Overrides:

toString in class Object

Returns:

a string representation