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

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellChunk
      extended by uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellIntChunk
          extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunk64CellMap
All Implemented Interfaces:
java.io.Serializable

public class Grid2DSquareCellIntChunk64CellMap
extends AbstractGrid2DSquareCellIntChunk

AbstractGrid2DSquareCellIntChunk extension that stores cell values in a TIntLongHashMap. The maximum size of this AbstractGrid2DSquareCellIntChunk is 64 cells. TODO: Adjudicate when this is useful. What type of data?

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellChunk
AbstractGrid2DSquareCellChunk.ChunkCellID
 
Field Summary
 
Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellChunk
_ChunkID, _Grid2DSquareCell, isSwapUpToDate
 
Constructor Summary
  Grid2DSquareCellIntChunk64CellMap()
          Creates a new Grid2DSquareCellIntChunk64CellMap.
protected Grid2DSquareCellIntChunk64CellMap(AbstractGrid2DSquareCellIntChunk grid2DSquareCellIntChunk, AbstractGrid2DSquareCell.ChunkID _ChunkID)
          Creates a new Grid2DSquareCellIntChunk64CellMap.
protected Grid2DSquareCellIntChunk64CellMap(Grid2DSquareCellInt grid2DSquareCellInt, AbstractGrid2DSquareCell.ChunkID _ChunkID)
          /** Creates a new Grid2DSquareCellIntChunk64CellMap.
 
Method Summary
protected  void clearData()
          Clears the data associated with this.
protected  java.math.BigDecimal getArithmeticMeanBigDecimal(int numberOfDecimalPlaces)
          For returning the Arithmetic Mean of all non noDataValues as a BigDecimal.
protected  int getCell(int chunkCellRowIndex, int chunkCellColIndex, int noDataValue)
          Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.
protected  gnu.trove.TIntLongHashMap getData()
          Returns this.data TODO: This could be made public if a copy is returned!
protected  java.math.BigInteger getDiversity()
          For returning the number of different values.
protected  java.math.BigDecimal getGeometricMeanBigDecimal()
          For returning the Geometric Mean of all non noDataValues as a BigDecimal Warning! This is imprecise and it can happen that Math.pow does not return what might be expected! (For example, negative powers in the range (0,1) for negative numbers.) TODO: Develop a pow function such as com.ibm.icu.math.BigDecimal.pow This resource is not used here due to licensing, but it could be...
protected  java.math.BigDecimal getHarmonicMeanBigDecimal()
          Returns the Harmonic Mean of all non noDataValues as a BigDecimal.
protected  int getMaxInt()
          For returning the maximum of all non noDataValues as a int.
protected  double getMedianDouble()
          For returning the median of all non noDataValues as a double
protected  int getMinInt()
          For returning the minimum of all non noDataValues as a int.
protected  gnu.trove.TIntHashSet getModeTIntHashSet()
          For returning the mode of all non noDataValues as a TDoubleHashSet
protected  java.math.BigInteger getNonNoDataValueCountBigInteger()
          Returns the number of cells with noDataValues as a BigInteger
protected  int getNonNoDataValueCountInt()
          Returns the number of cells with noDataValues as an int
protected  double getStandardDeviationDouble()
          For returning the standard deviation of all non noDataValues as a double
protected  java.math.BigDecimal getSumBigDecimal()
          For returning the sum of all non noDataValues as a BigDecimal
protected  void initCell(int chunkCellRowIndex, int chunkCellColIndex, int 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  AbstractIterator iterator()
          Returns a Grid2DSquareCellIntChunk64CellMapIterator for iterating over the cells in this.
protected  long powerOf2(int value)
          Returns 2 raised to the power of value as a long.
 long powerOf2(int value, boolean handleOutOfMemoryError)
          Returns 2 raised to the power of value as a long.
protected  int setCell(int chunkCellRowIndex, int chunkCellColIndex, int valueToSet, int noDataValue)
          Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet
protected  int[] toArrayIncludingNoDataValues()
          Returns all the values in row major order as a double[].
protected  int[] toArrayNotIncludingNoDataValues()
          Returns all the values (not including noDataValues) in row major order as a double[].
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellIntChunk
getArithmeticMeanBigDecimal, getArithmeticMeanDouble, getArithmeticMeanDouble, getCell, getCellDouble, getGrid2DSquareCellInt, getGrid2DSquareCellInt, getMaxInt, getMedianDouble, getMinInt, getModeTIntHashSet, getNonNoDataValueCountBigInteger, getNonNoDataValueCountInt, getStandardDeviationDouble, getSumBigDecimal, initCell, initCells, initCells, setCell, sort1, toArrayIncludingNoDataValues, toArrayNotIncludingNoDataValues
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.AbstractGrid2DSquareCellChunk
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

Grid2DSquareCellIntChunk64CellMap

public Grid2DSquareCellIntChunk64CellMap()
Creates a new Grid2DSquareCellIntChunk64CellMap.


Grid2DSquareCellIntChunk64CellMap

protected Grid2DSquareCellIntChunk64CellMap(Grid2DSquareCellInt grid2DSquareCellInt,
                                            AbstractGrid2DSquareCell.ChunkID _ChunkID)
/** Creates a new Grid2DSquareCellIntChunk64CellMap.

Parameters:
grid2DSquareCellInt - The Grid2DSquareCellDouble this is a chunk of.
_ChunkID - The ChunkID this will have.

Grid2DSquareCellIntChunk64CellMap

protected Grid2DSquareCellIntChunk64CellMap(AbstractGrid2DSquareCellIntChunk grid2DSquareCellIntChunk,
                                            AbstractGrid2DSquareCell.ChunkID _ChunkID)
Creates a new Grid2DSquareCellIntChunk64CellMap.

Parameters:
grid2DSquareCellIntChunk - The AbstractGrid2DSquareCellIntChunk this is constructed from.
_ChunkID - The ChunkID this will have.
Method Detail

initData

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

Specified by:
initData in class AbstractGrid2DSquareCellIntChunk

clearData

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

Specified by:
clearData in class AbstractGrid2DSquareCellIntChunk

getData

protected gnu.trove.TIntLongHashMap getData()
Returns this.data TODO: This could be made public if a copy is returned!


toArrayIncludingNoDataValues

protected int[] toArrayIncludingNoDataValues()
Returns all the values in row major order as a double[].

Overrides:
toArrayIncludingNoDataValues in class AbstractGrid2DSquareCellIntChunk

toArrayNotIncludingNoDataValues

protected int[] toArrayNotIncludingNoDataValues()
Returns all the values (not including noDataValues) in row major order as a double[].

Overrides:
toArrayNotIncludingNoDataValues in class AbstractGrid2DSquareCellIntChunk

getCell

protected 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 AbstractGrid2DSquareCellIntChunk
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.

Specified by:
initCell in class AbstractGrid2DSquareCellIntChunk
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 int setCell(int chunkCellRowIndex,
                      int chunkCellColIndex,
                      int valueToSet,
                      int noDataValue)
Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet

Specified by:
setCell in class AbstractGrid2DSquareCellIntChunk
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

powerOf2

public long powerOf2(int value,
                     boolean handleOutOfMemoryError)
Returns 2 raised to the power of value as a long.

Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

powerOf2

protected long powerOf2(int value)
Returns 2 raised to the power of value as a long.


getNonNoDataValueCountBigInteger

protected java.math.BigInteger getNonNoDataValueCountBigInteger()
Returns the number of cells with noDataValues as a BigInteger

Overrides:
getNonNoDataValueCountBigInteger in class AbstractGrid2DSquareCellIntChunk

getNonNoDataValueCountInt

protected int getNonNoDataValueCountInt()
Returns the number of cells with noDataValues as an int

Overrides:
getNonNoDataValueCountInt in class AbstractGrid2DSquareCellIntChunk

getSumBigDecimal

protected java.math.BigDecimal getSumBigDecimal()
For returning the sum of all non noDataValues as a BigDecimal

Overrides:
getSumBigDecimal in class AbstractGrid2DSquareCellIntChunk

getMinInt

protected int getMinInt()
For returning the minimum of all non noDataValues as a int.

Overrides:
getMinInt in class AbstractGrid2DSquareCellIntChunk

getMaxInt

protected int getMaxInt()
For returning the maximum of all non noDataValues as a int.

Overrides:
getMaxInt in class AbstractGrid2DSquareCellIntChunk

getArithmeticMeanBigDecimal

protected java.math.BigDecimal getArithmeticMeanBigDecimal(int numberOfDecimalPlaces)
For returning the Arithmetic Mean of all non noDataValues as a BigDecimal. Using BigDecimal this should be as precise as possible with doubles.

Overrides:
getArithmeticMeanBigDecimal in class AbstractGrid2DSquareCellIntChunk
Parameters:
numberOfDecimalPlaces - The number of decimal places to which the result is precise.

getGeometricMeanBigDecimal

protected java.math.BigDecimal getGeometricMeanBigDecimal()
For returning the Geometric Mean of all non noDataValues as a BigDecimal Warning! This is imprecise and it can happen that Math.pow does not return what might be expected! (For example, negative powers in the range (0,1) for negative numbers.) TODO: Develop a pow function such as com.ibm.icu.math.BigDecimal.pow This resource is not used here due to licensing, but it could be...


getHarmonicMeanBigDecimal

protected java.math.BigDecimal getHarmonicMeanBigDecimal()
Returns the Harmonic Mean of all non noDataValues as a BigDecimal. Zero values are ignored in the calculation.


getModeTIntHashSet

protected gnu.trove.TIntHashSet getModeTIntHashSet()
For returning the mode of all non noDataValues as a TDoubleHashSet

Overrides:
getModeTIntHashSet in class AbstractGrid2DSquareCellIntChunk

getMedianDouble

protected double getMedianDouble()
For returning the median of all non noDataValues as a double

Overrides:
getMedianDouble in class AbstractGrid2DSquareCellIntChunk

getStandardDeviationDouble

protected double getStandardDeviationDouble()
For returning the standard deviation of all non noDataValues as a double

Overrides:
getStandardDeviationDouble in class AbstractGrid2DSquareCellIntChunk

getDiversity

protected java.math.BigInteger getDiversity()
For returning the number of different values.


iterator

protected AbstractIterator iterator()
Returns a Grid2DSquareCellIntChunk64CellMapIterator for iterating over the cells in this.

Specified by:
iterator in class AbstractGrid2DSquareCellChunk