Package uk.ac.manchester.spinnaker.machine

Class ChipLocation

java.lang.Object

uk.ac.manchester.spinnaker.machine.ChipLocation

All Implemented Interfaces:

Serializable, Comparable<ChipLocation>, HasChipLocation

@Immutable
public final class ChipLocation
extends Object
implements HasChipLocation, Comparable<ChipLocation>, Serializable

The location of a Chip as an X and Y tuple.

This class is final as it is used a key in maps.

Author:

Alan Stokes, Donal Fellows

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ChipLocation	ONE_ZERO	The location (1,0), which is the one to the east/right of the bottom/left corner.
static ChipLocation	ZERO_ZERO	The location (0,0), which is in the bottom/left corner and typically the Ethernet-enabled chip for the lead board of an allocation.

Constructor Summary

Constructors

Constructor	Description
ChipLocation(int x, int y)	Create the location of a chip on a SpiNNaker machine.

Method Summary

Modifier and Type	Method	Description
ChipLocation	asChipLocation()	Converts (if required) this to a simple X, Y tuple.
int	compareTo(ChipLocation other)
boolean	equals(Object obj)
int	getX()
int	getY()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.manchester.spinnaker.machine.HasChipLocation

getScampCore, onSameChipAs

Field Details

ZERO_ZERO

public static final ChipLocation ZERO_ZERO

The location (0,0), which is in the bottom/left corner and typically the Ethernet-enabled chip for the lead board of an allocation. It is also typically the boot board of an allocation.

ONE_ZERO

public static final ChipLocation ONE_ZERO

The location (1,0), which is the one to the east/right of the bottom/left corner.

This location has special meaning on a 4 chip board.

Constructor Details

ChipLocation

public ChipLocation(int x, int y)

Create the location of a chip on a SpiNNaker machine.

Parameters:

x - The X coordinate

y - The Y coordinate

Throws:

IllegalArgumentException - Thrown is either x or y is negative or too big.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(ChipLocation other)

Specified by:

compareTo in interface Comparable<ChipLocation>

getX

public int getX()

Specified by:

getX in interface HasChipLocation

Returns:

The X coordinate of the chip.

getY

public int getY()

Specified by:

getY in interface HasChipLocation

Returns:

The Y coordinate of the chip.

toString

public String toString()

Overrides:

toString in class Object

asChipLocation

public ChipLocation asChipLocation()

Description copied from interface: HasChipLocation

Converts (if required) this to a simple X, Y tuple.

Specified by:

asChipLocation in interface HasChipLocation

Returns:

A ChipLocation representation of the X and Y tuple