jas.space
Class MultiObjGrid

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

All Implemented Interfaces:

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

public class MultiObjGrid
extends ObjGrid

A bidimensional grid capable of containing many objects into each 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

MultiObjGrid(Grid grid)
Create a copy of the given grid with a default intial capacity.

MultiObjGrid(Grid grid, int cellCapacity)
Create a copy of the given grid with a given intial capacity.

MultiObjGrid(int xSize, int ySize)
Create a grid with given size and a default intial capacity.

MultiObjGrid(int xSize, int ySize, int cellCapacity)
Create a grid with given size and a given intial capacity.

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.
int	countObjectsAt(int x, int y) Return the number of objects stored at the given position.
java.lang.Object	get(int x, int y, int z) Return the object stored at the given tridimensional position.
boolean	moveGridPosition(IGridPosition object, int destinationX, int destinationY) Move a IGridPosition object from its current position to the specified destination.
boolean	remove(java.lang.Object o) Remove the given object from the grid.
boolean	removeAt(int x, int y, java.lang.Object o) Remove the given object from the grid at given position.
boolean	removeGridPosition(IGridPosition object) Remove the IGridPosition object from the grid.
void	set(int x, int y, int z, java.lang.Object obj) Put the given object at the given tridimensional position.
void	set(int x, int y, java.lang.Object obj) Enqueue the given object at the given position.

Methods inherited from class jas.space.ObjGrid

clear, get, getMatrix, getMooreNeighbors, getMooreNeighbors, getVonNeumannNeighbors, getVonNeumannNeighbors, size, swapPositions

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, 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

MultiObjGrid

public MultiObjGrid(Grid grid)

Create a copy of the given grid with a default intial capacity.

Parameters:

grid - The source grid.

MultiObjGrid

public MultiObjGrid(Grid grid,
                    int cellCapacity)

Create a copy of the given grid with a given intial capacity.

Parameters:

grid - The source grid.

cellCapacity - The initial vector size allocated for each cell. It grows automatically.

MultiObjGrid

public MultiObjGrid(int xSize,
                    int ySize)

Create a grid with given size and a default intial capacity.

Parameters:

xSize - The width of the grid.

ySize - The height of the grid.

MultiObjGrid

public MultiObjGrid(int xSize,
                    int ySize,
                    int cellCapacity)

Create a grid with given size and a given intial capacity.

Parameters:

xSize - The width of the grid.

ySize - The height of the grid.

cellCapacity - The initial vector size allocated for each cell. It grows automatically.

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 ObjGrid

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

Overrides:

addGridPosition in class ObjGrid

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.

countObjectsAt

public int countObjectsAt(int x,
                          int y)

Return the number of objects stored at the given position.

Specified by:

countObjectsAt in interface IObjGrid

Overrides:

countObjectsAt in class ObjGrid

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

The number of objects at (x, y).

get

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

Return the object stored at the given tridimensional position.

Parameters:

x - The x coordinate.

y - The y coordinate.

z - The index of the vector of object stored at the (x, y) cell. WARNING There is no bound checking. Before using this method please ensure the object requestes does exists.

Returns:

The requested object.

moveGridPosition

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

Move a IGridPosition object from its current position to the specified destination.

Specified by:

moveGridPosition in interface IObjGrid

Overrides:

moveGridPosition in class ObjGrid

Parameters:

destinationX - The x destination coordinate.

destinationY - The y destination coordinate.

object - An object implementing IGridPosition interface.

Returns:

true. Only if the argument object is null the return value will be false.

remove

public boolean remove(java.lang.Object o)

Remove the given object from the grid.

Specified by:

remove in interface java.util.Collection

Overrides:

remove in class java.util.AbstractCollection

Parameters:

o - The object to be removed.

Returns:

True if object was found and removed, false otherwise.

removeAt

public boolean removeAt(int x,
                        int y,
                        java.lang.Object o)

Remove the given object from the grid at given position. If the object position is known this method is better than than remove() because it works much faster.

Parameters:

x - The x coordinate.

y - The y coordinate.

o - The object to be removed.

Returns:

True if object was found and removed, false otherwise.

removeGridPosition

public boolean removeGridPosition(IGridPosition object)

Remove the IGridPosition object from the grid.

Specified by:

removeGridPosition in interface IObjGrid

Overrides:

removeGridPosition in class ObjGrid

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,
                int z,
                java.lang.Object obj)

Put the given object at the given tridimensional position.

Parameters:

x - The x coordinate.

y - The y coordinate.

z - The index of the vector of object stored at the (x, y) cell. If z is out of vector bounds this will be automatically grown.

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

set

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

Enqueue the given object at the given position.

Overrides:

set in class ObjGrid

Parameters:

x - The x coordinate.

y - The y coordinate.

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