org.apache.sysml.runtime.compress

Class ColGroupDDC2

java.lang.Object

org.apache.sysml.runtime.compress.ColGroup

org.apache.sysml.runtime.compress.ColGroupValue

org.apache.sysml.runtime.compress.ColGroupDDC

org.apache.sysml.runtime.compress.ColGroupDDC2

All Implemented Interfaces:

Serializable

public class ColGroupDDC2
extends ColGroupDDC

Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC) using 2 byte codes.

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor and Description
ColGroupDDC2()
ColGroupDDC2(int[] colIndices, int numRows, double[] values, char[] data)
ColGroupDDC2(int[] colIndices, int numRows, UncompressedBitmap ubm)

Method Summary

Modifier and Type	Method and Description
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 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
ColGroup.CompressionType	getCompType() Obtain the compression type.
int[]	getCounts()
int[]	getCounts(int rl, int ru)
protected double	getData(int r, int colIx) Generic get value for byte-length-agnostic access.
long	getExactSizeOnDisk() Returns the exact serialized size of column group.
void	leftMultByRowVector(ColGroupDDC a, MatrixBlock result)
void	leftMultByRowVector(MatrixBlock vector, MatrixBlock result) Multiply the slice of the matrix that this column group represents by a row vector on the left (the original column vector is assumed to be transposed already i.e.
void	readFields(DataInput in) Deserializes column group from data input.
void	rightMultByVector(MatrixBlock vector, MatrixBlock result, int rl, int ru) Multiply the slice of the matrix that this column group represents by a vector on the right.
ColGroup	scalarOperation(org.apache.sysml.runtime.matrix.operators.ScalarOperator op) Perform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.
protected void	setData(int r, int code) Generic set value for byte-length-agnostic write of encoded value.
void	write(DataOutput out) Serializes column group to data output.

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

computeColSums, computeRowMxx, decompressToBlock, get, getIterator, postScaling, unaryAggregateOperations

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

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

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

getColIndex, getColIndices, getNumCols, getNumRows, shiftColIndices

Methods inherited from class java.lang.Object

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

Constructor Detail

ColGroupDDC2

public ColGroupDDC2()

ColGroupDDC2

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

ColGroupDDC2

public ColGroupDDC2(int[] colIndices,
                    int numRows,
                    double[] values,
                    char[] data)

Method Detail

getCompType

public ColGroup.CompressionType getCompType()

Description copied from class: ColGroup

Obtain the compression type.

Specified by:

getCompType in class ColGroup

Returns:

How the elements of the column group are compressed.

getData

protected double getData(int r,
                         int colIx)

Description copied from class: ColGroupDDC

Generic get value for byte-length-agnostic access.

Specified by:

getData in class ColGroupDDC

Parameters:

r - global row index

colIx - local column index

Returns:

value

setData

protected void setData(int r,
                       int code)

Description copied from class: ColGroupDDC

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

Specified by:

setData in class ColGroupDDC

Parameters:

r - global row index

code - encoded value

write

public void write(DataOutput out)
           throws IOException

Description copied from class: ColGroup

Serializes column group to data output.

Specified by:

write in class ColGroup

Parameters:

out - data output

Throws:

IOException - if IOException occurs

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from class: ColGroup

Deserializes column group from data input.

Specified by:

readFields in class ColGroup

Parameters:

in - data input

Throws:

IOException - if IOException occurs

getExactSizeOnDisk

public long getExactSizeOnDisk()

Description copied from class: ColGroup

Returns the exact serialized size of column group. This can be used for example for buffer preallocation.

Specified by:

getExactSizeOnDisk in class ColGroup

Returns:

exact serialized size for column group

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 ColGroupDDC

Returns:

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

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.

Overrides:

decompressToBlock in class ColGroupDDC

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 colpos)

Description copied from class: ColGroup

Decompress to block.

Overrides:

decompressToBlock in class ColGroupDDC

Parameters:

target - dense output vector

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

getCounts

public int[] getCounts()

Specified by:

getCounts in class ColGroupValue

getCounts

public int[] getCounts(int rl,
                       int ru)

Specified by:

getCounts in class ColGroupValue

countNonZerosPerRow

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

Description copied from class: ColGroup

Count the number of non-zeros per row

Overrides:

countNonZerosPerRow in class ColGroupDDC

Parameters:

rnnz - non-zeros per row

rl - row lower bound, inclusive

ru - row upper bound, exclusive

rightMultByVector

public void rightMultByVector(MatrixBlock vector,
                              MatrixBlock result,
                              int rl,
                              int ru)
                       throws DMLRuntimeException

Description copied from class: ColGroup

Multiply the slice of the matrix that this column group represents by a vector on the right.

Specified by:

rightMultByVector in class ColGroup

Parameters:

vector - vector to multiply by (tall vector)

result - accumulator for holding the result

rl - row lower

ru - row upper

Throws:

DMLRuntimeException - if the internal SystemML code that performs the multiplication experiences an error

leftMultByRowVector

public void leftMultByRowVector(MatrixBlock vector,
                                MatrixBlock result)
                         throws DMLRuntimeException

Description copied from class: ColGroup

Multiply the slice of the matrix that this column group represents by a row vector on the left (the original column vector is assumed to be transposed already i.e. its size now is 1xn).

Specified by:

leftMultByRowVector in class ColGroup

Parameters:

vector - row vector

result - matrix block result

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

leftMultByRowVector

public void leftMultByRowVector(ColGroupDDC a,
                                MatrixBlock result)
                         throws DMLRuntimeException

Specified by:

leftMultByRowVector in class ColGroupValue

Throws:

DMLRuntimeException

computeSum

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

Overrides:

computeSum in class ColGroupDDC

computeRowSums

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

Overrides:

computeRowSums in class ColGroupDDC

scalarOperation

public ColGroup scalarOperation(org.apache.sysml.runtime.matrix.operators.ScalarOperator op)
                         throws DMLRuntimeException

Description copied from class: ColGroup

Perform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.

Specified by:

scalarOperation in class ColGroup

Parameters:

op - operation to perform

Returns:

version of this column group with the operation applied

Throws:

DMLRuntimeException - if DMLRuntimeException occurs