sim.field.grid
Class IntGrid2D

java.lang.Object
  extended by sim.field.grid.AbstractGrid2D
      extended by sim.field.grid.IntGrid2D
All Implemented Interfaces:
java.io.Serializable, Grid2D

public class IntGrid2D
extends AbstractGrid2D

A wrapper for 2D arrays of ints.

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.

See Also:
Serialized Form

Field Summary
 int[][] field
           
 
Fields inherited from class sim.field.grid.AbstractGrid2D
height, width
 
Fields inherited from interface sim.field.grid.Grid2D
ALL, ANY, ANY_SIZE, BOUNDED, CENTER, TOROIDAL, UNBOUNDED
 
Constructor Summary
IntGrid2D(int[][] values)
           
IntGrid2D(IntGrid2D values)
           
IntGrid2D(int width, int height)
           
IntGrid2D(int width, int height, int initialValue)
           
 
Method Summary
 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(x-X) , abs(y-Y) ) <= 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(x-X) + abs(y-Y) <= 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 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 one-dimensional array, storing the elements in row-major order,including duplicates and null values.
 IntGrid2D upperBound(int toNoMoreThanThisMuch)
          Thresholds the grid so that values greater to toNoMoreThanThisMuch are changed to toNoMoreThanThisMuch.
 
Methods inherited from class sim.field.grid.AbstractGrid2D
buildMap, buildMap, 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

field

public int[][] field
Constructor Detail

IntGrid2D

public IntGrid2D(int width,
                 int height)

IntGrid2D

public IntGrid2D(int width,
                 int height,
                 int initialValue)

IntGrid2D

public IntGrid2D(IntGrid2D values)

IntGrid2D

public IntGrid2D(int[][] values)
Method Detail

set

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


get

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


setTo

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


setTo

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


setTo

public final 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.


toArray

public final int[] toArray()
Flattens the grid to a one-dimensional array, storing the elements in row-major order,including duplicates and null values. Returns the grid.


max

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


min

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


mean

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


upperBound

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


lowerBound

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


add

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


add

public final 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. Returns the modified grid.


multiply

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


multiply

public final 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. Returns the modified grid.


getNeighborsMaxDistance

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

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). 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag. 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 ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);


getMooreNeighbors

public 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(x-X) , abs(y-Y) ) <= 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag. 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: 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.


getNeighborsHamiltonianDistance

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

Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag (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 ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);


getVonNeumannNeighbors

public 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(x-X) + abs(y-Y) <= 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag (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: 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.


getNeighborsHexagonalDistance

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

Gets all neighbors located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point inclusive. If dist==1, this is equivalent to the six neighbors immediately 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag (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: getNeighborsHexagonalDistance(x,y,dist,toroidal ? Grid2D.TOROIDAL : Grid2D.BOUNDED, true, result, xPos, yPos);


getHexagonalNeighbors

public 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. If dist==1, this is equivalent to the six neighbors immediately 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 IntBag any Objects which fall on one of these locations, clearning it first. Returns the result IntBag (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: 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.


getRadialNeighbors

public IntBag getRadialNeighbors(int x,
                                 int y,
                                 int dist,
                                 int mode,
                                 boolean includeOrigin,
                                 IntBag result,
                                 IntBag xPos,
                                 IntBag yPos)

getRadialNeighbors

public IntBag getRadialNeighbors(int x,
                                 int y,
                                 int dist,
                                 int mode,
                                 boolean includeOrigin,
                                 int measurementRule,
                                 boolean closed,
                                 IntBag result,
                                 IntBag xPos,
                                 IntBag yPos)