Package uk.ac.manchester.spinnaker.machine

Class CoreLocation

java.lang.Object

uk.ac.manchester.spinnaker.machine.CoreLocation

All Implemented Interfaces:

Serializable, Comparable<CoreLocation>, HasChipLocation, HasCoreLocation

@Immutable
public final class CoreLocation
extends Object
implements HasCoreLocation, Comparable<CoreLocation>, Serializable

The location of a Processor on a Chip as an X, Y, P tuple.

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

Author:

Alan Stokes, Donal Fellows

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CoreLocation(int x, int y, int p)	Create the location of a core on a SpiNNaker machine.
CoreLocation(HasChipLocation chip, int p)	Create the location of a core on a SpiNNaker machine.

Method Summary

Modifier and Type	Method	Description
CoreLocation	asCoreLocation()	Converts (if required) this to a simple X, Y, P tuple.
int	compareTo(CoreLocation other)
boolean	equals(Object obj)
int	getP()
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

asChipLocation, getScampCore, onSameChipAs

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

onSameCoreAs

Constructor Details

CoreLocation

public CoreLocation(int x, int y, int p)

Create the location of a core on a SpiNNaker machine.

Parameters:

x - The X coordinate, in range 0..255

y - The Y coordinate, in range 0..255

p - The P coordinate, in range 0..17

CoreLocation

public CoreLocation(HasChipLocation chip, int p)

Create the location of a core on a SpiNNaker machine.

Parameters:

chip - The X and Y coordinate, in range 0..255

p - The P coordinate, in range 0..17

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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.

getP

public int getP()

Specified by:

getP in interface HasCoreLocation

Returns:

The processor coordinate of the core on its chip.

toString

public String toString()

Overrides:

toString in class Object

asCoreLocation

public CoreLocation asCoreLocation()

Description copied from interface: HasCoreLocation

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

Specified by:

asCoreLocation in interface HasCoreLocation

Returns:

A CoreLocation representation of the X, Y, P tuple

compareTo

public int compareTo(CoreLocation other)

Specified by:

compareTo in interface Comparable<CoreLocation>