You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by mb...@apache.org on 2017/02/08 15:37:11 UTC
incubator-systemml git commit: [SYSTEMML-449] Fix javadoc issues of
compressed linear algebra v2
Repository: incubator-systemml
Updated Branches:
refs/heads/master 37a215bc3 -> f8d707788
[SYSTEMML-449] Fix javadoc issues of compressed linear algebra v2
Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/f8d70778
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/f8d70778
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/f8d70778
Branch: refs/heads/master
Commit: f8d707788b106108dadcb9f7796cfd3c591bb294
Parents: 37a215b
Author: Matthias Boehm <mb...@gmail.com>
Authored: Wed Feb 8 16:36:53 2017 +0100
Committer: Matthias Boehm <mb...@gmail.com>
Committed: Wed Feb 8 16:36:53 2017 +0100
----------------------------------------------------------------------
.../apache/sysml/runtime/compress/BitmapEncoder.java | 12 ++++++------
.../apache/sysml/runtime/compress/ColGroupOffset.java | 4 ++--
.../apache/sysml/runtime/compress/ColGroupValue.java | 4 ++--
.../runtime/compress/cocode/PlanningCoCodingGroup.java | 8 ++++----
.../sysml/runtime/compress/utils/IntArrayList.java | 3 ++-
5 files changed, 16 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f8d70778/src/main/java/org/apache/sysml/runtime/compress/BitmapEncoder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/runtime/compress/BitmapEncoder.java b/src/main/java/org/apache/sysml/runtime/compress/BitmapEncoder.java
index b27112f..2def9f6 100644
--- a/src/main/java/org/apache/sysml/runtime/compress/BitmapEncoder.java
+++ b/src/main/java/org/apache/sysml/runtime/compress/BitmapEncoder.java
@@ -94,9 +94,9 @@ public class BitmapEncoder
* <b>NOTE: This method must be kept in sync with {@link BitmapDecoderRLE}
* !</b>
*
- * @param offsets
- * uncompressed contents of the bitmap, expressed as a list of
- * the offsets of different bits
+ * @param offsets uncompressed offset list
+ * @param len logical length of the given offset list
+ *
* @return compressed version of said bitmap
*/
public static char[] genRLEBitmap(int[] offsets, int len) {
@@ -187,9 +187,9 @@ public class BitmapEncoder
* Encodes the bitmap in blocks of offsets. Within each block, the bits are
* stored as absolute offsets from the start of the block.
*
- * @param offsets
- * uncompressed contents of the bitmap, expressed as a list of
- * the offsets of different bits
+ * @param offsets uncompressed offset list
+ * @param len logical length of the given offset list
+ *
* @return compressed version of said bitmap
*/
public static char[] genOffsetBitmap(int[] offsets, int len)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f8d70778/src/main/java/org/apache/sysml/runtime/compress/ColGroupOffset.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/runtime/compress/ColGroupOffset.java b/src/main/java/org/apache/sysml/runtime/compress/ColGroupOffset.java
index e49c1a3..41d7184 100644
--- a/src/main/java/org/apache/sysml/runtime/compress/ColGroupOffset.java
+++ b/src/main/java/org/apache/sysml/runtime/compress/ColGroupOffset.java
@@ -88,12 +88,12 @@ public abstract class ColGroupOffset extends ColGroupValue
/**
* Constructor for subclass methods that need to create shallow copies
*
- * @param type compression type
* @param colIndices
* raw column index information
* @param numRows
* number of rows in the block
- * @param zeros ?
+ * @param zeros
+ * indicator if column group contains zero values
* @param values
* set of distinct values for the block (associated bitmaps are
* kept in the subclass)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f8d70778/src/main/java/org/apache/sysml/runtime/compress/ColGroupValue.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/runtime/compress/ColGroupValue.java b/src/main/java/org/apache/sysml/runtime/compress/ColGroupValue.java
index b3b5e80..928296d 100644
--- a/src/main/java/org/apache/sysml/runtime/compress/ColGroupValue.java
+++ b/src/main/java/org/apache/sysml/runtime/compress/ColGroupValue.java
@@ -56,7 +56,7 @@ public abstract class ColGroupValue extends ColGroup
}
/**
- * Main constructor. Stores the headers for the individual bitmaps.
+ * Stores the headers for the individual bitmaps.
*
* @param colIndices
* indices (within the block) of the columns included in this
@@ -296,7 +296,7 @@ public abstract class ColGroupValue extends ColGroup
* @param result output matrix block
* @param rl row lower index, inclusive
* @param ru row upper index, exclusive
- * @throws DMLRuntimeException
+ * @throws DMLRuntimeException on invalid inputs
*/
public abstract void unaryAggregateOperations(AggregateUnaryOperator op, MatrixBlock result, int rl, int ru)
throws DMLRuntimeException;
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f8d70778/src/main/java/org/apache/sysml/runtime/compress/cocode/PlanningCoCodingGroup.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/runtime/compress/cocode/PlanningCoCodingGroup.java b/src/main/java/org/apache/sysml/runtime/compress/cocode/PlanningCoCodingGroup.java
index caaa271..4e4c40d 100644
--- a/src/main/java/org/apache/sysml/runtime/compress/cocode/PlanningCoCodingGroup.java
+++ b/src/main/java/org/apache/sysml/runtime/compress/cocode/PlanningCoCodingGroup.java
@@ -54,10 +54,10 @@ public class PlanningCoCodingGroup
/**
* Constructor for merging two disjoint groups of columns
*
- * @param grp1 first group of columns to merge
- * @param grp2 second group to merge
- * @param bitmapSizeEstimator bitmap size estimator
- * @param numRowsWeight numRows x sparsity
+ * @param grp1 first column group to merge
+ * @param grp2 second column group to merge
+ * @param estim bitmap size estimator
+ * @param numRows number of rows
*/
public PlanningCoCodingGroup(PlanningCoCodingGroup grp1, PlanningCoCodingGroup grp2,
CompressedSizeEstimator estim, int numRows)
http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/f8d70778/src/main/java/org/apache/sysml/runtime/compress/utils/IntArrayList.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/runtime/compress/utils/IntArrayList.java b/src/main/java/org/apache/sysml/runtime/compress/utils/IntArrayList.java
index 0f2f091..93fcb70 100644
--- a/src/main/java/org/apache/sysml/runtime/compress/utils/IntArrayList.java
+++ b/src/main/java/org/apache/sysml/runtime/compress/utils/IntArrayList.java
@@ -71,7 +71,8 @@ public class IntArrayList
* physically larger than the actual length of the offset lists. Use size()
* to obtain the actual length.
*
- * @return
+ * @return integer array of offsets, the physical array length
+ * may be larger than the length of the offset list
*/
public int[] extractValues() {
if( _size == 1 )