com.hfg.util.collection

Class NumberMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

java.lang.Object

com.hfg.util.collection.AbstractSparseMatrix<RK,CK,V>

com.hfg.util.collection.SparseMatrix<RK,CK,V>

com.hfg.util.collection.NumberMatrix<RK,CK,V>

All Implemented Interfaces:

Cloneable

public class NumberMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>
extends SparseMatrix<RK,CK,V>

Sparse matrix for Numbers that calculated totals and percentages.

Constructor Summary

Constructors

Constructor and Description
NumberMatrix()
NumberMatrix(int inInitialRowCapacity, int inInitialColCapacity)

Method Summary

Modifier and Type	Method and Description
void	clearCol(CK inColKey)
void	clearRow(RK inRowKey)
V	getColTotal(CK inColKey)
V	getGrandTotal()
Float	getOverallPercent(RK inRowKey, CK inColKey) Calculates the percentage of the grand total (total of all cell values) represented by the specified cell.
Float	getPercentOfCol(RK inRowKey, CK inColKey) Calculates the percentage of the total column value represented by the specified cell.
Float	getPercentOfRow(RK inRowKey, CK inColKey) Calculates the percentage of the total row value represented by the specified cell.
V	getRowTotal(RK inRowKey)
void	increment(RK inRowKey, CK inColKey, V inIncrementSize) Increments the value in the specified cell by the specified amount.
void	put(RK inRowKey, CK inColKey, V inValue)
void	putCol(CK inColKey, Map<RK,V> inRowMap)
void	putRow(RK inRowKey, Map<CK,V> inColMap)
V	remove(RK inRowKey, CK inColKey)

Methods inherited from class com.hfg.util.collection.SparseMatrix

clone, colKeySet, getCol, getRow, rowKeySet

Methods inherited from class com.hfg.util.collection.AbstractSparseMatrix

addCol, addRow, changeColKey, changeRowKey, containsCol, containsRow, get, getCellWithSmallestValue, getNonIdentityCellWithSmallestValue, removeCol, removeCols, removeRow, size, toString, toString, trimToSize

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberMatrix

public NumberMatrix()

NumberMatrix

public NumberMatrix(int inInitialRowCapacity,
                    int inInitialColCapacity)

Method Detail

increment

public void increment(RK inRowKey,
                      CK inColKey,
                      V inIncrementSize)

Increments the value in the specified cell by the specified amount.

Parameters:

inRowKey - the key of the selected row

inColKey - the key of the selected column

inIncrementSize - the amount by which to increment the value

getColTotal

public V getColTotal(CK inColKey)

getRowTotal

public V getRowTotal(RK inRowKey)

getGrandTotal

public V getGrandTotal()

getPercentOfCol

public Float getPercentOfCol(RK inRowKey,
                             CK inColKey)

Calculates the percentage of the total column value represented by the specified cell.

Parameters:

inRowKey - the key of the selected row

inColKey - the key of the selected column

Returns:

the percentage of the total column value represented by the specified cell

getPercentOfRow

public Float getPercentOfRow(RK inRowKey,
                             CK inColKey)

Calculates the percentage of the total row value represented by the specified cell.

Parameters:

inRowKey - the key of the selected row

inColKey - the key of the selected column

Returns:

the percentage of the total row value represented by the specified cell

getOverallPercent

public Float getOverallPercent(RK inRowKey,
                               CK inColKey)

Calculates the percentage of the grand total (total of all cell values) represented by the specified cell.

Parameters:

inRowKey - the key of the selected row

inColKey - the key of the selected column

Returns:

the percentage of the grand total represented by the specified cell

put

public void put(RK inRowKey,
                CK inColKey,
                V inValue)

Overrides:

put in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

putRow

public void putRow(RK inRowKey,
                   Map<CK,V> inColMap)

Overrides:

putRow in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

putCol

public void putCol(CK inColKey,
                   Map<RK,V> inRowMap)

Overrides:

putCol in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

remove

public V remove(RK inRowKey,
                CK inColKey)

Overrides:

remove in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

clearRow

public void clearRow(RK inRowKey)

Overrides:

clearRow in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>

clearCol

public void clearCol(CK inColKey)

Overrides:

clearCol in class AbstractSparseMatrix<RK extends Comparable,CK extends Comparable,V extends Number & Comparable>