org.apache.sysml.runtime.compress

Class ColGroupUncompressed

java.lang.Object

org.apache.sysml.runtime.compress.ColGroup

org.apache.sysml.runtime.compress.ColGroupUncompressed

All Implemented Interfaces:

Serializable

public class ColGroupUncompressed
extends ColGroup

Column group type for columns that are stored as dense arrays of doubles. Uses a MatrixBlock internally to store the column contents.

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

_colIndexes, _numRows

Constructor Summary

Constructors

Constructor and Description
ColGroupUncompressed()
ColGroupUncompressed(int[] colIndices, int numRows, MatrixBlock data) Constructor for internal use.
ColGroupUncompressed(List<ColGroup> groupsToDecompress) Constructor for creating temporary decompressed versions of one or more compressed column groups.
ColGroupUncompressed(List<Integer> colIndicesList, MatrixBlock rawblock) Main constructor.

Method Summary

Modifier and Type	Method and Description
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.
ColGroup.CompressionType	getCompType() Obtain the compression type.
MatrixBlock	getData() Access for superclass
long	getExactSizeOnDisk() Returns the exact serialized size of column group.
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.
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	leftMultByRowVector(MatrixBlock vector, MatrixBlock result, int k)
void	readFields(DataInput in) Deserializes column group from data input.
void	rightMultByVector(MatrixBlock vector, MatrixBlock result, int k)
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.
void	unaryAggregateOperations(org.apache.sysml.runtime.matrix.operators.AggregateUnaryOperator op, MatrixBlock ret)
void	write(DataOutput out) Serializes column group to data output.

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

ColGroupUncompressed

public ColGroupUncompressed()

ColGroupUncompressed

public ColGroupUncompressed(List<Integer> colIndicesList,
                            MatrixBlock rawblock)

Main constructor.

Parameters:

colIndicesList - indices (relative to the current block) of the columns that this column group represents.

rawblock - the uncompressed block; uncompressed data must be present at the time that the constructor is called

ColGroupUncompressed

public ColGroupUncompressed(List<ColGroup> groupsToDecompress)

Constructor for creating temporary decompressed versions of one or more compressed column groups.

Parameters:

groupsToDecompress - compressed columns to subsume. Must contain at least one element.

ColGroupUncompressed

public ColGroupUncompressed(int[] colIndices,
                            int numRows,
                            MatrixBlock data)

Constructor for internal use. Used when a method needs to build an instance of this class from scratch.

Parameters:

colIndices - column mapping for this column group

numRows - number of rows in the column, for passing to the superclass

data - matrix block

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

public MatrixBlock getData()

Access for superclass

Returns:

direct pointer to the internal representation of the columns

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 ColGroup

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.

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

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

rightMultByVector

public void rightMultByVector(MatrixBlock vector,
                              MatrixBlock result,
                              int k)

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(MatrixBlock vector,
                                MatrixBlock result,
                                int k)

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

unaryAggregateOperations

public void unaryAggregateOperations(org.apache.sysml.runtime.matrix.operators.AggregateUnaryOperator op,
                                     MatrixBlock ret)

Specified by:

unaryAggregateOperations in class ColGroup

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

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

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

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