Package microsim.space
Class DenseObjectSpace
- java.lang.Object
-
- microsim.space.AbstractSpace<java.lang.Object>
-
- microsim.space.DenseObjectSpace
-
- All Implemented Interfaces:
ObjectSpace
- Direct Known Subclasses:
MultiObjectSpace
public class DenseObjectSpace extends AbstractSpace<java.lang.Object> implements ObjectSpace
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
Constructors Constructor Description DenseObjectSpace(int xSize, int ySize)
Create a grid with given size.DenseObjectSpace(AbstractSpace<java.lang.Object> grid)
Create a copy of the given grid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(java.lang.Object o)
Add an object implementing IGridPosition interface to the grid.boolean
addGridPosition(SpacePosition position)
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.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(SpacePosition position, 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(SpacePosition position)
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 microsim.space.AbstractSpace
boundX, boundY, equals, getMooreNeighborsPositions, getVonNeumannNeighborsPositions, getXSize, getYSize, reflectX, reflectY, torusX, torusY, toString
-
-
-
-
Constructor Detail
-
DenseObjectSpace
public DenseObjectSpace(AbstractSpace<java.lang.Object> grid)
Create a copy of the given grid.- Parameters:
grid
- The source grid.
-
DenseObjectSpace
public DenseObjectSpace(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
-
get
public java.lang.Object get(int x, int y)
Return the object stored at the given position.- Specified by:
get
in interfaceObjectSpace
- Specified by:
get
in classAbstractSpace<java.lang.Object>
- Parameters:
x
- The x coordinate.y
- The y coordinate.- Returns:
- The requested object.
-
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.- 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.
-
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 classAbstractSpace<java.lang.Object>
- 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.
-
set
public void set(int x, int y, java.lang.Object obj)
Put the given object at the given position.- Specified by:
set
in interfaceObjectSpace
- Specified by:
set
in classAbstractSpace<java.lang.Object>
- Parameters:
x
- The x coordinate.y
- The y coordinate.obj
- The object to be stored at the (x, y) cell.
-
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 objecty
- 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 objecty
- the y coordinate of the objectxExtent
- the extension of the neighborhood in the x directionyExtent
- 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 objecty
- 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 objecty
- the y coordinate of the objectxExtent
- the extension of the neighborhood in the x directionyExtent
- 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(SpacePosition position, 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 interfaceObjectSpace
- 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.
-
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.
-
size
public int size()
Return the number of objects stored into the grid.- Specified by:
size
in classAbstractSpace<java.lang.Object>
- Returns:
- The sum of cells containing an object.
-
clear
public void clear()
Set all cells to the null value.- Specified by:
clear
in classAbstractSpace<java.lang.Object>
-
addGridPosition
public boolean addGridPosition(SpacePosition position)
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 interfaceObjectSpace
- 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.
-
removeGridPosition
public boolean removeGridPosition(SpacePosition position)
Remove the IGridPosition object from the grid.- Specified by:
removeGridPosition
in interfaceObjectSpace
- 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.
-
countObjectsAt
public int countObjectsAt(int x, int y)
Description copied from class:AbstractSpace
Returns the number of objects allocated in cell (x,y).- Specified by:
countObjectsAt
in interfaceObjectSpace
- Specified by:
countObjectsAt
in classAbstractSpace<java.lang.Object>
- Parameters:
x
- The x coordinate.y
- The y coordinate.
-
-