Class ADictionary
- java.lang.Object
- 
- org.apache.sysds.runtime.compress.colgroup.dictionary.ADictionary
 
- 
- All Implemented Interfaces:
- Serializable
 - Direct Known Subclasses:
- Dictionary,- MatrixBlockDictionary,- QDictionary
 
 public abstract class ADictionary extends Object implements Serializable This dictionary class aims to encapsulate the storage and operations over unique tuple values of a column group.- See Also:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description ADictionary()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidaddToEntry(double[] v, int fr, int to, int nCol)Copies and adds the dictionary entry from this dictionary to the d dictionaryabstract voidaddToEntry(double[] v, int fr, int to, int nCol, int rep)copies and adds the dictonary entry from this dictionary yo the d dictionary rep times.abstract voidaddToEntryVectorized(double[] v, int f1, int f2, int f3, int f4, int f5, int f6, int f7, int f8, int t1, int t2, int t3, int t4, int t5, int t6, int t7, int t8, int nCol)abstract doubleaggregate(double init, Builtin fn)Aggregate all the contained values, useful in value only computations where the operation is iterating through all values contained in the dictionary.abstract voidaggregateCols(double[] c, Builtin fn, int[] colIndexes)Aggregates the columns into the target double array provided.abstract voidaggregateColsWithReference(double[] c, Builtin fn, int[] colIndexes, double[] reference, boolean def)Aggregates the columns into the target double array provided.abstract double[]aggregateRows(Builtin fn, int nCol)Aggregate all entries in the rows.abstract double[]aggregateRowsWithDefault(Builtin fn, double[] defaultTuple)Aggregate all entries in the rows of the dictionary with a extra cell in the end that contains the aggregate of the given defaultTuple.abstract double[]aggregateRowsWithReference(Builtin fn, double[] reference)Aggregate all entries in the rows with an offset value reference added.abstract doubleaggregateWithReference(double init, Builtin fn, double[] reference, boolean def)Aggregate all the contained values, with a reference offset.abstract ADictionaryapplyScalarOp(ScalarOperator op)Allocate a new dictionary and applies the scalar operation on each cell of the to then return the new dictionary.abstract ADictionaryapplyScalarOpWithReference(ScalarOperator op, double[] reference, double[] newReference)Allocate a new dictionary and apply the scalar operation on each cell to then return a new dictionary.abstract ADictionaryapplyUnaryOp(UnaryOperator op)Allocate a new dictionary and apply the unary operator on each cell.abstract ADictionaryapplyUnaryOpWithReference(UnaryOperator op, double[] reference, double[] newReference)Allocate a new dictionary and apply the scalar operation on each cell to then return a new dictionary.abstract ADictionarybinOpLeft(BinaryOperator op, double[] v, int[] colIndexes)Apply binary row operation on the left side in placeabstract ADictionarybinOpLeftWithReference(BinaryOperator op, double[] v, int[] colIndexes, double[] reference, double[] newReference)Apply the binary operator such that each value is offset by the reference before application.abstract ADictionarybinOpRight(BinaryOperator op, double[] v)Apply binary row operation on the right side.abstract ADictionarybinOpRight(BinaryOperator op, double[] v, int[] colIndexes)Apply binary row operation on the right side.abstract ADictionarybinOpRightWithReference(BinaryOperator op, double[] v, int[] colIndexes, double[] reference, double[] newReference)Apply the binary operator such that each value is offset by the reference before application.CM_COV_ObjectcentralMoment(ValueFunction fn, int[] counts, int nRows)Central moment function to calculate the central moment of this column group.abstract CM_COV_ObjectcentralMoment(CM_COV_Object ret, ValueFunction fn, int[] counts, int nRows)Central moment function to calculate the central moment of this column group.CM_COV_ObjectcentralMomentWithReference(ValueFunction fn, int[] counts, double reference, int nRows)Central moment function to calculate the central moment of this column group with a reference offset on each tuple.abstract CM_COV_ObjectcentralMomentWithReference(CM_COV_Object ret, ValueFunction fn, int[] counts, double reference, int nRows)Central moment function to calculate the central moment of this column group with a reference offset on each tuple.abstract ADictionaryclone()Returns a deep clone of the dictionary.voidcolProduct(double[] res, int[] counts, int[] colIndexes)Calculate the column product of the dictionary weighted by counts.abstract voidcolSum(double[] c, int[] counts, int[] colIndexes)Get the column sum of the values contained in the dictionaryabstract voidcolSumSq(double[] c, int[] counts, int[] colIndexes)Get the column sum of the values contained in the dictionaryabstract voidcolSumSqWithReference(double[] c, int[] counts, int[] colIndexes, double[] reference)Get the column sum of the values contained in the dictionary with an offset reference value added to each cell.abstract booleancontainsValue(double pattern)Detect if the dictionary contains a specific value.abstract booleancontainsValueWithReference(double pattern, double[] reference)Detect if the dictionary contains a specific value with reference offset.abstract longgetExactSizeOnDisk()Calculate the space consumption if the dictionary is stored on disk.abstract longgetInMemorySize()Returns the memory usage of the dictionary.abstract MatrixBlockDictionarygetMBDict(int nCol)Get this dictionary as a MatrixBlock dictionary.abstract longgetNumberNonZeros(int[] counts, int nCol)Calculate the number of non zeros in the dictionary.abstract longgetNumberNonZerosWithReference(int[] counts, double[] reference, int nRows)Calculate the number of non zeros in the dictionary.abstract intgetNumberOfValues(int ncol)Get the number of distinct tuples given that the column group has n columnsabstract doublegetSparsity()Get the sparsity of the dictionary.abstract StringgetString(int colIndexes)Get a string representation of the dictionary, that considers the layout of the data.abstract doublegetValue(int i)Get Specific value contained in the dictionary at index.abstract double[]getValues()Get all the values contained in the dictionary as a linearized double array.abstract ADictionaryinplaceScalarOp(ScalarOperator op)Applies the scalar operation on the dictionary.abstract booleanisLossy()Specify if the Dictionary is lossy.abstract voidmultiplyScalar(double v, double[] ret, int off, int dictIdx, int[] cols)Multiply the v value with the dictionary entry at dictIdx and add it to the ret matrix at the columns specified in the int array.abstract ADictionarypreaggValuesFromDense(int numVals, int[] colIndexes, int[] aggregateColumns, double[] b, int cut)Pre Aggregate values for Right Matrix Multiplication.abstract voidproduct(double[] ret, int[] counts, int nCol)Calculate the product of the dictionary weighted by counts.abstract voidproductWithDefault(double[] ret, int[] counts, double[] def, int defCount)Calculate the product of the dictionary weighted by counts with a default value added .abstract voidproductWithReference(double[] ret, int[] counts, double[] reference, int refCount)Calculate the product of the dictionary weighted by counts and offset by referenceabstract ADictionaryreplace(double pattern, double replace, int nCol)Make a copy of the values, and replace all values that match pattern with replacement value.abstract ADictionaryreplaceWithReference(double pattern, double replace, double[] reference)Make a copy of the values, and replace all values that match pattern with replacement value.abstract ADictionaryrexpandCols(int max, boolean ignore, boolean cast, int nCol)Rexpand the dictionary (one hot encode)abstract ADictionaryrexpandColsWithReference(int max, boolean ignore, boolean cast, double reference)Rexpand the dictionary (one hot encode)abstract ADictionaryscaleTuples(int[] scaling, int nCol)Scale all tuples contained in the dictionary by the scaling factor given in the int list.abstract ADictionarysliceOutColumnRange(int idxStart, int idxEnd, int previousNumberOfColumns)Modify the dictionary by removing columns not within the index range.abstract ADictionarysubtractTuple(double[] tuple)Allocate a new dictionary where the tuple given is subtracted from all tuples in the previous dictionary.abstract doublesum(int[] counts, int nCol)Get the sum of the values contained in the dictionaryabstract double[]sumAllRowsToDouble(int nrColumns)Method used as a pre-aggregate of each tuple in the dictionary, to single double values.abstract double[]sumAllRowsToDoubleSq(int nrColumns)Method used as a pre-aggregate of each tuple in the dictionary, to single double values.abstract double[]sumAllRowsToDoubleSqWithDefault(double[] defaultTuple)Method used as a pre-aggregate of each tuple in the dictionary, to single double values.abstract double[]sumAllRowsToDoubleSqWithReference(double[] reference)Method used as a pre-aggregate of each tuple in the dictionary, to single double values.abstract double[]sumAllRowsToDoubleWithDefault(double[] defaultTuple)Do exactly the same as the sumAllRowsToDouble but also sum the array given to a extra index in the end of the array.abstract double[]sumAllRowsToDoubleWithReference(double[] reference)Method used as a pre-aggregate of each tuple in the dictionary, to single double values with a reference.abstract doublesumSq(int[] counts, int nCol)Get the square sum of the values contained in the dictionaryabstract doublesumSqWithReference(int[] counts, double[] reference)Get the square sum of the values contained in the dictionary with a reference offset on each value.abstract voidwrite(DataOutput out)Write the dictionary to a DataOutput.
 
- 
- 
- 
Method Detail- 
getValuespublic abstract double[] getValues() Get all the values contained in the dictionary as a linearized double array.- Returns:
- linearized double array
 
 - 
getValuepublic abstract double getValue(int i) Get Specific value contained in the dictionary at index.- Parameters:
- i- The index to extract the value from
- Returns:
- The value contained at the index
 
 - 
getInMemorySizepublic abstract long getInMemorySize() Returns the memory usage of the dictionary.- Returns:
- a long value in number of bytes for the dictionary.
 
 - 
aggregatepublic abstract double aggregate(double init, Builtin fn)Aggregate all the contained values, useful in value only computations where the operation is iterating through all values contained in the dictionary.- Parameters:
- init- The initial Value, in cases such as Max value, this could be -infinity
- fn- The Function to apply to values
- Returns:
- The aggregated value as a double.
 
 - 
aggregateWithReferencepublic abstract double aggregateWithReference(double init, Builtin fn, double[] reference, boolean def)Aggregate all the contained values, with a reference offset.- Parameters:
- init- The initial value, in cases such as Max value this could be -infinity.
- fn- The function to apply to the values
- reference- The reference offset to each value in the dictionary
- def- If the reference should be treated as an instance of only as reference
- Returns:
- The aggregated value as a double.
 
 - 
aggregateRowspublic abstract double[] aggregateRows(Builtin fn, int nCol) Aggregate all entries in the rows.- Parameters:
- fn- The aggregate function
- nCol- The number of columns contained in the dictionary.
- Returns:
- Aggregates for this dictionary tuples.
 
 - 
aggregateRowsWithDefaultpublic abstract double[] aggregateRowsWithDefault(Builtin fn, double[] defaultTuple) Aggregate all entries in the rows of the dictionary with a extra cell in the end that contains the aggregate of the given defaultTuple.- Parameters:
- fn- The aggregate function
- defaultTuple- The default tuple to aggregate in last cell
- Returns:
- Aggregates for this dictionary tuples.
 
 - 
aggregateRowsWithReferencepublic abstract double[] aggregateRowsWithReference(Builtin fn, double[] reference) Aggregate all entries in the rows with an offset value reference added.- Parameters:
- fn- The aggregate function
- reference- The reference offset to each value in the dictionary
- Returns:
- Aggregates for this dictionary tuples.
 
 - 
aggregateColspublic abstract void aggregateCols(double[] c, Builtin fn, int[] colIndexes)Aggregates the columns into the target double array provided.- Parameters:
- c- The target double array, this contains the full number of columns, therefore the colIndexes for this specific dictionary is needed.
- fn- The function to apply to individual columns
- colIndexes- The mapping to the target columns from the individual columns
 
 - 
aggregateColsWithReferencepublic abstract void aggregateColsWithReference(double[] c, Builtin fn, int[] colIndexes, double[] reference, boolean def)Aggregates the columns into the target double array provided.- Parameters:
- c- The target double array, this contains the full number of columns, therefore the colIndexes for this specific dictionary is needed.
- fn- The function to apply to individual columns
- reference- The reference offset values to add to each cell.
- colIndexes- The mapping to the target columns from the individual columns
- def- If the reference should be treated as a tuple as well
 
 - 
applyScalarOppublic abstract ADictionary applyScalarOp(ScalarOperator op) Allocate a new dictionary and applies the scalar operation on each cell of the to then return the new dictionary.- Parameters:
- op- The operator.
- Returns:
- The new dictionary to return.
 
 - 
applyUnaryOppublic abstract ADictionary applyUnaryOp(UnaryOperator op) Allocate a new dictionary and apply the unary operator on each cell.- Parameters:
- op- the operator.
- Returns:
- The new dictionary to return.
 
 - 
applyScalarOpWithReferencepublic abstract ADictionary applyScalarOpWithReference(ScalarOperator op, double[] reference, double[] newReference) Allocate a new dictionary and apply the scalar operation on each cell to then return a new dictionary. outValues[j] = op(this.values[j] + reference[i]) - newReference[i]- Parameters:
- op- The operator to apply to each cell.
- reference- The reference value to add before the operator.
- newReference- The reference value to subtract after the operator.
- Returns:
- A New Dictionary.
 
 - 
applyUnaryOpWithReferencepublic abstract ADictionary applyUnaryOpWithReference(UnaryOperator op, double[] reference, double[] newReference) Allocate a new dictionary and apply the scalar operation on each cell to then return a new dictionary. outValues[j] = op(this.values[j] + reference[i]) - newReference[i]- Parameters:
- op- The unary operator to apply to each cell.
- reference- The reference value to add before the operator.
- newReference- The reference value to subtract after the operator.
- Returns:
- A New Dictionary.
 
 - 
inplaceScalarOppublic abstract ADictionary inplaceScalarOp(ScalarOperator op) Applies the scalar operation on the dictionary. Note that this operation modifies the underlying data, and normally require a copy of the original Dictionary to preserve old objects.- Parameters:
- op- The operator to apply to the dictionary values.
- Returns:
- this dictionary with modified values.
 
 - 
binOpLeftpublic abstract ADictionary binOpLeft(BinaryOperator op, double[] v, int[] colIndexes) Apply binary row operation on the left side in place- Parameters:
- op- The operation to this dictionary
- v- The values to use on the left hand side.
- colIndexes- The column indexes to consider inside v.
- Returns:
- A new dictionary containing the updated values.
 
 - 
binOpLeftWithReferencepublic abstract ADictionary binOpLeftWithReference(BinaryOperator op, double[] v, int[] colIndexes, double[] reference, double[] newReference) Apply the binary operator such that each value is offset by the reference before application. Then put the result into the new dictionary, but offset it by the new reference. outValues[j] = op(v[colIndexes[i]], this.values[j] + reference[i]) - newReference[i]- Parameters:
- op- The operation to apply on the dictionary values.
- v- The values to use on the left side of the operator.
- colIndexes- The column indexes to use.
- reference- The reference value to add before operator.
- newReference- The reference value to subtract after operator.
- Returns:
- A new dictionary.
 
 - 
binOpRightpublic abstract ADictionary binOpRight(BinaryOperator op, double[] v, int[] colIndexes) Apply binary row operation on the right side.- Parameters:
- op- The operation to this dictionary
- v- The values to use on the right hand side.
- colIndexes- The column indexes to consider inside v.
- Returns:
- A new dictionary containing the updated values.
 
 - 
binOpRightpublic abstract ADictionary binOpRight(BinaryOperator op, double[] v) Apply binary row operation on the right side.- Parameters:
- op- The operation to this dictionary
- v- The values to apply on the dictionary (same number of cols as the dictionary)
- Returns:
- A new dictionary containing the updated values.
 
 - 
binOpRightWithReferencepublic abstract ADictionary binOpRightWithReference(BinaryOperator op, double[] v, int[] colIndexes, double[] reference, double[] newReference) Apply the binary operator such that each value is offset by the reference before application. Then put the result into the new dictionary, but offset it by the new reference. outValues[j] = op(this.values[j] + reference[i], v[colIndexes[i]]) - newReference[i]- Parameters:
- op- The operation to apply on the dictionary values.
- v- The values to use on the right side of the operator.
- colIndexes- The column indexes to use.
- reference- The reference value to add before operator.
- newReference- The reference value to subtract after operator.
- Returns:
- A new dictionary.
 
 - 
clonepublic abstract ADictionary clone() Returns a deep clone of the dictionary.
 - 
writepublic abstract void write(DataOutput out) throws IOException Write the dictionary to a DataOutput.- Parameters:
- out- the output sink to write the dictionary to.
- Throws:
- IOException- if the sink fails.
 
 - 
getExactSizeOnDiskpublic abstract long getExactSizeOnDisk() Calculate the space consumption if the dictionary is stored on disk.- Returns:
- the long count of bytes to store the dictionary.
 
 - 
isLossypublic abstract boolean isLossy() Specify if the Dictionary is lossy.- Returns:
- A boolean
 
 - 
getNumberOfValuespublic abstract int getNumberOfValues(int ncol) Get the number of distinct tuples given that the column group has n columns- Parameters:
- ncol- The number of Columns in the ColumnGroup.
- Returns:
- the number of value tuples contained in the dictionary.
 
 - 
sumAllRowsToDoublepublic abstract double[] sumAllRowsToDouble(int nrColumns) Method used as a pre-aggregate of each tuple in the dictionary, to single double values. Note if the number of columns is one the actual dictionaries values are simply returned.- Parameters:
- nrColumns- The number of columns in the ColGroup to know how to get the values from the dictionary.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
sumAllRowsToDoubleWithDefaultpublic abstract double[] sumAllRowsToDoubleWithDefault(double[] defaultTuple) Do exactly the same as the sumAllRowsToDouble but also sum the array given to a extra index in the end of the array.- Parameters:
- defaultTuple- The default row to sum in the end index returned.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
sumAllRowsToDoubleWithReferencepublic abstract double[] sumAllRowsToDoubleWithReference(double[] reference) Method used as a pre-aggregate of each tuple in the dictionary, to single double values with a reference.- Parameters:
- reference- The reference values to add to each cell.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
sumAllRowsToDoubleSqpublic abstract double[] sumAllRowsToDoubleSq(int nrColumns) Method used as a pre-aggregate of each tuple in the dictionary, to single double values. Note if the number of columns is one the actual dictionaries values are simply returned.- Parameters:
- nrColumns- The number of columns in the ColGroup to know how to get the values from the dictionary.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
sumAllRowsToDoubleSqWithDefaultpublic abstract double[] sumAllRowsToDoubleSqWithDefault(double[] defaultTuple) Method used as a pre-aggregate of each tuple in the dictionary, to single double values. But adds another cell to the return with an extra value that is the sum of the given defaultTuple.- Parameters:
- defaultTuple- The default row to sum in the end index returned.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
sumAllRowsToDoubleSqWithReferencepublic abstract double[] sumAllRowsToDoubleSqWithReference(double[] reference) Method used as a pre-aggregate of each tuple in the dictionary, to single double values.- Parameters:
- reference- The reference values to add to each cell.
- Returns:
- a double array containing the row sums from this dictionary.
 
 - 
colSumpublic abstract void colSum(double[] c, int[] counts, int[] colIndexes)Get the column sum of the values contained in the dictionary- Parameters:
- c- The output array allocated to contain all column groups output.
- counts- The counts of the individual tuples.
- colIndexes- The columns indexes of the parent column group, this indicate where to put the column sum into the c output.
 
 - 
colSumSqpublic abstract void colSumSq(double[] c, int[] counts, int[] colIndexes)Get the column sum of the values contained in the dictionary- Parameters:
- c- The output array allocated to contain all column groups output.
- counts- The counts of the individual tuples.
- colIndexes- The columns indexes of the parent column group, this indicate where to put the column sum into the c output.
 
 - 
colSumSqWithReferencepublic abstract void colSumSqWithReference(double[] c, int[] counts, int[] colIndexes, double[] reference)Get the column sum of the values contained in the dictionary with an offset reference value added to each cell.- Parameters:
- c- The output array allocated to contain all column groups output.
- counts- The counts of the individual tuples.
- colIndexes- The columns indexes of the parent column group, this indicate where to put the column sum into the c output.
- reference- The reference values to add to each cell.
 
 - 
sumpublic abstract double sum(int[] counts, int nCol)Get the sum of the values contained in the dictionary- Parameters:
- counts- The counts of the individual tuples
- nCol- The number of columns contained
- Returns:
- The sum scaled by the counts provided.
 
 - 
sumSqpublic abstract double sumSq(int[] counts, int nCol)Get the square sum of the values contained in the dictionary- Parameters:
- counts- The counts of the individual tuples
- nCol- The number of columns contained
- Returns:
- The square sum scaled by the counts provided.
 
 - 
sumSqWithReferencepublic abstract double sumSqWithReference(int[] counts, double[] reference)Get the square sum of the values contained in the dictionary with a reference offset on each value.- Parameters:
- counts- The counts of the individual tuples
- reference- The reference value
- Returns:
- The square sum scaled by the counts and reference.
 
 - 
getStringpublic abstract String getString(int colIndexes) Get a string representation of the dictionary, that considers the layout of the data.- Parameters:
- colIndexes- The number of columns in the dictionary.
- Returns:
- A string that is nicer to print.
 
 - 
sliceOutColumnRangepublic abstract ADictionary sliceOutColumnRange(int idxStart, int idxEnd, int previousNumberOfColumns) Modify the dictionary by removing columns not within the index range.- Parameters:
- idxStart- The column index to start at.
- idxEnd- The column index to end at (not inclusive)
- previousNumberOfColumns- The number of columns contained in the dictionary.
- Returns:
- A dictionary containing the sliced out columns values only.
 
 - 
containsValuepublic abstract boolean containsValue(double pattern) Detect if the dictionary contains a specific value.- Parameters:
- pattern- The value to search for
- Returns:
- true if the value is contained else false.
 
 - 
containsValueWithReferencepublic abstract boolean containsValueWithReference(double pattern, double[] reference)Detect if the dictionary contains a specific value with reference offset.- Parameters:
- pattern- The pattern/ value to search for
- reference- The reference double array.
- Returns:
- true if the value is contained else false.
 
 - 
getNumberNonZerospublic abstract long getNumberNonZeros(int[] counts, int nCol)Calculate the number of non zeros in the dictionary. The number of non zeros should be scaled with the counts given. This gives the exact number of non zero values in the parent column group.- Parameters:
- counts- The counts of each dictionary entry
- nCol- The number of columns in this dictionary
- Returns:
- The nonZero count
 
 - 
getNumberNonZerosWithReferencepublic abstract long getNumberNonZerosWithReference(int[] counts, double[] reference, int nRows)Calculate the number of non zeros in the dictionary. Each value in the dictionary should be added to the reference value. The number of non zeros should be scaled with the given counts.- Parameters:
- counts- The Counts of each dict entry.
- reference- The reference vector.
- nRows- The number of rows in the input.
- Returns:
- The NonZero Count.
 
 - 
addToEntrypublic abstract void addToEntry(double[] v, int fr, int to, int nCol)Copies and adds the dictionary entry from this dictionary to the d dictionary- Parameters:
- v- the target dictionary (dense double array)
- fr- the from index
- to- the to index
- nCol- the number of columns
 
 - 
addToEntrypublic abstract void addToEntry(double[] v, int fr, int to, int nCol, int rep)copies and adds the dictonary entry from this dictionary yo the d dictionary rep times.- Parameters:
- v- the target dictionary (dense double array)
- fr- the from index
- to- the to index
- nCol- the number of columns
- rep- the number of repetitions to apply (simply multiply do not loop)
 
 - 
addToEntryVectorizedpublic abstract void addToEntryVectorized(double[] v, int f1, int f2, int f3, int f4, int f5, int f6, int f7, int f8, int t1, int t2, int t3, int t4, int t5, int t6, int t7, int t8, int nCol)
 - 
subtractTuplepublic abstract ADictionary subtractTuple(double[] tuple) Allocate a new dictionary where the tuple given is subtracted from all tuples in the previous dictionary.- Parameters:
- tuple- a double list representing a tuple, it is given that the tuple with is the same as this dictionaries.
- Returns:
- a new instance of dictionary with the tuple subtracted.
 
 - 
getMBDictpublic abstract MatrixBlockDictionary getMBDict(int nCol) Get this dictionary as a MatrixBlock dictionary. This allows us to use optimized kernels coded elsewhere in the system, such as matrix multiplication. Return null if the matrix is empty.- Parameters:
- nCol- The number of columns contained in this column group.
- Returns:
- A Dictionary containing a MatrixBlock.
 
 - 
scaleTuplespublic abstract ADictionary scaleTuples(int[] scaling, int nCol) Scale all tuples contained in the dictionary by the scaling factor given in the int list.- Parameters:
- scaling- The amount to multiply the given tuples with
- nCol- The number of columns contained in this column group.
- Returns:
- A New dictionary (since we don't want to modify the underlying dictionary)
 
 - 
preaggValuesFromDensepublic abstract ADictionary preaggValuesFromDense(int numVals, int[] colIndexes, int[] aggregateColumns, double[] b, int cut) Pre Aggregate values for Right Matrix Multiplication.- Parameters:
- numVals- The number of values contained in this dictionary
- colIndexes- The column indexes that is associated with the parent column group
- aggregateColumns- The column to aggregate, this is preprocessed, to find remove consideration for empty columns
- b- The values in the right hand side matrix
- cut- The number of columns in b.
- Returns:
- A new dictionary with the pre aggregated values.
 
 - 
replacepublic abstract ADictionary replace(double pattern, double replace, int nCol) Make a copy of the values, and replace all values that match pattern with replacement value. If needed add a new column index.- Parameters:
- pattern- The value to look for
- replace- The value to replace the other value with
- nCol- The number of columns contained in the dictionary.
- Returns:
- A new Column Group, reusing the index structure but with new values.
 
 - 
replaceWithReferencepublic abstract ADictionary replaceWithReference(double pattern, double replace, double[] reference) Make a copy of the values, and replace all values that match pattern with replacement value. If needed add a new column index. With reference such that each value in the dict is considered offset by the values contained in the reference.- Parameters:
- pattern- The value to look for
- replace- The value to replace the other value with
- reference- The reference tuple to add to all entries when replacing
- Returns:
- A new Column Group, reusing the index structure but with new values.
 
 - 
productpublic abstract void product(double[] ret, int[] counts, int nCol)Calculate the product of the dictionary weighted by counts.- Parameters:
- ret- The result dense double array (containing one value)
- counts- The count of individual tuples
- nCol- Number of columns in the dictionary.
 
 - 
productWithDefaultpublic abstract void productWithDefault(double[] ret, int[] counts, double[] def, int defCount)Calculate the product of the dictionary weighted by counts with a default value added .- Parameters:
- ret- The result dense double array (containing one value)
- counts- The count of individual tuples
- def- The default tuple
- defCount- The count of the default tuple
 
 - 
productWithReferencepublic abstract void productWithReference(double[] ret, int[] counts, double[] reference, int refCount)Calculate the product of the dictionary weighted by counts and offset by reference- Parameters:
- ret- The result dense double array (containing one value)
- counts- The counts of each entry in the dictionary
- reference- The reference value.
- refCount- The number of occurences of the ref value.
 
 - 
colProductpublic void colProduct(double[] res, int[] counts, int[] colIndexes)Calculate the column product of the dictionary weighted by counts.- Parameters:
- res- The result vector to put the result into
- counts- The weighted count of individual tuples
- colIndexes- The column indexes.
 
 - 
centralMomentpublic CM_COV_Object centralMoment(ValueFunction fn, int[] counts, int nRows) Central moment function to calculate the central moment of this column group. MUST be on a single column dictionary.- Parameters:
- fn- The value function to apply
- counts- The weight of individual tuples
- nRows- The number of rows in total of the column group
- Returns:
- The central moment Object
 
 - 
centralMomentpublic abstract CM_COV_Object centralMoment(CM_COV_Object ret, ValueFunction fn, int[] counts, int nRows) Central moment function to calculate the central moment of this column group. MUST be on a single column dictionary.- Parameters:
- ret- The Central Moment object to be modified and returned
- fn- The value function to apply
- counts- The weight of individual tuples
- nRows- The number of rows in total of the column group
- Returns:
- The central moment Object
 
 - 
centralMomentWithReferencepublic CM_COV_Object centralMomentWithReference(ValueFunction fn, int[] counts, double reference, int nRows) Central moment function to calculate the central moment of this column group with a reference offset on each tuple. MUST be on a single column dictionary.- Parameters:
- fn- The value function to apply
- counts- The weight of individual tuples
- reference- The reference values to offset the tuples with
- nRows- The number of rows in total of the column group
- Returns:
- The central moment Object
 
 - 
centralMomentWithReferencepublic abstract CM_COV_Object centralMomentWithReference(CM_COV_Object ret, ValueFunction fn, int[] counts, double reference, int nRows) Central moment function to calculate the central moment of this column group with a reference offset on each tuple. MUST be on a single column dictionary.- Parameters:
- ret- The Central Moment object to be modified and returned
- fn- The value function to apply
- counts- The weight of individual tuples
- reference- The reference values to offset the tuples with
- nRows- The number of rows in total of the column group
- Returns:
- The central moment Object
 
 - 
rexpandColspublic abstract ADictionary rexpandCols(int max, boolean ignore, boolean cast, int nCol) Rexpand the dictionary (one hot encode)- Parameters:
- max- the tuple width of the output
- ignore- If we should ignore zero and negative values
- cast- If we should cast all double values to whole integer values
- nCol- The number of columns in the dictionary already (should be 1)
- Returns:
- A new dictionary
 
 - 
rexpandColsWithReferencepublic abstract ADictionary rexpandColsWithReference(int max, boolean ignore, boolean cast, double reference) Rexpand the dictionary (one hot encode)- Parameters:
- max- the tuple width of the output
- ignore- If we should ignore zero and negative values
- cast- If we should cast all double values to whole integer values
- reference- A reference value to add to all tuples before expanding
- Returns:
- A new dictionary
 
 - 
getSparsitypublic abstract double getSparsity() Get the sparsity of the dictionary.- Returns:
- a sparsity between 0 and 1
 
 - 
multiplyScalarpublic abstract void multiplyScalar(double v, double[] ret, int off, int dictIdx, int[] cols)Multiply the v value with the dictionary entry at dictIdx and add it to the ret matrix at the columns specified in the int array.- Parameters:
- v- Value to multiply
- ret- Output dense double array location
- off- Offset into the ret array that the "row" output starts at
- dictIdx- The dictionary entry to multiply.
- cols- The columns to multiply into of the output.
 
 
- 
 
-