Class DenseGrid3D
- All Implemented Interfaces:
Serializable
,Grid3D
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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionBag[][][]
static final int
The size of an initial bagstatic final int
A bag must be larger than its contents by this ratio to be replaced replaceLargeBags is truestatic final int
No bags smaller than this size will be replaced regardless of the setting of replaceLargeBagsboolean
Should we remove bags in the field if they have been emptied, and let them GC, or should we keep them around?boolean
When a bag drops to one quarter capacity, should we replace it with a new bag?static final int
A bag to be replaced will be shrunk to this ratio if replaceLargeBags is trueFields inherited from class sim.field.grid.AbstractGrid3D
height, length, width
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addObjectsToLocation
(Object[] objs, int x, int y, int z) Adds an object to a given location.void
addObjectsToLocation
(Object[] objs, Int3D location) void
addObjectsToLocation
(Collection objs, int x, int y, int z) Adds an object to a given location.void
addObjectsToLocation
(Bag objs, int x, int y, int z) Adds an object to a given location.void
addObjectsToLocation
(Bag objs, Int3D location) void
addObjectToLocation
(Object obj, int x, int y, int z) Adds an object to a given location.void
addObjectToLocation
(Object obj, Int3D location) final 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).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) ) invalid input: '<'= dist.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) ) invalid input: '<'= dist, This region forms a square 2*dist+1 cells across, centered at (X,Y).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) ) invalid input: '<'= dist.void
getNeighborsHamiltonianDistance
(int x, int y, int z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) Deprecated.getNeighborsMaxDistance
(int x, int y, int z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) Deprecated.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.getObjectsAtLocation
(Int3D location) Returns a bag containing all the objects at a given location, or null when there are no objects at the location.getRadialNeighbors
(int x, int y, int z, double dist, int mode, boolean includeOrigin) 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) getRadialNeighbors
(int x, int y, int z, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) 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) getRadialNeighborsAndLocations
(int x, int y, int z, double dist, int mode, boolean includeOrigin, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) 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) invalid input: '<'= dist.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) invalid input: '<'= dist.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) invalid input: '<'= dist.boolean
moveObject
(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.boolean
moveObject
(Object obj, Int3D from, Int3D to) If the object is not at FROM, then it's simply inserted into TO, and FALSE is returned.void
moveObjects
(int fromX, int fromY, int fromZ, int toX, int toY, int toZ) void
moveObjects
(Int3D from, Int3D to) int
numObjectsAtLocation
(int x, int y, int z) int
numObjectsAtLocation
(Int3D location) final void
Removes instances of the given value.final void
Removes instances of the given value.boolean
removeObjectAtLocation
(Object obj, int x, int y, int z) boolean
removeObjectAtLocation
(Object obj, Int3D location) boolean
removeObjectMultiplyAtLocation
(Object obj, int x, int y, int z) boolean
removeObjectMultiplyAtLocation
(Object obj, Int3D location) 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).removeObjectsAtLocation
(Int3D location) Removes all the objects stored at the given location and returns them as a Bag (which you are free to modify).final void
replaceAll
(Object from, Object to) Replace instances of one value to another.final void
replaceAll
(Object from, 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) Methods inherited from class sim.field.grid.AbstractGrid3D
buildMap, buildMap, checkBounds, getHeight, getLength, getMooreLocations, getNeighborsHamiltonianDistance, getNeighborsMaxDistance, getRadialLocations, getRadialLocations, getVonNeumannLocations, getWidth, isDistributed, removeOrigin, removeOriginToroidal, stx, sty, stz, stz, tx, ty, tz
-
Field Details
-
removeEmptyBags
public boolean removeEmptyBagsShould we remove bags in the field if they have been emptied, and let them GC, or should we keep them around? -
replaceLargeBags
public boolean replaceLargeBagsWhen a bag drops to one quarter capacity, should we replace it with a new bag? -
INITIAL_BAG_SIZE
public static final int INITIAL_BAG_SIZEThe size of an initial bag- See Also:
-
MIN_BAG_SIZE
public static final int MIN_BAG_SIZENo bags smaller than this size will be replaced regardless of the setting of replaceLargeBags- See Also:
-
LARGE_BAG_RATIO
public static final int LARGE_BAG_RATIOA bag must be larger than its contents by this ratio to be replaced replaceLargeBags is true- See Also:
-
REPLACEMENT_BAG_RATIO
public static final int REPLACEMENT_BAG_RATIOA bag to be replaced will be shrunk to this ratio if replaceLargeBags is true- See Also:
-
field
-
-
Constructor Details
-
DenseGrid3D
public DenseGrid3D(int width, int height, int length)
-
-
Method Details
-
reshape
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. -
getObjectsAtLocation
Returns a bag containing all the objects at a given location, or null when there are no objects at the location. You should NOT MODIFY THIS BAG. This is the actual container bag, and modifying it will almost certainly break the Dense Field object. If you want to modify the bag, make a copy and modify the copy instead, using something along the lines of new Bag(foo.getObjectsAtLocation(location)) . Furthermore, changing values in the Dense Field may result in a different bag being used -- so you should not rely on this bag staying valid. -
setObjectsAtLocation
-
getObjectsAtLocation
Returns a bag containing all the objects at a given location, or null when there are no objects at the location. You should NOT MODIFY THIS BAG. This is the actual container bag, and modifying it will almost certainly break the Dense Field object. If you want to modify the bag, make a copy and modify the copy instead, using something along the lines of new Bag(foo.getObjectsAtLocation(location)) . Furthermore, changing values in the Dense Field may result in a different bag being used -- so you should not rely on this bag staying valid. -
removeObjectsAtLocation
Removes all the objects stored at the given location and returns them as a Bag (which you are free to modify). The location is set to null (the bag is removed) regardless of the setting of removeEmptyBags. -
removeObjectsAtLocation
Removes all the objects stored at the given location and returns them as a Bag (which you are free to modify). The location is set to null (the bag is removed) regardless of the setting of removeEmptyBags. -
removeObjectAtLocation
-
removeObjectAtLocation
-
removeObjectMultiplyAtLocation
-
removeObjectMultiplyAtLocation
-
moveObject
If the object is not at [fromX, fromY], then it's simply inserted into [toX, toY], and FALSE is returned. Else it is removed ONCE from [fromX, fromY] and inserted into [toX, toY] and TRUE is returned. If the object exists multiply at [fromX, fromY], only one instance of the object is moved. -
moveObject
If the object is not at FROM, then it's simply inserted into TO, and FALSE is returned. Else it is removed ONCE from FROM and inserted into TO and TRUE is returned. If the object exists multiply at FROM, only one instance of the object is moved. -
moveObjects
public void moveObjects(int fromX, int fromY, int fromZ, int toX, int toY, int toZ) -
moveObjects
-
numObjectsAtLocation
public int numObjectsAtLocation(int x, int y, int z) -
numObjectsAtLocation
-
addObjectToLocation
Adds an object to a given location. -
addObjectToLocation
-
addObjectsToLocation
Adds an object to a given location. -
addObjectsToLocation
-
addObjectsToLocation
Adds an object to a given location. -
addObjectsToLocation
-
addObjectsToLocation
Adds an object to a given location. -
clear
Sets all the locations in the grid to null, and returns in a Bag all stored objects (including duplicates but not null values). You are free to modify the Bag. -
removeAll
Removes instances of the given value. Equality is measured using equals(...). null is considered equal to null. This is equivalent to calling replaceAll(from, to, false)- Parameters:
from
- any element that matches this value will be replacedto
- with this value
-
removeAll
Removes instances of the given value. Equality is measured as follows. (1) if onlyIfSameObject is true, then objects must be "== from" to one another to be considered equal. (2) if onlyIfSameObject is false, then objects in the field must be "equals(from)". In either case, null is considered equal to null.- Parameters:
from
- any element that matches this value will be replacedto
- with this value
-
replaceAll
Replace instances of one value to another. Equality is measured using equals(...). null is considered equal to null. This is equivalent to calling replaceAll(from, to, false)- Parameters:
from
- any element that matches this value will be replacedto
- with this value
-
replaceAll
Replace instances of one value to another. Equality is measured as follows. (1) if onlyIfSameObject is true, then objects must be "== from" to one another to be considered equal. (2) if onlyIfSameObject is false, then objects in the field must be "equals(from)". In either case, null is considered equal to null.- Parameters:
from
- any element that matches this value will be replacedto
- with this value
-
getNeighborsMaxDistance
public Bag getNeighborsMaxDistance(int x, int y, int z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) Deprecated.Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) invalid input: '<'= dist, This region forms a square 2*dist+1 cells across, centered at (X,Y). If dist==1, this is equivalent to the so-called "Moore Neighborhood" (the eight neighbors surrounding (X,Y)), plus (X,Y) itself. 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 invalid input: '<'x,y> locations, clearning it first. Note that the order and size of the result Bag may not correspond to the X and Y bags. If you want all three bags to correspond (x, y, object) then use getNeighborsAndCorrespondingPositionsMaxDistance(...) Returns the result Bag. null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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);
-
getMooreNeighbors
public 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) ) invalid input: '<'= dist, This region forms a square 2*dist+1 cells across, centered at (X,Y). If dist==1, this is equivalent to the so-called "Moore Neighborhood" (the eight neighbors surrounding (X,Y)), plus (X,Y) itself. 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 invalid input: '<'x,y> locations, clearning it first. Note that the order and size of the result Bag may not correspond to the X and Y bags. If you want all three bags to correspond (x, y, object) then use getNeighborsAndCorrespondingPositionsMaxDistance(...) Returns the result Bag. null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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.
-
getMooreNeighborsAndLocations
public 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) ) invalid input: '<'= dist. This region forms a square 2*dist+1 cells across, centered at (X,Y). If dist==1, this is equivalent to the so-called "Moore Neighborhood" (the eight neighbors surrounding (X,Y)), plus (X,Y) itself.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 invalid input: '<'X,Y> positions may not appear and that others may appear multiply if multiple objects share that positions. Compare this function with getNeighborsMaxDistance(...). Returns the result Bag. null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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.
-
getNeighborsHamiltonianDistance
public void getNeighborsHamiltonianDistance(int x, int y, int z, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos, IntBag zPos) Deprecated.Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) invalid input: '<'= dist. This region forms a diamond 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y). If dist==1 this is equivalent to the so-called "Von-Neumann Neighborhood" (the four neighbors above, below, left, and right of (X,Y)), plus (X,Y) itself.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 invalid input: '<'x,y> locations, clearning it first. Note that the order and size of the result Bag may not correspond to the X and Y bags. If you want all three bags to correspond (x, y, object) then use getNeighborsAndCorrespondingPositionsHamiltonianDistance(...) Returns the result Bag (constructing one if null had been passed in). null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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);
-
getVonNeumannNeighbors
public 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) invalid input: '<'= dist. This region forms a diamond 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y). If dist==1 this is equivalent to the so-called "Von-Neumann Neighborhood" (the four neighbors above, below, left, and right of (X,Y)), plus (X,Y) itself.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 invalid input: '<'x,y> locations, clearning it first. Note that the order and size of the result Bag may not correspond to the X and Y bags. If you want all three bags to correspond (x, y, object) then use getNeighborsAndCorrespondingPositionsHamiltonianDistance(...) Returns the result Bag (constructing one if null had been passed in). null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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.
-
getVonNeumannNeighborsAndLocations
public 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) invalid input: '<'= dist. This region forms a diamond 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y). If dist==1 this is equivalent to the so-called "Von-Neumann Neighborhood" (the four neighbors above, below, left, and right of (X,Y)), plus (X,Y) itself.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 invalid input: '<'X,Y> positions may not appear and that others may appear multiply if multiple objects share that positions. Compare this function with getNeighborsMaxDistance(...). Returns the result Bag. null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.
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.
-
getRadialNeighbors
-
getRadialNeighborsAndLocations
-
getRadialNeighbors
-
getRadialNeighborsAndLocations
-
getMooreNeighbors
Determines all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y), abs(z-Z) ) invalid input: '<'= dist. This region forms a square 2*dist+1 cells across, centered at (X,Y,Z). If dist==1, this is equivalent to the so-called "Moore Neighborhood" (the eight neighbors surrounding (X,Y,Z)), plus (X,Y,Z) itself.Then returns, as a Bag, any Objects which fall on one of these invalid input: '<'x,y,z> locations.
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.
-
getVonNeumannNeighbors
Determines all neighbors of a location that satisfy abs(x-X) + abs(y-Y) + abs(z-Z) invalid input: '<'= dist. This region forms a diamond 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y,Z). If dist==1 this is equivalent to the so-called "Von-Neumann Neighborhood" (the four neighbors above, below, left, and right of (X,Y,Z)), plus (X,Y,Z) itself.Then returns, as a Bag, any Objects which fall on one of these invalid input: '<'x,y,z> locations.
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.
-
getRadialNeighbors
-