org.apache.sysml.runtime.compress

Class ColGroupDDC

java.lang.Object

org.apache.sysml.runtime.compress.ColGroup

org.apache.sysml.runtime.compress.ColGroupValue

org.apache.sysml.runtime.compress.ColGroupDDC

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ColGroupDDC1, ColGroupDDC2

public abstract class ColGroupDDC
extends ColGroupValue

Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC). NOTE: zero values are included at position 0 in the value dictionary, which simplifies various operations such as counting the number of non-zeros.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sysml.runtime.compress.ColGroup

ColGroup.ColGroupRowIterator, ColGroup.CompressionType

Field Summary

Fields inherited from class org.apache.sysml.runtime.compress.ColGroupValue

_values, LOW_LEVEL_OPT, SORT_VALUES_BY_LENGTH

Fields inherited from class org.apache.sysml.runtime.compress.ColGroup

_colIndexes, _numRows

Constructor Summary

Constructors

Modifier	Constructor and Description
	ColGroupDDC()
protected	ColGroupDDC(int[] colIndices, int numRows, double[] values)
	ColGroupDDC(int[] colIndices, int numRows, UncompressedBitmap ubm)

Method Summary

Modifier and Type	Method and Description
protected void	computeColSums(MatrixBlock result, org.apache.sysml.runtime.functionobjects.KahanFunction kplus)
protected void	computeRowMxx(MatrixBlock result, org.apache.sysml.runtime.functionobjects.Builtin builtin, int rl, int ru)
protected void	computeRowSums(MatrixBlock result, org.apache.sysml.runtime.functionobjects.KahanFunction kplus, int rl, int ru)
protected void	computeSum(MatrixBlock result, org.apache.sysml.runtime.functionobjects.KahanFunction kplus)
protected void	countNonZerosPerRow(int[] rnnz, int rl, int ru) Count the number of non-zeros per row
void	decompressToBlock(MatrixBlock target, int colpos) Decompress to block.
void	decompressToBlock(MatrixBlock target, int[] colIndexTargets) Decompress the contents of this column group into uncompressed packed columns
void	decompressToBlock(MatrixBlock target, int rl, int ru) Decompress the contents of this column group into the specified full matrix block.
long	estimateInMemorySize() Note: Must be overridden by child classes to account for additional data and metadata
double	get(int r, int c) Get the value at a global row/column position.
protected abstract int	getCode(int r)
protected abstract double	getData(int r) Generic get value for byte-length-agnostic access to first column.
protected abstract double	getData(int r, int colIx) Generic get value for byte-length-agnostic access.
Iterator<IJV>	getIterator(int rl, int ru, boolean inclZeros, boolean rowMajor) Create a column group iterator for a row index range.
ColGroup.ColGroupRowIterator	getRowIterator(int rl, int ru) Create a dense row iterator for a row index range.
protected void	postScaling(double[] vals, double[] c)
protected abstract void	setData(int r, int code) Generic set value for byte-length-agnostic write of encoded value.
void	unaryAggregateOperations(org.apache.sysml.runtime.matrix.operators.AggregateUnaryOperator op, MatrixBlock result, int rl, int ru)

Methods inherited from class org.apache.sysml.runtime.compress.ColGroupValue

allocDVector, allocIVector, applyScalarOp, applyScalarOp, cleanupThreadLocalMemory, computeColMxx, computeMxx, containsAllZeroValue, getCounts, getCounts, getCounts, getCounts, getCounts, getCountsAsBlock, getCountsAsBlock, getNumValues, getValue, getValues, getValuesAsBlock, getValuesSize, leftMultByRowVector, preaggValues, preaggValues, setupThreadLocalMemory, setValues, sumAllValues, sumAllValues, sumValues, sumValues, sumValues, sumValues, unaryAggregateOperations

Methods inherited from class org.apache.sysml.runtime.compress.ColGroup

getColIndex, getColIndices, getCompType, getExactSizeOnDisk, getNumCols, getNumRows, leftMultByRowVector, readFields, readFields, rightMultByVector, scalarOperation, shiftColIndices, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ColGroupDDC

public ColGroupDDC()

ColGroupDDC

public ColGroupDDC(int[] colIndices,
                   int numRows,
                   UncompressedBitmap ubm)

ColGroupDDC

protected ColGroupDDC(int[] colIndices,
                      int numRows,
                      double[] values)

Method Detail

decompressToBlock

public void decompressToBlock(MatrixBlock target,
                              int rl,
                              int ru)

Description copied from class: ColGroup

Decompress the contents of this column group into the specified full matrix block.

Specified by:

decompressToBlock in class ColGroup

Parameters:

target - a matrix block where the columns covered by this column group have not yet been filled in.

rl - row lower

ru - row upper

decompressToBlock

public void decompressToBlock(MatrixBlock target,
                              int[] colIndexTargets)

Description copied from class: ColGroup

Decompress the contents of this column group into uncompressed packed columns

Specified by:

decompressToBlock in class ColGroup

Parameters:

target - a dense matrix block. The block must have enough space to hold the contents of this column group.

colIndexTargets - array that maps column indices in the original matrix block to columns of target.

decompressToBlock

public void decompressToBlock(MatrixBlock target,
                              int colpos)

Description copied from class: ColGroup

Decompress to block.

Specified by:

decompressToBlock in class ColGroup

Parameters:

target - dense output vector

colpos - column to decompress, error if larger or equal numCols

get

public double get(int r,
                  int c)

Description copied from class: ColGroup

Get the value at a global row/column position.

Specified by:

get in class ColGroup

Parameters:

r - row

c - column

Returns:

value at the row/column position

countNonZerosPerRow

protected void countNonZerosPerRow(int[] rnnz,
                                   int rl,
                                   int ru)

Description copied from class: ColGroup

Count the number of non-zeros per row

Specified by:

countNonZerosPerRow in class ColGroup

Parameters:

rnnz - non-zeros per row

rl - row lower bound, inclusive

ru - row upper bound, exclusive

unaryAggregateOperations

public void unaryAggregateOperations(org.apache.sysml.runtime.matrix.operators.AggregateUnaryOperator op,
                                     MatrixBlock result,
                                     int rl,
                                     int ru)

Specified by:

unaryAggregateOperations in class ColGroupValue

Parameters:

op - aggregation operator

result - output matrix block

rl - row lower index, inclusive

ru - row upper index, exclusive

computeSum

protected void computeSum(MatrixBlock result,
                          org.apache.sysml.runtime.functionobjects.KahanFunction kplus)

computeColSums

protected void computeColSums(MatrixBlock result,
                              org.apache.sysml.runtime.functionobjects.KahanFunction kplus)

computeRowSums

protected void computeRowSums(MatrixBlock result,
                              org.apache.sysml.runtime.functionobjects.KahanFunction kplus,
                              int rl,
                              int ru)

computeRowMxx

protected void computeRowMxx(MatrixBlock result,
                             org.apache.sysml.runtime.functionobjects.Builtin builtin,
                             int rl,
                             int ru)

postScaling

protected final void postScaling(double[] vals,
                                 double[] c)

getData

protected abstract double getData(int r)

Generic get value for byte-length-agnostic access to first column.

Parameters:

r - global row index

Returns:

value

getData

protected abstract double getData(int r,
                                  int colIx)

Generic get value for byte-length-agnostic access.

Parameters:

r - global row index

colIx - local column index

Returns:

value

setData

protected abstract void setData(int r,
                                int code)

Generic set value for byte-length-agnostic write of encoded value.

Parameters:

r - global row index

code - encoded value

getCode

protected abstract int getCode(int r)

estimateInMemorySize

public long estimateInMemorySize()

Description copied from class: ColGroup

Note: Must be overridden by child classes to account for additional data and metadata

Overrides:

estimateInMemorySize in class ColGroupValue

Returns:

an upper bound on the number of bytes used to store this ColGroup in memory.

getIterator

public Iterator<IJV> getIterator(int rl,
                                 int ru,
                                 boolean inclZeros,
                                 boolean rowMajor)

Description copied from class: ColGroup

Create a column group iterator for a row index range.

Specified by:

getIterator in class ColGroup

Parameters:

rl - row lower index, inclusive

ru - row upper index, exclusive

inclZeros - include zero values into scope of iterator

rowMajor - use a row major iteration order

Returns:

an iterator instance

getRowIterator

public ColGroup.ColGroupRowIterator getRowIterator(int rl,
                                                   int ru)

Description copied from class: ColGroup

Create a dense row iterator for a row index range. This iterator implies the inclusion of zeros and row-major iteration order.

Specified by:

getRowIterator in class ColGroup

Parameters:

rl - row lower index, inclusive

ru - row upper index, exclusive

Returns:

an iterator instance