Class ColGroupSDCFOR
- java.lang.Object
 - 
- org.apache.sysds.runtime.compress.colgroup.AColGroup
 - 
- org.apache.sysds.runtime.compress.colgroup.AColGroupCompressed
 - 
- org.apache.sysds.runtime.compress.colgroup.ADictBasedColGroup
 - 
- org.apache.sysds.runtime.compress.colgroup.AColGroupValue
 - 
- org.apache.sysds.runtime.compress.colgroup.AMorphingMMColGroup
 - 
- org.apache.sysds.runtime.compress.colgroup.ASDC
 - 
- org.apache.sysds.runtime.compress.colgroup.ColGroupSDCFOR
 
 
 
 
 
 
 
 
- 
- All Implemented Interfaces:
 Serializable,AOffsetsGroup,IContainADictionary,IContainDefaultTuple,IFrameOfReferenceGroup,IMapToDataGroup
public class ColGroupSDCFOR extends ASDC implements IMapToDataGroup, IFrameOfReferenceGroup
ColGroup for Patched Frame Of Reference. This column group fits perfectly into the collection of compression groups It can be constructed when a SDCZeros group get a non zero default value. Then a natural extension is to transform the group into a PFOR group, since the default value is then treated as an offset, and the dictionary can be copied with no modifications.- See Also:
 - Serialized Form
 
 
- 
- 
Nested Class Summary
- 
Nested classes/interfaces inherited from class org.apache.sysds.runtime.compress.colgroup.AColGroup
AColGroup.CompressionType 
 - 
 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AColGroupappend(AColGroup g)Append the other column group to this column group.AColGroupappendNInternal(AColGroup[] g, int blen, int rlen)AColGroupbinaryRowOpLeft(BinaryOperator op, double[] v, boolean isRowSafe)Perform a binary row operation.AColGroupbinaryRowOpRight(BinaryOperator op, double[] v, boolean isRowSafe)Perform a binary row operation.CM_COV_ObjectcentralMoment(CMOperator op, int nRows)Central Moment instruction executed on a column group.AColGroupCompressedcombineWithSameIndex(int nRow, int nCol, List<AColGroup> right)C bind the list of column groups with this column group.AColGroupCompressedcombineWithSameIndex(int nRow, int nCol, AColGroup right)C bind the given column group to this.voidcomputeColSums(double[] c, int nRows)Compute the column sumbooleancontainsValue(double pattern)Detect if the column group contains a specific value.static AColGroupcreate(IColIndex colIndexes, int numRows, IDictionary dict, AOffset offsets, AMapToData data, int[] cachedCounts, double[] reference)longestimateInMemorySize()Get the upper bound estimate of in memory allocation for the column group.AColGroupextractCommon(double[] constV)extract common value from group and return non morphing grouporg.apache.sysds.runtime.compress.colgroup.AColGroup.ColGroupTypegetColGroupType()double[]getCommon()Get common vector, note this should not materialize anything but simply point to things that are already allocated.ICLASchemegetCompressionScheme()Get the compression scheme for this column group to enable compression of other data.AColGroup.CompressionTypegetCompType()Obtain the compression type.doublegetCost(ComputationCostEstimator e, int nRows)Get the computation cost associated with this column group.int[]getCounts(int[] counts)double[]getDefaultTuple()IEncodegetEncoding()Get encoding of this column group.longgetExactSizeOnDisk()Returns the exact serialized size of column group.doublegetIdx(int r, int colIdx)Get the value at a colGroup specific row/column index position.AMapToDatagetMapToData()longgetNumberNonZeros(int nRows)Get the number of nonZeros contained in this column group.intgetNumberOffsets()static ColGroupSDCFORread(DataInput in, int nRows)AColGrouprecompress()Recompress this column group into a new column group.AColGroupreplace(double pattern, double replace)Make a copy of the column group values, and replace all values that match pattern with replacement value.AColGrouprexpandCols(int max, boolean ignore, boolean cast, int nRows)Expand the column group to multiple columns.booleansameIndexStructure(AColGroupCompressed that)AColGroupscalarOperation(ScalarOperator op)Perform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.AColGroupsliceRows(int rl, int ru)Slice range of rows out of the column group and return a new column group only containing the row segment.voidsparseSelection(MatrixBlock selection, ColGroupUtils.P[] points, MatrixBlock ret, int rl, int ru)static AColGroupsparsifyFOR(ColGroupSDC g)AColGroup[]splitReshape(int multiplier, int nRow, int nColOrg)This method returns a list of column groups that are naive splits of this column group as if it is reshaped.StringtoString()AColGroupunaryOperation(UnaryOperator op)Perform unary operation on the column group and return a new column groupvoidwrite(DataOutput out)- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.ASDC
getCompressionInfo, getNumRows, getOffsets, morph 
- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.AMorphingMMColGroup
decompressToSparseBlockTransposed, leftMultByAColGroup, leftMultByMatrixNoPreAgg, tsmmAColGroup 
- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.AColGroupValue
clear, getCounts, getNumValues 
- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.ADictBasedColGroup
copyAndSet, copyAndSet, decompressToDenseBlock, decompressToDenseBlockTransposed, decompressToSparseBlock, getDictionary, getSparsity, reduceCols, rightMultByMatrix 
- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.AColGroupCompressed
getMax, getMin, getSum, isEmpty, preAggRows, sameIndexStructure, tsmm, unaryAggregateOperations, unaryAggregateOperations 
- 
Methods inherited from class org.apache.sysds.runtime.compress.colgroup.AColGroup
addVector, appendN, colSum, combine, decompressToDenseBlock, decompressToSparseBlock, get, getColIndices, getNumCols, rightDecompressingMult, rightMultByMatrix, selectionMultiply, shiftColIndices, sliceColumn, sliceColumns, sortColumnIndexes, splitReshapePushDown 
 - 
 
 - 
 
- 
- 
Method Detail
- 
create
public static AColGroup create(IColIndex colIndexes, int numRows, IDictionary dict, AOffset offsets, AMapToData data, int[] cachedCounts, double[] reference)
 
- 
sparsifyFOR
public static AColGroup sparsifyFOR(ColGroupSDC g)
 
- 
getCompType
public AColGroup.CompressionType getCompType()
Description copied from class:AColGroupObtain the compression type.- Specified by:
 getCompTypein classAColGroup- Returns:
 - How the elements of the column group are compressed.
 
 
- 
getColGroupType
public org.apache.sysds.runtime.compress.colgroup.AColGroup.ColGroupType getColGroupType()
 
- 
getDefaultTuple
public double[] getDefaultTuple()
- Specified by:
 getDefaultTuplein interfaceIContainDefaultTuple
 
- 
getCounts
public int[] getCounts(int[] counts)
 
- 
getMapToData
public AMapToData getMapToData()
- Specified by:
 getMapToDatain interfaceIMapToDataGroup
 
- 
getIdx
public double getIdx(int r, int colIdx)Description copied from class:AColGroupGet the value at a colGroup specific row/column index position. 
- 
scalarOperation
public AColGroup scalarOperation(ScalarOperator op)
Description copied from class:AColGroupPerform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.- Specified by:
 scalarOperationin classAColGroup- Parameters:
 op- operation to perform- Returns:
 - version of this column group with the operation applied
 
 
- 
unaryOperation
public AColGroup unaryOperation(UnaryOperator op)
Description copied from class:AColGroupPerform unary operation on the column group and return a new column group- Specified by:
 unaryOperationin classAColGroup- Parameters:
 op- The operation to perform- Returns:
 - The new column group
 
 
- 
binaryRowOpLeft
public AColGroup binaryRowOpLeft(BinaryOperator op, double[] v, boolean isRowSafe)
Description copied from class:AColGroupPerform a binary row operation.- Specified by:
 binaryRowOpLeftin classAColGroup- Parameters:
 op- The operation to executev- The vector of values to apply the values contained should be at least the length of the highest value in the column indexisRowSafe- True if the binary op is applied to an entire zero row and all results are zero- Returns:
 - A updated column group with the new values.
 
 
- 
binaryRowOpRight
public AColGroup binaryRowOpRight(BinaryOperator op, double[] v, boolean isRowSafe)
Description copied from class:AColGroupPerform a binary row operation.- Specified by:
 binaryRowOpRightin classAColGroup- Parameters:
 op- The operation to executev- The vector of values to apply the values contained should be at least the length of the highest value in the column indexisRowSafe- True if the binary op is applied to an entire zero row and all results are zero- Returns:
 - A updated column group with the new values.
 
 
- 
write
public void write(DataOutput out) throws IOException
- Overrides:
 writein classADictBasedColGroup- Throws:
 IOException
 
- 
read
public static ColGroupSDCFOR read(DataInput in, int nRows) throws IOException
- Throws:
 IOException
 
- 
getExactSizeOnDisk
public long getExactSizeOnDisk()
Description copied from class:AColGroupReturns the exact serialized size of column group. This can be used for example for buffer preallocation.- Overrides:
 getExactSizeOnDiskin classADictBasedColGroup- Returns:
 - exact serialized size for column group
 
 
- 
estimateInMemorySize
public long estimateInMemorySize()
Description copied from class:AColGroupGet the upper bound estimate of in memory allocation for the column group.- Overrides:
 estimateInMemorySizein classAColGroupValue- Returns:
 - an upper bound on the number of bytes used to store this ColGroup in memory.
 
 
- 
replace
public AColGroup replace(double pattern, double replace)
Description copied from class:AColGroupMake a copy of the column group values, and replace all values that match pattern with replacement value.- Overrides:
 replacein classAColGroupValue- Parameters:
 pattern- The value to look forreplace- The value to replace the other value with- Returns:
 - A new Column Group, reusing the index structure but with new values.
 
 
- 
computeColSums
public void computeColSums(double[] c, int nRows)Description copied from class:AColGroupCompute the column sum- Overrides:
 computeColSumsin classAColGroupValue- Parameters:
 c- The array to add the column sum to.nRows- The number of rows in the column group.
 
- 
containsValue
public boolean containsValue(double pattern)
Description copied from class:AColGroupDetect if the column group contains a specific value.- Specified by:
 containsValuein classAColGroup- Parameters:
 pattern- The value to look for.- Returns:
 - boolean saying true if the value is contained.
 
 
- 
getNumberNonZeros
public long getNumberNonZeros(int nRows)
Description copied from class:AColGroupGet the number of nonZeros contained in this column group.- Overrides:
 getNumberNonZerosin classAColGroupValue- Parameters:
 nRows- The number of rows in the column group, this is used for groups that does not contain information about how many rows they have.- Returns:
 - The nnz.
 
 
- 
extractCommon
public AColGroup extractCommon(double[] constV)
Description copied from class:AMorphingMMColGroupextract common value from group and return non morphing group- Specified by:
 extractCommonin interfaceIFrameOfReferenceGroup- Specified by:
 extractCommonin classAMorphingMMColGroup- Parameters:
 constV- a vector to contain all values, note length = nCols in total matrix.- Returns:
 - A non morphing column group with decompression instructions.
 
 
- 
rexpandCols
public AColGroup rexpandCols(int max, boolean ignore, boolean cast, int nRows)
Description copied from class:AColGroupExpand the column group to multiple columns. (one hot encode the column group)- Overrides:
 rexpandColsin classAColGroupValue- Parameters:
 max- The number of columns to expand to and cutoff values at.ignore- If zero and negative values should be ignored.cast- If the double values contained should be cast to whole numbers.nRows- The number of rows in the column group.- Returns:
 - A new column group containing max number of columns.
 
 
- 
centralMoment
public CM_COV_Object centralMoment(CMOperator op, int nRows)
Description copied from class:AColGroupCentral Moment instruction executed on a column group.- Overrides:
 centralMomentin classAColGroupValue- Parameters:
 op- The Operator to use.nRows- The number of rows contained in the ColumnGroup.- Returns:
 - A Central Moment object.
 
 
- 
getCost
public double getCost(ComputationCostEstimator e, int nRows)
Description copied from class:AColGroupGet the computation cost associated with this column group. 
- 
getCommon
public double[] getCommon()
Description copied from class:AMorphingMMColGroupGet common vector, note this should not materialize anything but simply point to things that are already allocated.- Specified by:
 getCommonin classAMorphingMMColGroup- Returns:
 - the common double vector
 
 
- 
sliceRows
public AColGroup sliceRows(int rl, int ru)
Description copied from class:AColGroupSlice range of rows out of the column group and return a new column group only containing the row segment. Note that this slice should maintain pointers back to the original dictionaries and only modify index structures. 
- 
append
public AColGroup append(AColGroup g)
Description copied from class:AColGroupAppend the other column group to this column group. This method tries to combine them to return a new column group containing both. In some cases it is possible in reasonable time, in others it is not. The result is first this column group followed by the other column group in higher row values. If it is not possible or very inefficient null is returned. 
- 
recompress
public AColGroup recompress()
Description copied from class:AColGroupRecompress this column group into a new column group.- Specified by:
 recompressin classAColGroup- Returns:
 - A new or the same column group depending on optimization goal.
 
 
- 
getEncoding
public IEncode getEncoding()
Description copied from class:AColGroupGet encoding of this column group.- Overrides:
 getEncodingin classAColGroup- Returns:
 - The encoding of the index structure.
 
 
- 
sameIndexStructure
public boolean sameIndexStructure(AColGroupCompressed that)
- Specified by:
 sameIndexStructurein classAColGroupCompressed
 
- 
getNumberOffsets
public int getNumberOffsets()
- Specified by:
 getNumberOffsetsin classASDC
 
- 
getCompressionScheme
public ICLAScheme getCompressionScheme()
Description copied from class:AColGroupGet the compression scheme for this column group to enable compression of other data.- Overrides:
 getCompressionSchemein classASDC- Returns:
 - The compression scheme of this column group
 
 
- 
sparseSelection
public void sparseSelection(MatrixBlock selection, ColGroupUtils.P[] points, MatrixBlock ret, int rl, int ru)
 
- 
combineWithSameIndex
public AColGroupCompressed combineWithSameIndex(int nRow, int nCol, List<AColGroup> right)
Description copied from class:AColGroupC bind the list of column groups with this column group. the list of elements provided in the index of each list is guaranteed to have the same index structures- Overrides:
 combineWithSameIndexin classAColGroup- Parameters:
 nRow- The number of rows contained in all right and this column group.nCol- The number of columns to shift the right hand side column groups over when combining, this should only effect the column indexesright- The right hand side column groups to combine. NOTE only the index offset of the second nested list should be used. The reason for providing this nested list is to avoid redundant allocations in calling methods.- Returns:
 - A combined compressed column group of the same type as this!.
 
 
- 
combineWithSameIndex
public AColGroupCompressed combineWithSameIndex(int nRow, int nCol, AColGroup right)
Description copied from class:AColGroupC bind the given column group to this.- Overrides:
 combineWithSameIndexin classAColGroup- Parameters:
 nRow- The number of rows contained in the right and this column group.nCol- The number of columns in this.right- The column group to c-bind.- Returns:
 - a new combined column groups.
 
 
- 
splitReshape
public AColGroup[] splitReshape(int multiplier, int nRow, int nColOrg)
Description copied from class:AColGroupThis method returns a list of column groups that are naive splits of this column group as if it is reshaped. This means the column groups rows are split into x number of other column groups where x is the multiplier. The indexes are assigned round robbin to each of the output groups, meaning the first index is assigned. If for instance the 4. column group is split by a 2 multiplier and there was 5 columns in total originally. The output becomes 2 column groups at column index 4 and one at 9. If possible the split column groups should reuse pointers back to the original dictionaries!- Specified by:
 splitReshapein classAColGroup- Parameters:
 multiplier- The number of column groups to split intonRow- The number of rows in this column group in case the underlying column group does not knownColOrg- The number of overall columns in the host CompressedMatrixBlock.- Returns:
 - a list of split column groups
 
 
- 
toString
public String toString()
- Overrides:
 toStringin classAColGroupValue
 
 - 
 
 -