prajna.util

Class CellGrid<C>

java.lang.Object

prajna.util.CellGrid<C>

Type Parameters:

C - The class representing the cells of the grid

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<C>, Grid<C>

public class CellGrid<C>
extends java.lang.Object
implements Grid<C>, java.io.Serializable

Grid implementation using integral coordinates. The CellGrid uses integer coordinates for storing data. In addition to the standard Grid functionality, the CellGrid also provides an ordered iterator over all grid values which includes empty cells.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CellGrid() Instantiates a new grid.
CellGrid(int[] dimensionSizes) Instantiates a new grid with the specified dimension sizes.
CellGrid(int[] dimensionSizes, java.util.List<C> data) Instantiates a new grid with the specified dimension sizes.

Method Summary

Methods

Modifier and Type	Method and Description
C	get(double[] coords) Gets the cell at the specified coordinates.
C	get(int[] coords) Gets the cell at the specified coordinates.
java.util.Collection<C>	getAllValues() Return the collection of all values contained in the grid
double[]	getCoordRanges() Get the extent of the coordinate axes for all values within this grid.
java.util.Set<double[]>	getCoordsWithValues() Get the set of coordinates that have non-null values
int	getDimensionCount() Gets the dimension count.
int[]	getDimensionSizes() Gets the dimension sizes.
int	getNumValues() Get the number of cells filled.
boolean	isContinuous() Return whether the grid values should be considered continuous.
java.util.Iterator<C>	iterator() Get an iterator across the grid elements
C	set(double[] coords, C element) Sets the cell content at the specified coordinates
C	set(int[] coords, C element) Sets the cell content at the specified coordinates
void	setDimensionSizes(int[] sizes) Sets the dimension sizes.

Methods inherited from class java.lang.Object

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

Constructor Detail

CellGrid

public CellGrid()

Instantiates a new grid. By default, the grid is three-dimensional, with 10 cells in each dimension, for a total of 1000 cells.

CellGrid

public CellGrid(int[] dimensionSizes)

Instantiates a new grid with the specified dimension sizes. The dimensionality of the grid is determined by the number of dimension sizes.

Parameters:

dimensionSizes - the dimension sizes

CellGrid

public CellGrid(int[] dimensionSizes,
        java.util.List<C> data)

Instantiates a new grid with the specified dimension sizes. The dimensionality of the grid is determined by the number of dimension sizes. The grid data is initialized using the data array provided.

Parameters:

dimensionSizes - the dimension sizes

data - the initial data

Method Detail

get

public C get(double[] coords)

Gets the cell at the specified coordinates. The dimensionality of the coordinate array should be the same as the dimensionality of the grid. Otherwise an exception is thrown.

Specified by:

get in interface Grid<C>

Parameters:

coords - the coordinate for the desired cell

Returns:

the cell content

get

public C get(int[] coords)

Gets the cell at the specified coordinates. The dimensionality of the coordinate array should be the same as the dimensionality of the grid. Otherwise an exception is thrown.

Specified by:

get in interface Grid<C>

Parameters:

coords - the coordinate for the desired cell

Returns:

the cell content

getAllValues

public java.util.Collection<C> getAllValues()

Return the collection of all values contained in the grid

Specified by:

getAllValues in interface Grid<C>

Returns:

the collection of all values in the grid

getCoordRanges

public double[] getCoordRanges()

Get the extent of the coordinate axes for all values within this grid. This method returns the minimum and maximum values for each coordinate. It should only return coordinate ranges for the values that have been set.

Specified by:

getCoordRanges in interface Grid<C>

Returns:

an array of values indicating the coordinate extents. The array is twice the size of the dimension count, and contains values in the following order: minCoord1, maxCoord1, minCoord2, maxCoord2, etc.

getCoordsWithValues

public java.util.Set<double[]> getCoordsWithValues()

Get the set of coordinates that have non-null values

Specified by:

getCoordsWithValues in interface Grid<C>

Returns:

the set of coordinates that have non-null values

getDimensionCount

public int getDimensionCount()

Gets the dimension count.

Specified by:

getDimensionCount in interface Grid<C>

Returns:

the dimensionCount

getDimensionSizes

public int[] getDimensionSizes()

Gets the dimension sizes.

Returns:

the dimSizes

getNumValues

public int getNumValues()

Get the number of cells filled. This is the number of non-null cells in this Grid.

Specified by:

getNumValues in interface Grid<C>

Returns:

the number of filled cells.

isContinuous

public boolean isContinuous()

Return whether the grid values should be considered continuous. The CellGrid is a non-continuous grid.

Specified by:

isContinuous in interface Grid<C>

Returns:

false

iterator

public java.util.Iterator<C> iterator()

Get an iterator across the grid elements

Specified by:

iterator in interface java.lang.Iterable<C>

Returns:

an iterator across the elements of the grid

set

public C set(double[] coords,
    C element)

Sets the cell content at the specified coordinates

Specified by:

set in interface Grid<C>

Parameters:

coords - the coordinates

element - the data element.

Returns:

the previous element stored at that location, which may be null.

set

public C set(int[] coords,
    C element)

Sets the cell content at the specified coordinates

Specified by:

set in interface Grid<C>

Parameters:

coords - the coordinates

element - the data element.

Returns:

the previous element stored at that location, which may be null.

setDimensionSizes

public void setDimensionSizes(int[] sizes)

Sets the dimension sizes.

Parameters:

sizes - the new dimension sizes