sim.field.grid
Class DoubleGrid3D

java.lang.Object
  extended bysim.field.grid.AbstractGrid3D
      extended bysim.field.grid.DoubleGrid3D
All Implemented Interfaces:
Grid3D, java.io.Serializable

public class DoubleGrid3D
extends AbstractGrid3D

A wrapper for 3D arrays of doubles.

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 grids.

The width and height and length (z dimension) of the object are provided to avoid having to say field[x].length, etc.

See Also:
Serialized Form

Field Summary
 double[][][] field
           
 
Fields inherited from class sim.field.grid.AbstractGrid3D
height, length, width
 
Constructor Summary
DoubleGrid3D(DoubleGrid3D values)
           
DoubleGrid3D(int width, int height, int length)
           
DoubleGrid3D(int width, int height, int length, double initialValue)
           
 
Method Summary
 DoubleGrid3D add(double withThisMuch)
          Sets each value in the grid to that value added to withThisMuch Returns the modified grid.
 DoubleGrid3D add(DoubleGrid3D 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.
 DoubleGrid3D add(IntGrid3D 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.
 DoubleGrid3D ceiling()
          Sets each value in the grid to ceil(value).
 DoubleGrid3D floor()
          Sets each value in the grid to floor(value).
 double get(int x, int y, int z)
          Returns the element at location (x,y,z)
 DoubleBag getNeighborsHamiltonianDistance(int x, int y, int z, int dist, boolean toroidal, DoubleBag result, IntBag xPos, IntBag yPos, IntBag zPos)
          Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) + abs(z-Z) <= dist.
 DoubleBag getNeighborsMaxDistance(int x, int y, int z, int dist, boolean toroidal, DoubleBag result, IntBag xPos, IntBag yPos, IntBag zPos)
          Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y), abs(z-Z) ) <= dist.
 DoubleGrid3D lowerBound(double toNoLowerThanThisMuch)
          Thresholds the grid so that values smaller than toNoLowerThanThisMuch are changed to toNoLowerThanThisMuch Returns the modified grid.
 double max()
          Returns the maximum value stored in the grid
 double mean()
          Returns the mean value stored in the grid
 double min()
          Returns the minimum value stored in the grid
 DoubleGrid3D multiply(double byThisMuch)
          Sets each value in the grid to that value multiplied byThisMuch Returns the modified grid.
 DoubleGrid3D multiply(DoubleGrid3D 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.
 DoubleGrid3D multiply(IntGrid3D 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.
 DoubleGrid3D rint()
          Sets each value in the grid to rint(value).
 double set(int x, int y, int z, double val)
          Sets location (x,y,z) to val
 DoubleGrid3D setTo(double thisMuch)
          Sets all the locations in the grid the provided element
 DoubleGrid3D setTo(DoubleGrid3D 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.
 DoubleGrid3D truncate()
          Eliminates the decimal portion of each value in the grid (rounds towards zero).
 DoubleGrid3D upperBound(double toNoMoreThanThisMuch)
          Thresholds the grid so that values greater to toNoMoreThanThisMuch are changed to toNoMoreThanThisMuch.
 
Methods inherited from class sim.field.grid.AbstractGrid3D
getHeight, getLength, getNeighborsHamiltonianDistance, getNeighborsMaxDistance, getWidth, stx, sty, stz, tx, ty, tz
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

field

public double[][][] field
Constructor Detail

DoubleGrid3D

public DoubleGrid3D(int width,
                    int height,
                    int length)

DoubleGrid3D

public DoubleGrid3D(int width,
                    int height,
                    int length,
                    double initialValue)

DoubleGrid3D

public DoubleGrid3D(DoubleGrid3D values)
Method Detail

set

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


get

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


max

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


min

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


mean

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


setTo

public final DoubleGrid3D setTo(double thisMuch)
Sets all the locations in the grid the provided element


setTo

public final DoubleGrid3D setTo(DoubleGrid3D 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.


upperBound

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


lowerBound

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


add

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


add

public final DoubleGrid3D add(IntGrid3D 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.


add

public final DoubleGrid3D add(DoubleGrid3D 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 DoubleGrid3D multiply(double byThisMuch)
Sets each value in the grid to that value multiplied byThisMuch Returns the modified grid.


multiply

public final DoubleGrid3D multiply(IntGrid3D 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.


multiply

public final DoubleGrid3D multiply(DoubleGrid3D 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.


floor

public final DoubleGrid3D floor()
Sets each value in the grid to floor(value). Returns the modified grid.


ceiling

public final DoubleGrid3D ceiling()
Sets each value in the grid to ceil(value). Returns the modified grid.


truncate

public final DoubleGrid3D truncate()
Eliminates the decimal portion of each value in the grid (rounds towards zero). Returns the modified grid.


rint

public final DoubleGrid3D rint()
Sets each value in the grid to rint(value). That is, each value is rounded to the closest integer value. If two integers are the same distance, the value is rounded to the even integer. Returns the modified grid.


getNeighborsMaxDistance

public final DoubleBag getNeighborsMaxDistance(int x,
                                               int y,
                                               int z,
                                               int dist,
                                               boolean toroidal,
                                               DoubleBag result,
                                               IntBag xPos,
                                               IntBag yPos,
                                               IntBag zPos)
Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y), abs(z-Z) ) <= dist. This region forms a cube 2*dist+1 cells across, centered at (X,Y,Z). If dist==1, this is equivalent to the twenty-six neighbors surrounding (X,Y,Z), plus (X,Y) itself. Places each x, y, and z value of these locations in the provided IntBags xPos, yPos, and zPos, clearing the bags first. Then places into the result DoubleBag the elements at each of those locations clearning it first. Returns the result DoubleBag (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 DoubleBag getNeighborsHamiltonianDistance(int x,
                                                       int y,
                                                       int z,
                                                       int dist,
                                                       boolean toroidal,
                                                       DoubleBag result,
                                                       IntBag xPos,
                                                       IntBag yPos,
                                                       IntBag zPos)
Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) + abs(z-Z) <= dist. This region forms an octohedron 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y,Y). If dist==1 this is equivalent to the six neighbors above, below, left, and right, front, and behind (X,Y,Z)), plus (X,Y,Z) itself. Places each x, y, and z value of these locations in the provided IntBags xPos, yPos, and zPos, clearing the bags first. Then places into the result DoubleBag the elements at each of those locations clearning it first. Returns the result DoubleBag (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.