uk.ac.leeds.ccg.andyt.grids.core
Class Grid2DSquareCellIntChunkArray

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkAbstract
          uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkArray

All Implemented Interfaces:

java.io.Serializable

public class Grid2DSquareCellIntChunkArray
extends Grid2DSquareCellIntChunkAbstract
implements java.io.Serializable

TODO: docs

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

Grid2DSquareCellChunkAbstract.ChunkCellID

Field Summary

Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

chunkID, grid2DSquareCell

Constructor Summary

protected	Grid2DSquareCellIntChunkArray() Default constructor
protected	Grid2DSquareCellIntChunkArray(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk, Grid2DSquareCellAbstract.ChunkID chunkID) TODO: 1.
protected	Grid2DSquareCellIntChunkArray(Grid2DSquareCellInt grid2DSquareCellInt, Grid2DSquareCellAbstract.ChunkID chunkID) Creates a new Grid2DSquareCellInt grid containing all no data values.

Method Summary

void	clearData() Clears the data associated with this.
int	getCell(int chunkCellRowIndex, int chunkCellColIndex, int noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.
int[][]	getData() TODO: docs
protected void	initCell(int chunkCellRowIndex, int chunkCellColIndex, int valueToInitialise) Initialises the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex.
void	initData() Initialises the data associated with this.
AbstractIterator	iterator() Returns a Grid2DSquareCellIntChunkArrayIterator for iterating over the cells in this.
int	setCell(int chunkCellRowIndex, int chunkCellColIndex, int valueToSet, int noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex and sets it to valueToSet
java.lang.String	toString() Returns a description of this.

Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkAbstract

getArithmeticMeanDouble, getCellDouble, getGrid2DSquareCellInt, getMaxInt, getMedianDouble, getMinInt, getModeTIntHashSet, getNonNoDataValueCountBigInteger, getNonNoDataValueCountInt, getStandardDeviationDouble, getSumBigDecimal, initCells, sort1, toArrayIncludingNoDataValues, toArrayNotIncludingNoDataValues

Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

getChunkID, getGrid2DSquareCell, getName, inChunk, initChunkID, initGrid2DSquareCell

Methods inherited from class java.lang.Object

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

Constructor Detail

Grid2DSquareCellIntChunkArray

protected Grid2DSquareCellIntChunkArray()

Default constructor

Grid2DSquareCellIntChunkArray

protected Grid2DSquareCellIntChunkArray(Grid2DSquareCellInt grid2DSquareCellInt,
                                        Grid2DSquareCellAbstract.ChunkID chunkID)

Creates a new Grid2DSquareCellInt grid containing all no data values.

Parameters:

grid2DSquareCellInt -

chunkID -

Grid2DSquareCellIntChunkArray

protected Grid2DSquareCellIntChunkArray(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk,
                                        Grid2DSquareCellAbstract.ChunkID chunkID)

TODO: 1. docs 2. A fast toArray() method in Grid2DSquareCellIntChunkMap could be coded then a constructor based on an int[] or int[][] might be faster?

Method Detail

toString

public java.lang.String toString()

Returns a description of this.

Specified by:

toString in class Grid2DSquareCellChunkAbstract

initData

public void initData()

Initialises the data associated with this.

Specified by:

initData in class Grid2DSquareCellIntChunkAbstract

getData

public int[][] getData()

TODO: docs

clearData

public void clearData()

Clears the data associated with this.

Specified by:

clearData in class Grid2DSquareCellIntChunkAbstract

getCell

public int getCell(int chunkCellRowIndex,
                   int chunkCellColIndex,
                   int noDataValue)

Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.

Specified by:

getCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - the row index of the cell w.r.t. the origin of this chunk

chunkCellColIndex - the column index of the cell w.r.t. the origin of this chunk

noDataValue - the noDataValue of this.grid2DSquareCellInt

initCell

protected void initCell(int chunkCellRowIndex,
                        int chunkCellColIndex,
                        int valueToInitialise)

Initialises the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex. Utility method for constructor.

Specified by:

initCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - the row index of the cell w.r.t. the origin of this chunk

chunkCellColIndex - the column index of the cell w.r.t. the origin of this chunk

valueToInitialise - the value with which the cell is initialised

setCell

public int setCell(int chunkCellRowIndex,
                   int chunkCellColIndex,
                   int valueToSet,
                   int noDataValue)

Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex and sets it to valueToSet

Specified by:

setCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - the row index of the cell w.r.t. the origin of this chunk

chunkCellColIndex - the column index of the cell w.r.t. the origin of this chunk

valueToSet - the value the cell is to be set to

noDataValue - the noDataValue of this.grid2DSquareCellInt

iterator

public AbstractIterator iterator()

Returns a Grid2DSquareCellIntChunkArrayIterator for iterating over the cells in this.

Specified by:

iterator in class Grid2DSquareCellChunkAbstract