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
 
Constructor Summary
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 getNeighborsHamiltonianDistance(int x, int y, int dist, boolean toroidal, IntBag result, IntBag xPos, IntBag yPos)
          Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
 IntBag getNeighborsHexagonalDistance(int x, int y, int dist, boolean toroidal, 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 getNeighborsMaxDistance(int x, int y, int dist, boolean toroidal, IntBag result, IntBag xPos, IntBag yPos)
          Gets all neighbors of a location that satisfy max( 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(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.
 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
dlx, dly, downx, downy, drx, dry, getHeight, getNeighborsHamiltonianDistance, getNeighborsHexagonalDistance, getNeighborsMaxDistance, getWidth, 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)
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 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.


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 final IntBag getNeighborsMaxDistance(int x,
                                            int y,
                                            int dist,
                                            boolean toroidal,
                                            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 the elements at each of those 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.


getNeighborsHamiltonianDistance

public final IntBag getNeighborsHamiltonianDistance(int x,
                                                    int y,
                                                    int dist,
                                                    boolean toroidal,
                                                    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 the elements at each of those 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.


getNeighborsHexagonalDistance

public final IntBag getNeighborsHexagonalDistance(int x,
                                                  int y,
                                                  int dist,
                                                  boolean toroidal,
                                                  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 the elements at each of those 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.