prajna.util

Class RealGrid<C>

java.lang.Object

prajna.util.RealGrid<C>

Type Parameters:

C - The class representing the cells of the grid

All Implemented Interfaces:

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

public class RealGrid<C>
extends java.lang.Object
implements Grid<C>

Grid implementation which uses double values for its coordinates. The RealGrid supports interpolating values, and can find nearby values

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
RealGrid() Create a new RealGrid with the default dimension count.
RealGrid(int dimensionCount) Create a new RealGrid with the specified dimension count.

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	getNumValues() Get the number of non-null values that have been set in the grid
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

Methods inherited from class java.lang.Object

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

Constructor Detail

RealGrid

public RealGrid()

Create a new RealGrid with the default dimension count. The default dimension count is 3.

RealGrid

public RealGrid(int dimensionCount)

Create a new RealGrid with the specified dimension count.

Parameters:

dimensionCount - the number of dimensions for this grid

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

getNumValues

public int getNumValues()

Get the number of non-null values that have been set in the grid

Specified by:

getNumValues in interface Grid<C>

Returns:

the number of values.

isContinuous

public boolean isContinuous()

Return whether the grid values should be considered continuous. The RealGrid is a continuous grid.

Specified by:

isContinuous in interface Grid<C>

Returns:

true

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.