sim.field.grid

Class BooleanGrid2D

java.lang.Object

sim.field.grid.AbstractGrid2D

sim.field.grid.BooleanGrid2D

All Implemented Interfaces:

Serializable, Grid2D

public class BooleanGrid2D
extends AbstractGrid2D

Class for storing boolean values over a two-dimensional grid. Very space efficient by using a BitSet, i.e. each location is only one bit in size.

See Also:

Serialized Form

Field Summary

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

Constructors

Constructor and Description
BooleanGrid2D(boolean[][] values) Constructs new boolean grid by copying values from given field.
BooleanGrid2D(BooleanGrid2D other) Constructs new boolean grid by copying values from other boolean grid.
BooleanGrid2D(int width, int height) Constructs new boolean grid.

Method Summary

Modifier and Type	Method and Description
boolean	get(int x, int y) Gets the value at given coordinate.
void	set(int x, int y, boolean value) Sets the value at given coordinate.
BooleanGrid2D	setTo(boolean value) Sets all the locations in the grid to the provided value.
BooleanGrid2D	setTo(boolean[][] field) Sets this grid to the values from the given array.
boolean[][]	toField() Converts this grid to a two-dimensional array.
String	toString()

Methods inherited from class sim.field.grid.AbstractGrid2D

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BooleanGrid2D

public BooleanGrid2D(int width,
                     int height)

Constructs new boolean grid.

Parameters:

width -

height -

BooleanGrid2D

public BooleanGrid2D(BooleanGrid2D other)

Constructs new boolean grid by copying values from other boolean grid.

Parameters:

other -

BooleanGrid2D

public BooleanGrid2D(boolean[][] values)

Constructs new boolean grid by copying values from given field.

Parameters:

values - the values for this grid

Method Detail

get

public boolean get(int x,
                   int y)

Gets the value at given coordinate.

Parameters:

x - the x-coordinate

y - the y-coordinate

Returns:

the value at given coordinate

set

public void set(int x,
                int y,
                boolean value)

Sets the value at given coordinate.

Parameters:

x - the x-coordinate

y - the y-coordinate

value - the value to be set at given coordinate

setTo

public BooleanGrid2D setTo(boolean value)

Sets all the locations in the grid to the provided value.

Parameters:

value - the value to set

Returns:

this object

setTo

public BooleanGrid2D setTo(boolean[][] field)

Sets this grid to the values from the given array.

Parameters:

field - a two-dimensional array

Returns:

this object

toField

public boolean[][] toField()

Converts this grid to a two-dimensional array.

Returns:

a two-dimensional array with values from this grid

toString

public String toString()

Overrides:

toString in class Object