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

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkAbstract
          uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkArray

All Implemented Interfaces:

java.io.Serializable

public class Grid2DSquareCellDoubleChunkArray
extends Grid2DSquareCellDoubleChunkAbstract
implements java.io.Serializable

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	Grid2DSquareCellDoubleChunkArray() Default constructor
protected	Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk, Grid2DSquareCellAbstract.ChunkID chunkID) TODO: 1.
protected	Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDouble grid2DSquareCellDouble, Grid2DSquareCellAbstract.ChunkID chunkID) Creates a new Grid2DSquareCellDouble grid containing all no data values.

Method Summary

void	clearData() Clears the data associated with this.
double	getCell(int chunkCellRowIndex, int chunkCellColIndex, double noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.
double[][]	getData() TODO: docs
protected void	initCell(int chunkCellRowIndex, int chunkCellColIndex, double 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 Grid2DSquareCellDoubleChunkArrayIterator for iterating over the cells in this.
double	setCell(int chunkCellRowIndex, int chunkCellColIndex, double valueToSet, double 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.Grid2DSquareCellDoubleChunkAbstract

getArithmeticMeanBigDecimal, getArithmeticMeanDouble, getCellBigDecimal, getGrid2DSquareCellDouble, getMaxDouble, getMedianDouble, getMinDouble, getModeTDoubleHashSet, 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

Grid2DSquareCellDoubleChunkArray

protected Grid2DSquareCellDoubleChunkArray()

Default constructor

Grid2DSquareCellDoubleChunkArray

protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDouble grid2DSquareCellDouble,
                                           Grid2DSquareCellAbstract.ChunkID chunkID)

Creates a new Grid2DSquareCellDouble grid containing all no data values.

Parameters:

grid2DSquareCellDouble -

chunkID -

Grid2DSquareCellDoubleChunkArray

protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk,
                                           Grid2DSquareCellAbstract.ChunkID chunkID)

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

Parameters:

grid2DSquareCellDoubleChunk -

chunkID -

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 Grid2DSquareCellDoubleChunkAbstract

getData

public double[][] getData()

TODO: docs

clearData

public void clearData()

Clears the data associated with this.

Specified by:

clearData in class Grid2DSquareCellDoubleChunkAbstract

getCell

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

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

Specified by:

getCell in class Grid2DSquareCellDoubleChunkAbstract

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.grid2DSquareCellDouble

initCell

protected void initCell(int chunkCellRowIndex,
                        int chunkCellColIndex,
                        double 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 Grid2DSquareCellDoubleChunkAbstract

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 double setCell(int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double valueToSet,
                      double 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 Grid2DSquareCellDoubleChunkAbstract

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.grid2DSquareCellDouble

iterator

public AbstractIterator iterator()

Returns a Grid2DSquareCellDoubleChunkArrayIterator for iterating over the cells in this.

Specified by:

iterator in class Grid2DSquareCellChunkAbstract