aima.core.util.datastructure

Class XYLocation

java.lang.Object

aima.core.util.datastructure.XYLocation

public class XYLocation
extends java.lang.Object

Note: If looking at a rectangle - the coordinate (x=0, y=0) will be the top left hand corner. This corresponds with Java's AWT coordinate system.

Author:

Ravi Mohan, Mike Stampone

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XYLocation.Direction

Constructor Summary

Constructors

Constructor and Description
XYLocation(int x, int y) Constructs and initializes a location at the specified (x, y) location in the coordinate space.

Method Summary

Modifier and Type	Method and Description
XYLocation	down() Returns the location one unit below this location.
XYLocation	east() Returns the location one unit right of this location.
boolean	equals(java.lang.Object o)
int	getXCoOrdinate() Returns the X coordinate of the location in integer precision.
int	getYCoOrdinate()
int	hashCode()
XYLocation	left() Returns the location one unit left of this location.
XYLocation	locationAt(XYLocation.Direction direction) Returns the location one unit from this location in the specified direction.
XYLocation	north() Returns the location one unit ahead of this location.
XYLocation	right() Returns the location one unit right of this location.
XYLocation	south() Returns the location one unit behind, this location.
java.lang.String	toString()
XYLocation	up() Returns the location one unit above this location.
XYLocation	west() Returns the location one unit left of this location.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XYLocation

public XYLocation(int x,
                  int y)

Constructs and initializes a location at the specified (x, y) location in the coordinate space.

Parameters:

x - the x coordinate

y - the y coordinate

Method Detail

getXCoOrdinate

public int getXCoOrdinate()

Returns the X coordinate of the location in integer precision.

Returns:

the X coordinate of the location in double precision.

getYCoOrdinate

public int getYCoOrdinate()

west

public XYLocation west()

Returns the location one unit left of this location.

Returns:

the location one unit left of this location.

east

public XYLocation east()

Returns the location one unit right of this location.

Returns:

the location one unit right of this location.

north

public XYLocation north()

Returns the location one unit ahead of this location.

Returns:

the location one unit ahead of this location.

south

public XYLocation south()

Returns the location one unit behind, this location.

Returns:

the location one unit behind this location.

left

public XYLocation left()

Returns the location one unit left of this location.

Returns:

the location one unit left of this location.

right

public XYLocation right()

Returns the location one unit right of this location.

Returns:

the location one unit right of this location.

up

public XYLocation up()

Returns the location one unit above this location.

Returns:

the location one unit above this location.

down

public XYLocation down()

Returns the location one unit below this location.

Returns:

the location one unit below this location.

locationAt

public XYLocation locationAt(XYLocation.Direction direction)

Returns the location one unit from this location in the specified direction.

Returns:

the location one unit from this location in the specified direction.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object