public class IntGrid2D 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.
Modifier and Type  Field and Description 

int[][] 
field 
height, width
Constructor and Description 

IntGrid2D(int[][] values) 
IntGrid2D(IntGrid2D values) 
IntGrid2D(int width,
int height) 
IntGrid2D(int width,
int height,
int initialValue) 
Modifier and Type  Method and Description 

IntGrid2D 
add(int withThisMuch)
Sets each value in the grid to that value added to withThisMuch
Returns the modified grid.

IntGrid2D 
add(IntGrid2D withThis)
Sets the value at each location in the grid to that value added to the value at the equivalent location in the provided grid.

int 
get(int x,
int y)
Returns the element at location (x,y)

IntBag 
getHexagonalNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
IntBag 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.

IntBag 
getMooreNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
IntBag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy max( abs(xX) , abs(yY) ) <= dist, This region forms a
square 2*dist+1 cells across, centered at (X,Y).

void 
getNeighborsHamiltonianDistance(int x,
int y,
int dist,
boolean toroidal,
IntBag result,
IntBag xPos,
IntBag yPos)
Deprecated.

void 
getNeighborsHexagonalDistance(int x,
int y,
int dist,
boolean toroidal,
IntBag result,
IntBag xPos,
IntBag yPos)
Deprecated.

void 
getNeighborsMaxDistance(int x,
int y,
int dist,
boolean toroidal,
IntBag result,
IntBag xPos,
IntBag yPos)
Deprecated.

IntBag 
getRadialNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
IntBag result,
IntBag xPos,
IntBag yPos) 
IntBag 
getRadialNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
int measurementRule,
boolean closed,
IntBag result,
IntBag xPos,
IntBag yPos) 
IntBag 
getVonNeumannNeighbors(int x,
int y,
int dist,
int mode,
boolean includeOrigin,
IntBag result,
IntBag xPos,
IntBag yPos)
Gets all neighbors of a location that satisfy abs(xX) + abs(yY) <= dist.

IntGrid2D 
lowerBound(int toNoLowerThanThisMuch)
Thresholds the grid so that values smaller than toNoLowerThanThisMuch are changed to toNoLowerThanThisMuch
Returns the modified grid.

int 
max()
Returns the maximum value stored in the grid

double 
mean()
Returns the mean value stored in the grid

int 
min()
Returns the minimum value stored in the grid

IntGrid2D 
multiply(int byThisMuch)
Sets each value in the grid to that value multiplied byThisMuch
Returns the modified grid.

IntGrid2D 
multiply(IntGrid2D withThis)
Sets the value at each location in the grid to that value multiplied by to the value at the equivalent location in the provided grid.

void 
replaceAll(int from,
int to)
Replace instances of one value to another.

void 
set(int x,
int y,
int val)
Sets location (x,y) to val

IntGrid2D 
setTo(int thisMuch)
Sets all the locations in the grid the provided element

IntGrid2D 
setTo(int[][] field)
Sets the grid to a copy of the provided array, which must be rectangular.

IntGrid2D 
setTo(IntGrid2D 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.

int[] 
toArray()
Flattens the grid to a onedimensional array, storing the elements in rowmajor order,including duplicates and null values.

IntGrid2D 
upperBound(int toNoMoreThanThisMuch)
Thresholds the grid so that values greater to toNoMoreThanThisMuch are changed to toNoMoreThanThisMuch.

buildMap, buildMap, checkBounds, dlx, dly, downx, downy, drx, dry, getHeight, getHexagonalLocations, getMooreLocations, getNeighborsHamiltonianDistance, getNeighborsHexagonalDistance, getNeighborsMaxDistance, getRadialLocations, getRadialLocations, getVonNeumannLocations, getWidth, removeOrigin, removeOriginToroidal, stx, sty, trb, trt, tx, ty, ulx, uly, upx, upy, urx, ury
public IntGrid2D(int width, int height)
public IntGrid2D(int width, int height, int initialValue)
public IntGrid2D(IntGrid2D values)
public IntGrid2D(int[][] values)
public final void set(int x, int y, int val)
public final int get(int x, int y)
public final IntGrid2D setTo(int thisMuch)
public IntGrid2D setTo(int[][] field)
public final IntGrid2D setTo(IntGrid2D values)
public final int[] toArray()
public final int max()
public final int min()
public final double mean()
public final IntGrid2D upperBound(int toNoMoreThanThisMuch)
public final IntGrid2D lowerBound(int toNoLowerThanThisMuch)
public final IntGrid2D add(int withThisMuch)
public final IntGrid2D add(IntGrid2D withThis)
public final IntGrid2D multiply(int byThisMuch)
public final IntGrid2D multiply(IntGrid2D withThis)
public final void replaceAll(int from, int to)
from
 any element that matches this value will be replacedto
 with this valuepublic void getNeighborsMaxDistance(int x, int y, int dist, boolean toroidal, IntBag result, IntBag xPos, IntBag yPos)
Then places into the result IntBag 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, wraparound, 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 IntBag getMooreNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, IntBag result, IntBag xPos, IntBag yPos)
Then places into the result IntBag 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, wraparound, 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 dist, boolean toroidal, IntBag 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 IntBag 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, wraparound, 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 IntBag getVonNeumannNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, IntBag 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 IntBag 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, wraparound, 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 getNeighborsHexagonalDistance(int x, int y, int dist, boolean toroidal, IntBag 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 IntBag 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, wraparound, 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 IntBag getHexagonalNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, IntBag 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 IntBag 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, wraparound, 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 IntBag getRadialNeighbors(int x, int y, int dist, int mode, boolean includeOrigin, IntBag result, IntBag xPos, IntBag yPos)