public class DenseGrid3D extends AbstractGrid3D
This object expects that the 3D arrays are rectangular. You are encouraged to access the array directly. The object implements all of the Grid3D interface. See Grid3D 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 SparseGrid3D 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 SparseGrid3D instead.
Modifier and Type | Field and Description |
---|---|
Bag[][][] |
field |
static int |
INITIAL_BAG_SIZE
The size of an initial bag
|
static int |
LARGE_BAG_RATIO
A bag must be larger than its contents by this ratio to be replaced replaceLargeBags is true
|
static int |
MIN_BAG_SIZE
No bags smaller than this size will be replaced regardless of the setting of replaceLargeBags
|
boolean |
removeEmptyBags
Should we remove bags in the field if they have been emptied, and let them GC, or should
we keep them around?
|
boolean |
replaceLargeBags
When a bag drops to one quarter capacity, should we replace it with a new bag?
|
static int |
REPLACEMENT_BAG_RATIO
A bag to be replaced will be shrunk to this ratio if replaceLargeBags is true
|
height, length, width
Constructor and Description |
---|
DenseGrid3D(int width,
int height,
int length) |
Modifier and Type | Method and Description |
---|---|
void |
addObjectsToLocation(Bag objs,
Int3D location) |
void |
addObjectsToLocation(Bag objs,
int x,
int y,
int z)
Adds an object to a given location.
|
void |
addObjectsToLocation(java.util.Collection objs,
int x,
int y,
int z)
Adds an object to a given location.
|
void |
addObjectsToLocation(java.lang.Object[] objs,
Int3D location) |
void |
addObjectsToLocation(java.lang.Object[] objs,
int x,
int y,
int z)
Adds an object to a given location.
|
void |
addObjectToLocation(java.lang.Object obj,
Int3D location) |
void |
addObjectToLocation(java.lang.Object obj,
int x,
int y,
int z)
Adds an object to a given location.
|
Bag |
clear()
Sets all the locations in the grid to null, and returns in a Bag all stored objects
(including duplicates but not null values).
|
Bag |
getMooreNeighbors(int x,
int y,
int z,
int dist,
int mode,
boolean includeOrigin)
Determines all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y), abs(z-Z) ) <= dist.
|
Bag |
getMooreNeighbors(int x,
int y,
int z,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
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 z,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist.
|
void |
getNeighborsHamiltonianDistance(int x,
int y,
int z,
int dist,
boolean toroidal,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
Deprecated.
|
Bag |
getNeighborsMaxDistance(int x,
int y,
int z,
int dist,
boolean toroidal,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
Deprecated.
|
Bag |
getObjectsAtLocation(Int3D location)
Returns a bag containing all the objects at a given location, or null when there are no objects at the location.
|
Bag |
getObjectsAtLocation(int x,
int y,
int z)
Returns a bag containing all the objects at a given location, or null when there are no objects at the location.
|
Bag |
getRadialNeighbors(int x,
int y,
int z,
double dist,
int mode,
boolean includeOrigin) |
Bag |
getRadialNeighbors(int x,
int y,
int z,
double dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos) |
Bag |
getRadialNeighbors(int x,
int y,
int z,
double dist,
int mode,
boolean includeOrigin,
int measurementRule,
boolean closed,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos) |
Bag |
getRadialNeighborsAndLocations(int x,
int y,
int z,
double dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos) |
Bag |
getRadialNeighborsAndLocations(int x,
int y,
int z,
double dist,
int mode,
boolean includeOrigin,
int measurementRule,
boolean closed,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos) |
Bag |
getVonNeumannNeighbors(int x,
int y,
int z,
int dist,
int mode,
boolean includeOrigin)
Determines all neighbors of a location that satisfy abs(x-X) + abs(y-Y) + abs(z-Z) <= dist.
|
Bag |
getVonNeumannNeighbors(int x,
int y,
int z,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
|
Bag |
getVonNeumannNeighborsAndLocations(int x,
int y,
int z,
int dist,
int mode,
boolean includeOrigin,
Bag result,
IntBag xPos,
IntBag yPos,
IntBag zPos)
Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
|
boolean |
moveObject(java.lang.Object obj,
Int3D from,
Int3D to)
If the object is not at FROM, then it's simply inserted into TO, and FALSE is returned.
|
boolean |
moveObject(java.lang.Object obj,
int fromX,
int fromY,
int fromZ,
int toX,
int toY,
int toZ)
If the object is not at [fromX, fromY], then it's simply inserted into [toX, toY], and FALSE is returned.
|
void |
moveObjects(Int3D from,
Int3D to) |
void |
moveObjects(int fromX,
int fromY,
int fromZ,
int toX,
int toY,
int toZ) |
int |
numObjectsAtLocation(Int3D location) |
int |
numObjectsAtLocation(int x,
int y,
int z) |
void |
removeAll(java.lang.Object from)
Removes instances of the given value.
|
void |
removeAll(java.lang.Object from,
boolean onlyIfSameObject)
Removes instances of the given value.
|
boolean |
removeObjectAtLocation(java.lang.Object obj,
Int3D location) |
boolean |
removeObjectAtLocation(java.lang.Object obj,
int x,
int y,
int z) |
boolean |
removeObjectMultiplyAtLocation(java.lang.Object obj,
Int3D location) |
boolean |
removeObjectMultiplyAtLocation(java.lang.Object obj,
int x,
int y,
int z) |
Bag |
removeObjectsAtLocation(Int3D location)
Removes all the objects stored at the given location and returns them as a Bag (which you are free to modify).
|
Bag |
removeObjectsAtLocation(int x,
int y,
int z)
Removes all the objects stored at the given location and returns them as a Bag (which you are free to modify).
|
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,
int length)
Replaces the existing array with a new one of the given width and height,
and with arbitrary values stored.
|
void |
setObjectsAtLocation(int x,
int y,
int z,
Bag bag) |
buildMap, buildMap, checkBounds, getHeight, getLength, getMooreLocations, getNeighborsHamiltonianDistance, getNeighborsMaxDistance, getRadialLocations, getRadialLocations, getVonNeumannLocations, getWidth, isDistributed, removeOrigin, removeOriginToroidal, stx, sty, stz, stz, tx, ty, tz
public boolean removeEmptyBags
public boolean replaceLargeBags
public static final int INITIAL_BAG_SIZE
public static final int MIN_BAG_SIZE
public static final int LARGE_BAG_RATIO
public static final int REPLACEMENT_BAG_RATIO
public Bag[][][] field
protected void reshape(int width, int height, int length)
public Bag getObjectsAtLocation(int x, int y, int z)
public void setObjectsAtLocation(int x, int y, int z, Bag bag)
public Bag getObjectsAtLocation(Int3D location)
public Bag removeObjectsAtLocation(int x, int y, int z)
public Bag removeObjectsAtLocation(Int3D location)
public boolean removeObjectAtLocation(java.lang.Object obj, int x, int y, int z)
public boolean removeObjectAtLocation(java.lang.Object obj, Int3D location)
public boolean removeObjectMultiplyAtLocation(java.lang.Object obj, int x, int y, int z)
public boolean removeObjectMultiplyAtLocation(java.lang.Object obj, Int3D location)
public boolean moveObject(java.lang.Object obj, int fromX, int fromY, int fromZ, int toX, int toY, int toZ)
public boolean moveObject(java.lang.Object obj, Int3D from, Int3D to)
public void moveObjects(int fromX, int fromY, int fromZ, int toX, int toY, int toZ)
public int numObjectsAtLocation(int x, int y, int z)
public int numObjectsAtLocation(Int3D location)
public void addObjectToLocation(java.lang.Object obj, int x, int y, int z)
public void addObjectToLocation(java.lang.Object obj, Int3D location)
public void addObjectsToLocation(Bag objs, int x, int y, int z)
public void addObjectsToLocation(java.lang.Object[] objs, int x, int y, int z)
public void addObjectsToLocation(java.lang.Object[] objs, Int3D location)
public void addObjectsToLocation(java.util.Collection objs, int x, int y, int z)
public final Bag clear()
public final void removeAll(java.lang.Object from)
from
- any element that matches this value will be replacedto
- with this valuepublic final void removeAll(java.lang.Object from, boolean onlyIfSameObject)
from
- any element that matches this value will be replacedto
- with this valuepublic 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 z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
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 ? Grid3D.TOROIDAL : Grid3D.BOUNDED, true, result, xPos, yPos);
public Bag getMooreNeighbors(int x, int y, int z, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
Then places into the result Bag any Objects which fall on one of these This function may be run in one of three modes: Grid3D.BOUNDED, Grid3D.UNBOUNDED, and Grid3D.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,
SparseGrid3D permits this but ObjectGrid3D and DoubleGrid3D and IntGrid3D and DenseGrid3D 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 z, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
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: Grid3D.BOUNDED, Grid3D.UNBOUNDED, and Grid3D.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,
SparseGrid3D permits this but ObjectGrid3D and DoubleGrid3D and IntGrid3D and DenseGrid3D 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 void getNeighborsHamiltonianDistance(int x, int y, int z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
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 ? Grid3D.TOROIDAL : Grid3D.BOUNDED, true, result, xPos, yPos);
public Bag getVonNeumannNeighbors(int x, int y, int z, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
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: Grid3D.BOUNDED, Grid3D.UNBOUNDED, and Grid3D.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,
SparseGrid3D permits this but ObjectGrid3D and DoubleGrid3D and IntGrid3D and DenseGrid3D 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 z, int dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
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: Grid3D.BOUNDED, Grid3D.UNBOUNDED, and Grid3D.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,
SparseGrid3D permits this but ObjectGrid3D and DoubleGrid3D and IntGrid3D and DenseGrid3D 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, int z, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
public Bag getRadialNeighborsAndLocations(int x, int y, int z, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
public Bag getRadialNeighbors(int x, int y, int z, double dist, int mode, boolean includeOrigin, int measurementRule, boolean closed, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
public Bag getRadialNeighborsAndLocations(int x, int y, int z, double dist, int mode, boolean includeOrigin, int measurementRule, boolean closed, Bag result, IntBag xPos, IntBag yPos, IntBag zPos)
public Bag getMooreNeighbors(int x, int y, int z, 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 z, 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, int z, double dist, int mode, boolean includeOrigin)