jas.space
Class ObjGrid

java.lang.Object
  java.util.AbstractCollection
      jas.space.Grid
          jas.space.ObjGrid

All Implemented Interfaces:

IObjGrid, java.lang.Iterable, java.util.Collection

Direct Known Subclasses:

MultiObjGrid

public class ObjGrid
extends Grid
implements IObjGrid

A bidimensional grid containing one object per cell.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Constructor Summary

ObjGrid(Grid grid)
Create a copy of the given grid.

ObjGrid(int xSize, int ySize)
Create a grid with given size.

Method Summary

boolean	add(java.lang.Object o) Add an object implementing IGridPosition interface to the grid.
boolean	addGridPosition(IGridPosition object) Add an object implementing IGridPosition interface to the grid.
void	clear() Set all cells to the null value.
int	countObjectsAt(int x, int y) Returns the number of objects allocated in cell (x,y).
java.lang.Object	get(int x, int y) Return the object stored at the given position.
java.lang.Object[][]	getMatrix() Return the matrix of objects representing the grid.
java.lang.Object[]	getMooreNeighbors(int x, int y) Gets the Moore neighbors of the specified coordinate. doubles are returned by row starting with the "NW corner" and ending with the "SE corner."
java.lang.Object[]	getMooreNeighbors(int x, int y, int xExtent, int yExtent) Gets the extended Moore neighbors of the specified coordinate.
java.lang.Object[]	getVonNeumannNeighbors(int x, int y) Gets the von Neumann neighbors of the specified coordinate.
java.lang.Object[]	getVonNeumannNeighbors(int x, int y, int xExtent, int yExtent) Gets the extended von Neumann neighbors of the specified coordinate.
boolean	moveGridPosition(IGridPosition object, int destinationX, int destinationY) Move a IGridPosition object from its current position to the specified destination, only if the destination cell is empty.
boolean	removeGridPosition(IGridPosition object) Remove the IGridPosition object from the grid.
void	set(int x, int y, java.lang.Object obj) Put the given object at the given position.
int	size() Return the number of objects stored into the grid.
void	swapPositions(int x1, int y1, int x2, int y2) Swap the content of the (x1, y1) and (x2, y2) cells of the grid.

Methods inherited from class jas.space.Grid

boundX, boundY, equals, getMooreNeighborsPositions, getVonNeumannNeighborsPositions, getXSize, getYSize, gridIterator, iterator, reflectX, reflectY, torusX, torusY, toString

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface jas.space.IObjGrid

boundX, boundY, getXSize, getYSize, reflectX, reflectY, torusX, torusY

Methods inherited from interface java.util.Collection

hashCode

Constructor Detail

ObjGrid

public ObjGrid(Grid grid)

Create a copy of the given grid.

Parameters:

grid - The source grid.

ObjGrid

public ObjGrid(int xSize,
               int ySize)

Create a grid with given size.

Parameters:

xSize - The width of the grid.

ySize - The height of the grid.

Method Detail

add

public boolean add(java.lang.Object o)

Add an object implementing IGridPosition interface to the grid. If object implements IGridPosition it stored in the right position of the grid.

Specified by:

add in interface java.util.Collection

Overrides:

add in class java.util.AbstractCollection

Parameters:

o - The IGridPosition object to be added.

Returns:

True if object was added. If o does not implement IGridPosition interface it will not be added and method will return false.

addGridPosition

public boolean addGridPosition(IGridPosition object)

Add an object implementing IGridPosition interface to the grid. If the destination cell is already occupied the method return false and the object is not added.

Specified by:

addGridPosition in interface IObjGrid

Parameters:

object - The IGridPosition object to be added.

Returns:

True if object has been added. False if destination cell is already occupied or if argument object is null.

clear

public void clear()

Set all cells to the null value.

Specified by:

clear in interface java.util.Collection

Specified by:

clear in class Grid

countObjectsAt

public int countObjectsAt(int x,
                          int y)

Description copied from class: Grid

Returns the number of objects allocated in cell (x,y).

Specified by:

countObjectsAt in interface IObjGrid

Specified by:

countObjectsAt in class Grid

Parameters:

x - The x coordinate.

y - The y coordinate.

get

public java.lang.Object get(int x,
                            int y)

Return the object stored at the given position.

Specified by:

get in class Grid

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

The requested object.

getMatrix

public java.lang.Object[][] getMatrix()

Return the matrix of objects representing the grid.

Returns:

A matrix of Object with the same dimensions of the grid.

getMooreNeighbors

public java.lang.Object[] getMooreNeighbors(int x,
                                            int y)

Gets the Moore neighbors of the specified coordinate. doubles are returned by row starting with the "NW corner" and ending with the "SE corner." The double at x, y is not returned.

Parameters:

x - the x coordinate of the object

y - the y coordinate of the object

Returns:

an array of doubles ordered by row starting with the "NW corner" and ending with the "SE corner."

getMooreNeighbors

public java.lang.Object[] getMooreNeighbors(int x,
                                            int y,
                                            int xExtent,
                                            int yExtent)

Gets the extended Moore neighbors of the specified coordinate. The extension in the x and y direction are specified by xExtent and yExtent. doubles are returned by row starting with the "NW corner" and ending with the "SE corner." The double at x,y is not returned.

Parameters:

x - the x coordinate of the object

y - the y coordinate of the object

xExtent - the extension of the neighborhood in the x direction

yExtent - the extension of the neighborhood in the y direction

Returns:

an array of doubles ordered by row starting with the "NW corner" and ending with the "SE corner."

getVonNeumannNeighbors

public java.lang.Object[] getVonNeumannNeighbors(int x,
                                                 int y)

Gets the von Neumann neighbors of the specified coordinate. doubles are returned in west, east, north, south order. The double at x, y is not returned.

Parameters:

x - the x coordinate of the object

y - the y coordinate of the object

Returns:

an array of doubles in west, east, north, south order

getVonNeumannNeighbors

public java.lang.Object[] getVonNeumannNeighbors(int x,
                                                 int y,
                                                 int xExtent,
                                                 int yExtent)

Gets the extended von Neumann neighbors of the specified coordinate. The extension in the x and y direction are specified by xExtent and yExtent. doubles are returned in west, east, north, south order with the most distant object first. The double at x,y is not returned.

Parameters:

x - the x coordinate of the object

y - the y coordinate of the object

xExtent - the extension of the neighborhood in the x direction

yExtent - the extension of the neighborhood in the y direction

Returns:

an array of doubles in west, east, north, south order with the most distant object first.

moveGridPosition

public boolean moveGridPosition(IGridPosition object,
                                int destinationX,
                                int destinationY)

Move a IGridPosition object from its current position to the specified destination, only if the destination cell is empty.

Specified by:

moveGridPosition in interface IObjGrid

Parameters:

destinationX - The x destination coordinate.

destinationY - The y destination coordinate.

object - An object implementing IGridPosition interface.

Returns:

true if object has been moved, false otherwise.

removeGridPosition

public boolean removeGridPosition(IGridPosition object)

Remove the IGridPosition object from the grid.

Specified by:

removeGridPosition in interface IObjGrid

Parameters:

object - The IGridPosition object to be removed.

Returns:

true if object has been removed. False if object is null or is not present on the grid.

set

public void set(int x,
                int y,
                java.lang.Object obj)

Put the given object at the given position.

Specified by:

set in class Grid

Parameters:

x - The x coordinate.

y - The y coordinate.

obj - The object to be stored at the (x, y) cell.

size

public int size()

Return the number of objects stored into the grid.

Specified by:

size in interface java.util.Collection

Specified by:

size in class Grid

Returns:

The sum of cells containing an object.

swapPositions

public void swapPositions(int x1,
                          int y1,
                          int x2,
                          int y2)

Swap the content of the (x1, y1) and (x2, y2) cells of the grid.

Specified by:

swapPositions in class Grid

Parameters:

x1 - The x coordinate for the first cell.

y1 - The y coordinate for the first cell.

x2 - The x coordinate for the second cell.

y2 - The y coordinate for the second cell.