org.apache.sysml.runtime.compress

Class ColGroupOLE

java.lang.Object

org.apache.sysml.runtime.compress.ColGroup

org.apache.sysml.runtime.compress.ColGroupValue

org.apache.sysml.runtime.compress.ColGroupOffset

org.apache.sysml.runtime.compress.ColGroupOLE

All Implemented Interfaces:

Serializable

public class ColGroupOLE
extends ColGroupOffset

Class to encapsulate information about a column group that is encoded with simple lists of offsets for each set of distinct values.

See Also:

Serialized Form

Nested Class Summary

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

ColGroupOffset.OffsetRowIterator, ColGroupOffset.OffsetValueIterator, ColGroupOffset.ZeroValueIterator

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.ColGroupOffset

_data, _ptr, _skiplist, _zeros, ALLOW_CACHE_CONSCIOUS_ROWSUMS, CREATE_SKIPLIST, READ_CACHE_BLKSZ, WRITE_CACHE_BLKSZ

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
ColGroupOLE()
ColGroupOLE(int[] colIndices, int numRows, boolean zeros, double[] values, char[] bitmaps, int[] bitmapOffs)
ColGroupOLE(int[] colIndices, int numRows, UncompressedBitmap ubm) Main constructor.

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 boolean[]	computeZeroIndicatorVector() Utility function of sparse-unsafe operations.
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[] colixTargets) 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.
ColGroup.CompressionType	getCompType() Obtain the compression type.
int[]	getCounts(int[] counts)
int[]	getCounts(int rl, int ru, int[] counts)
Iterator<Integer>	getIterator(int k)
Iterator<Integer>	getIterator(int k, int rl, int ru)
ColGroup.ColGroupRowIterator	getRowIterator(int rl, int ru) Create a dense row iterator for a row index range.
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	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.

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

computeOffsets, createCompressedBitmaps, estimateInMemorySize, get, getBitmapOffsets, getBitmaps, getExactSizeOnDisk, getIterator, hasZeros, len, mxxValues, readFields, sumAllValues, unaryAggregateOperations, write

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

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

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

getColIndex, getColIndices, getNumCols, getNumRows, readFields, shiftColIndices, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ColGroupOLE

public ColGroupOLE()

ColGroupOLE

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

Main constructor. Constructs and stores the necessary bitmaps.

Parameters:

colIndices - indices (within the block) of the columns included in this column

numRows - total number of rows in the parent block

ubm - Uncompressed bitmap representation of the block

ColGroupOLE

public ColGroupOLE(int[] colIndices,
                   int numRows,
                   boolean zeros,
                   double[] values,
                   char[] bitmaps,
                   int[] bitmapOffs)

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.

Overrides:

decompressToBlock in class ColGroupOffset

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[] colixTargets)

Description copied from class: ColGroup

Decompress the contents of this column group into uncompressed packed columns

Overrides:

decompressToBlock in class ColGroupOffset

Parameters:

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

colixTargets - 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.

Overrides:

decompressToBlock in class ColGroupOffset

Parameters:

target - dense output vector

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

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

scalarOperation

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

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

rightMultByVector

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

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 if the internal SystemML code that performs the multiplication experiences an error

leftMultByRowVector

public void leftMultByRowVector(MatrixBlock vector,
                                MatrixBlock result)

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

leftMultByRowVector

public void leftMultByRowVector(ColGroupDDC a,
                                MatrixBlock result)

Specified by:

leftMultByRowVector in class ColGroupValue

computeSum

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

Specified by:

computeSum in class ColGroupOffset

computeRowSums

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

Specified by:

computeRowSums in class ColGroupOffset

computeColSums

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

Specified by:

computeColSums in class ColGroupOffset

computeRowMxx

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

Specified by:

computeRowMxx in class ColGroupOffset

computeZeroIndicatorVector

protected boolean[] computeZeroIndicatorVector()

Utility function of sparse-unsafe operations.

Specified by:

computeZeroIndicatorVector in class ColGroupOffset

Returns:

zero indicator vector

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

getIterator

public Iterator<Integer> getIterator(int k)

Specified by:

getIterator in class ColGroupOffset

Parameters:

k - index of value tuple with associated bitmap

Returns:

an iterator over the row offsets in this bitmap

getIterator

public Iterator<Integer> getIterator(int k,
                                     int rl,
                                     int ru)

Specified by:

getIterator in class ColGroupOffset

Parameters:

k - index of value tuple with associated bitmap

rl - row lower index, inclusive

ru - row upper index, exclusive

Returns:

an iterator over the row offsets in this bitmap

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