public class ObjectGrid2D extends AbstractGrid2D
This object expects that the 2D arrays are rectangular. You are encouraged to access the array directly. The object implements all of the Grid2D interface. See Grid2D for rules on how to properly implement toroidal or hexagonal grids.
The width and height of the object are provided to avoid having to say field[x].length, etc.
We very strongly encourage you to examine SparseGrid2D first to see if it's more appropriate to your task. If you need arbitrary numbers of Objects to be able to occupy the same location in the grid, or if you have very few Objects and a very large grid, or if your space is unbounded, you should probably use SparseGrid2D instead.
Modifier and Type | Field and Description |
---|---|
java.lang.Object[][] |
field |
height, width
Constructor and Description |
---|
ObjectGrid2D(int width,
int height) |
ObjectGrid2D(int width,
int height,
java.lang.Object initialValue) |
ObjectGrid2D(java.lang.Object[][] values) |
ObjectGrid2D(ObjectGrid2D values) |
Modifier and Type | Method and Description |
---|---|
Bag |
clear()
Sets all the locations in the grid to null, and returns in a Bag all previously stored objects
(including duplicates but not null values).
|
Bag |
elements()
Returns in a Bag all stored objects (including duplicates but not null values).
|
java.lang.Object |
get(int x,
int y)
Returns the element at location (x,y)
|
Bag |
getHexagonalNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin)
Determines all locations located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point
inclusive.
|
Bag |
getHexagonalNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point
inclusive.
|
Bag |
getHexagonalNeighborsAndLocations(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point
inclusive.
|
Bag |
getMooreNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin)
Determines all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist.
|
Bag |
getMooreNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist, This region forms a
square 2*dist+1 cells across, centered at (X,Y).
|
Bag |
getMooreNeighborsAndLocations(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist.
|
Bag |
getNeighborsHamiltonianDistance(int x,
int y,
int dist,
boolean toroidal,
Bag result,
IntBag xPos,
IntBag yPos)
Deprecated.
|
Bag |
getNeighborsHexagonalDistance(int x,
int y,
int dist,
boolean toroidal,
Bag result,
IntBag xPos,
IntBag yPos)
Deprecated.
|
Bag |
getNeighborsMaxDistance(int x,
int y,
int dist,
boolean toroidal,
Bag result,
IntBag xPos,
IntBag yPos)
Deprecated.
|
Bag |
getRadialNeighbors(int x,
int y,
double dist,
int mode,
boolean includeOrigin) |
Bag |
getRadialNeighbors(int x,
int y,
double dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos) |
Bag |
getRadialNeighbors(int x,
int y,
double dist,
int mode,
boolean includeOrigin,
int measurementRule,
boolean closed,
Bag result,
IntBag xPos,
IntBag yPos) |
Bag |
getRadialNeighborsAndLocations(int x,
int y,
double dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos) |
Bag |
getRadialNeighborsAndLocations(int x,
int y,
double dist,
int mode,
boolean includeOrigin,
int measurementRule,
boolean closed,
Bag result,
IntBag xPos,
IntBag yPos) |
Bag |
getVonNeumannNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin)
Determines all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
|
Bag |
getVonNeumannNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
|
Bag |
getVonNeumannNeighborsAndLocations(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
|
void |
replaceAll(java.lang.Object from,
java.lang.Object to)
Replace instances of one value to another.
|
void |
replaceAll(java.lang.Object from,
java.lang.Object to,
boolean onlyIfSameObject)
Replace instances of one value to another.
|
protected void |
reshape(int width,
int height) |
void |
set(int x,
int y,
java.lang.Object val)
Sets location (x,y) to val
|
ObjectGrid2D |
setTo(java.lang.Object thisObj)
Sets all the locations in the grid the provided element.
|
ObjectGrid2D |
setTo(java.lang.Object[][] field)
Sets the grid to a copy of the provided array, which must be rectangular.
|
ObjectGrid2D |
setTo(ObjectGrid2D values)
Changes the dimensions of the grid to be the same as the one provided, then
sets all the locations in the grid to the elements at the quivalent locations in the
provided grid.
|
java.lang.Object[] |
toArray()
Flattens the grid to a one-dimensional array, storing the elements in row-major order,including duplicates and null values.
|
buildMap, buildMap, checkBounds, dlx, dly, downx, downy, drx, dry, getHeight, getHexagonalLocations, getMooreLocations, getNeighborsHamiltonianDistance, getNeighborsHexagonalDistance, getNeighborsMaxDistance, getRadialLocations, getRadialLocations, getVonNeumannLocations, getWidth, isDistributed, removeOrigin, removeOriginToroidal, stx, sty, trb, trt, tx, ty, ulx, uly, upx, upy, urx, ury
public ObjectGrid2D(int width, int height)
public ObjectGrid2D(int width, int height, java.lang.Object initialValue)
public ObjectGrid2D(ObjectGrid2D values)
public ObjectGrid2D(java.lang.Object[][] values)
public final void set(int x, int y, java.lang.Object val)
public final java.lang.Object get(int x, int y)
protected void reshape(int width, int height)
public final ObjectGrid2D setTo(java.lang.Object thisObj)
public ObjectGrid2D setTo(java.lang.Object[][] field)
public final java.lang.Object[] toArray()
public final Bag elements()
public final Bag clear()
public final ObjectGrid2D setTo(ObjectGrid2D values)
public final void replaceAll(java.lang.Object from, java.lang.Object to)
from
- any element that matches this value will be replacedto
- with this valuepublic final void replaceAll(java.lang.Object from, java.lang.Object to, boolean onlyIfSameObject)
from
- any element that matches this value will be replacedto
- with this valuepublic Bag getNeighborsMaxDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)
Then places into the result Bag any Objects which fall on one of these This function may only run in two modes: toroidal or bounded. Unbounded lookup is not permitted, and so
this function is deprecated: instead you should use the other version of this function which has more functionality.
If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
The origin -- that is, the (x,y) point at the center of the neighborhood -- is always included in the results.
This function is equivalent to: getNeighborsMaxDistance(x,y,dist,toroidal ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);
public Bag getMooreNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
Then places into the result Bag any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getMooreNeighborsAndLocations(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
For each Object which falls within this distance, adds the X position, Y position, and Object into the
xPos, yPos, and result Bag, clearing them first.
Some This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getNeighborsHamiltonianDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)
Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first.
Then places into the result Bag any Objects which fall on one of these This function may only run in two modes: toroidal or bounded. Unbounded lookup is not permitted, and so
this function is deprecated: instead you should use the other version of this function which has more functionality.
If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
The origin -- that is, the (x,y) point at the center of the neighborhood -- is always included in the results.
This function is equivalent to: getNeighborsHamiltonianDistance(x,y,dist,toroidal ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);
public Bag getVonNeumannNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first.
Then places into the result Bag any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getVonNeumannNeighborsAndLocations(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
For each Object which falls within this distance, adds the X position, Y position, and Object into the
xPos, yPos, and result Bag, clearing them first.
Some This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getNeighborsHexagonalDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)
Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first.
Then places into the result Bag any Objects which fall on one of these This function may only run in two modes: toroidal or bounded. Unbounded lookup is not permitted, and so
this function is deprecated: instead you should use the other version of this function which has more functionality.
If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
The origin -- that is, the (x,y) point at the center of the neighborhood -- is always included in the results.
This function is equivalent to: getNeighborsHexagonalDistance(x,y,dist,toroidal ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);
public Bag getHexagonalNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first.
Then places into the result Bag any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getHexagonalNeighborsAndLocations(int x, int y, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
For each Object which falls within this distance, adds the X position, Y position, and Object into the
xPos, yPos, and result Bag, clearing them first.
Some This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
You can also opt to include the origin -- that is, the (x,y) point at the center of the neighborhood -- in the neighborhood results.
public Bag getRadialNeighbors(int x, int y, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
public Bag getRadialNeighborsAndLocations(int x, int y, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos)
public Bag getRadialNeighbors(int x, int y, double dist, int mode, boolean includeOrigin, int measurementRule, boolean closed, Bag result, IntBag xPos, IntBag yPos)
public Bag getRadialNeighborsAndLocations(int x, int y, double dist, int mode, boolean includeOrigin, int measurementRule, boolean closed, Bag result, IntBag xPos, IntBag yPos)
public Bag getMooreNeighbors(int x, int y, int dist, int mode, boolean includeOrigin)
Then returns, as a Bag, any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
public Bag getVonNeumannNeighbors(int x, int y, int dist, int mode, boolean includeOrigin)
Then returns, as a Bag, any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
public Bag getHexagonalNeighbors(int x, int y, int dist, int mode, boolean includeOrigin)
Then returns, as a Bag, any Objects which fall on one of these This function may be run in one of three modes: Grid2D.BOUNDED, Grid2D.UNBOUNDED, and Grid2D.TOROIDAL. If "bounded",
then the neighbors are restricted to be only those which lie within the box ranging from (0,0) to (width, height),
that is, the width and height of the grid. If "unbounded", then the neighbors are not so restricted. Note that unbounded
neighborhood lookup only makes sense if your grid allows locations to actually be outside this box. For example,
SparseGrid2D permits this but ObjectGrid2D and DoubleGrid2D and IntGrid2D and DenseGrid2D do not. Finally if "toroidal",
then the environment is assumed to be toroidal, that is, wrap-around, and neighbors are computed in this fashion. Toroidal
locations will not appear multiple times: specifically, if the neighborhood distance is so large that it wraps completely around
the width or height of the box, neighbors will not be counted multiple times. Note that to ensure this, subclasses may need to
resort to expensive duplicate removal, so it's not suggested you use so unreasonably large distances.
public Bag getRadialNeighbors(int x, int y, double dist, int mode, boolean includeOrigin)