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

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
      extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkAbstract
          extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkArray
All Implemented Interfaces:
java.io.Serializable

public class Grid2DSquareCellDoubleChunkArray
extends Grid2DSquareCellDoubleChunkAbstract
implements java.io.Serializable

Grid2DSquareCellDoubleChunkAbstract extension that stores cell values in a double[][].

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, isSwapUpToDate
 
Constructor Summary
  Grid2DSquareCellDoubleChunkArray()
          Creates a new Grid2DSquareCellDoubleChunkArray.
protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk, Grid2DSquareCellAbstract.ChunkID chunkID)
          Creates a new Grid2DSquareCellDoubleChunkArray from grid2DSquareCellDoubleChunk.
protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDouble grid2DSquareCellDouble, Grid2DSquareCellAbstract.ChunkID chunkID)
          Creates a new Grid2DSquareCellDoubleChunkArray for grid2DSquareCellDouble containing all no data values.
 
Method Summary
protected  void clearData()
          Clears the data associated with this.
protected  double getCell(int chunkCellRowIndex, int chunkCellColIndex, double noDataValue)
          Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.
protected  double[][] getData()
          Returns this.data.
protected  void initCell(int chunkCellRowIndex, int chunkCellColIndex, double valueToInitialise)
          Initialises the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex.
protected  void initData()
          Initialises the data associated with this.
protected  IteratorAbstract iterator()
          Returns a Grid2DSquareCellDoubleChunkArrayIterator for iterating over the cells in this.
protected  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
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkAbstract
getArithmeticMeanBigDecimal, getArithmeticMeanBigDecimal, getArithmeticMeanDouble, getArithmeticMeanDouble, getCell, getCellBigDecimal, getGrid2DSquareCellDouble, getGrid2DSquareCellDouble, getMaxDouble, getMaxDouble, getMedianDouble, getMedianDouble, getMinDouble, getMinDouble, getModeTDoubleHashSet, getModeTDoubleHashSet, getNonNoDataValueCountBigInteger, getNonNoDataValueCountBigInteger, getNonNoDataValueCountInt, getNonNoDataValueCountInt, getStandardDeviationDouble, getStandardDeviationDouble, getSumBigDecimal, getSumBigDecimal, initCell, initCells, initCells, setCell, sort1, toArrayIncludingNoDataValues, toArrayIncludingNoDataValues, toArrayNotIncludingNoDataValues, toArrayNotIncludingNoDataValues
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
getChunkID, getChunkID, getDescription, getGrid2DSquareCell, getGrid2DSquareCell, getIsSwapUpToDate, getIsSwapUpToDate, getName, getName, inChunk, inChunk, initChunkID, initGrid2DSquareCell, iterator, setIsSwapUpToDate, setIsSwapUpToDate, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Grid2DSquareCellDoubleChunkArray

public Grid2DSquareCellDoubleChunkArray()
Creates a new Grid2DSquareCellDoubleChunkArray.


Grid2DSquareCellDoubleChunkArray

protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDouble grid2DSquareCellDouble,
                                           Grid2DSquareCellAbstract.ChunkID chunkID)
Creates a new Grid2DSquareCellDoubleChunkArray for grid2DSquareCellDouble containing all no data values.

Parameters:
grid2DSquareCellDouble - The Grid2DSquareCellDouble this is to be a chunk of.
chunkID - The ChunkID to be this.chunkID.

Grid2DSquareCellDoubleChunkArray

protected Grid2DSquareCellDoubleChunkArray(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk,
                                           Grid2DSquareCellAbstract.ChunkID chunkID)
Creates a new Grid2DSquareCellDoubleChunkArray from grid2DSquareCellDoubleChunk.

Parameters:
grid2DSquareCellDoubleChunk - The Grid2DSquareCellDoubleChunk this values are taken from.
chunkID - The ChunkID to be this.chunkID. TODO: A fast toArray() method in Grid2DSquareCellDoubleChunkMap could be coded then a constructor based on an double[] or double[][] might be faster?
Method Detail

initData

protected void initData()
Initialises the data associated with this.

Specified by:
initData in class Grid2DSquareCellDoubleChunkAbstract

getData

protected double[][] getData()
Returns this.data. TODO: Should the array be copied and the copy returned?


clearData

protected void clearData()
Clears the data associated with this.

Specified by:
clearData in class Grid2DSquareCellDoubleChunkAbstract

getCell

protected 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

protected 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

protected IteratorAbstract iterator()
Returns a Grid2DSquareCellDoubleChunkArrayIterator for iterating over the cells in this.

Specified by:
iterator in class Grid2DSquareCellChunkAbstract