|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsim.field.grid.AbstractGrid3D
sim.field.grid.DoubleGrid3D
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.
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 |
public double[][][] field
Constructor Detail |
public DoubleGrid3D(int width, int height, int length)
public DoubleGrid3D(int width, int height, int length, double initialValue)
public DoubleGrid3D(DoubleGrid3D values)
Method Detail |
public final double set(int x, int y, int z, double val)
public final double get(int x, int y, int z)
public final double max()
public final double min()
public final double mean()
public final DoubleGrid3D setTo(double thisMuch)
public final DoubleGrid3D setTo(DoubleGrid3D values)
public final DoubleGrid3D upperBound(double toNoMoreThanThisMuch)
public final DoubleGrid3D lowerBound(double toNoLowerThanThisMuch)
public final DoubleGrid3D add(double withThisMuch)
public final DoubleGrid3D add(IntGrid3D withThis)
public final DoubleGrid3D add(DoubleGrid3D withThis)
public final DoubleGrid3D multiply(double byThisMuch)
public final DoubleGrid3D multiply(IntGrid3D withThis)
public final DoubleGrid3D multiply(DoubleGrid3D withThis)
public final DoubleGrid3D floor()
public final DoubleGrid3D ceiling()
public final DoubleGrid3D truncate()
public final DoubleGrid3D rint()
public final DoubleBag getNeighborsMaxDistance(int x, int y, int z, int dist, boolean toroidal, DoubleBag result, IntBag xPos, IntBag yPos, IntBag zPos)
public final DoubleBag getNeighborsHamiltonianDistance(int x, int y, int z, int dist, boolean toroidal, DoubleBag result, IntBag xPos, IntBag yPos, IntBag zPos)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |