org.apache.sysds.runtime.compress.colgroup

Class ColGroupDDC

java.lang.Object

org.apache.sysds.runtime.compress.colgroup.ColGroup

org.apache.sysds.runtime.compress.colgroup.ColGroupValue

org.apache.sysds.runtime.compress.colgroup.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).

See Also:

Serialized Form

Nested Class Summary

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

ColGroup.CompressionType

Method Summary

Modifier and Type	Method and Description
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.
double	get(int r, int c) Get the value at a global row/column position.
ColGroup.CompressionType	getCompType() Obtain the compression type.
int[]	getCounts(int[] counts)
int[]	getCounts(int rl, int ru, int[] counts)
Iterator<IJV>	getIterator(int rl, int ru, boolean inclZeros, boolean rowMajor) Create a column group iterator for a row index range.
org.apache.sysds.runtime.compress.colgroup.ColGroup.ColGroupRowIterator	getRowIterator(int rl, int ru) Create a dense row iterator for a row index range.
void	leftMultByMatrix(double[] a, double[] c, int numVals, double[] values, int numRows, int numCols, int rl, int ru, int voff) 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	leftMultByRowVector(double[] a, double[] result, int numVals) 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	leftMultByRowVector(double[] a, double[] c, int numVals, double[] values) 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	postScaling(double[] values, double[] vals, double[] c, int numVals)
void	postScaling(double[] values, double[] vals, double[] c, int numVals, int i, int totalCols)
double[]	preAggregate(double[] a, int numVals)
double[]	preAggregate(double[] a, int numVals, int aRows) Pre aggregates a specific row from the input a which can be a row or a matrix.
void	rightMultByMatrix(double[] b, double[] c, int numVals, double[] values, int rl, int ru, int vOff)
String	toString()

Methods inherited from class org.apache.sysds.runtime.compress.colgroup.ColGroupValue

cleanupThreadLocalMemory, getByteValues, getCounts, getCounts, getExactSizeOnDisk, getIfCountsType, getNumValues, getValues, getValuesAsBlock, isLossy, readFields, setupThreadLocalMemory, unaryAggregateOperations, unaryAggregateOperations, write

Methods inherited from class org.apache.sysds.runtime.compress.colgroup.ColGroup

estimateInMemorySize, getColIndex, getColIndices, getNumCols, getNumRows, rightMultByVector, scalarOperation, shiftColIndices

Methods inherited from class java.lang.Object

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

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.

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

public 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

postScaling

public void postScaling(double[] values,
                        double[] vals,
                        double[] c,
                        int numVals)

postScaling

public void postScaling(double[] values,
                        double[] vals,
                        double[] c,
                        int numVals,
                        int i,
                        int totalCols)

getCounts

public int[] getCounts(int[] counts)

Specified by:

getCounts in class ColGroupValue

getCounts

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

Specified by:

getCounts in class ColGroupValue

rightMultByMatrix

public void rightMultByMatrix(double[] b,
                              double[] c,
                              int numVals,
                              double[] values,
                              int rl,
                              int ru,
                              int vOff)

Specified by:

rightMultByMatrix in class ColGroup

leftMultByMatrix

public void leftMultByMatrix(double[] a,
                             double[] c,
                             int numVals,
                             double[] values,
                             int numRows,
                             int numCols,
                             int rl,
                             int ru,
                             int voff)

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:

leftMultByMatrix in class ColGroup

Parameters:

a - matrix to left multiply

c - matrix block result

numVals - The Number of values contained in the Column.

values - The materialized list of values contained in the dictionary.

numRows - The number of rows in the matrix input

numCols - The number of columns in the colGroups parent matrix.

rl - The row to start the matrix multiplication from

ru - The row to stop the matrix multiplication at.

voff - The offset into the first argument matrix to start at.

leftMultByRowVector

public void leftMultByRowVector(double[] a,
                                double[] result,
                                int numVals)

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:

a - row vector

result - matrix block result

numVals - The Number of values contained in the Column.

preAggregate

public double[] preAggregate(double[] a,
                             int numVals)

preAggregate

public double[] preAggregate(double[] a,
                             int numVals,
                             int aRows)

Pre aggregates a specific row from the input a which can be a row or a matrix.

Parameters:

a - the input vector or matrix to multiply with

numVals - the number of values contained in the dictionary

aRows - the row index from a

Returns:

the pre-aggregated values.

leftMultByRowVector

public void leftMultByRowVector(double[] a,
                                double[] c,
                                int numVals,
                                double[] values)

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:

a - row vector

c - matrix block result

numVals - The Number of values contained in the Column.

values - The materialized list of values contained in the dictionary.

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 org.apache.sysds.runtime.compress.colgroup.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

toString

public String toString()

Overrides:

toString in class ColGroupValue