You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by sm...@apache.org on 2016/05/03 01:21:49 UTC

mahout git commit: NoJira: Fix Javadocs Warnings

Repository: mahout
Updated Branches:
  refs/heads/master 4c85d6a48 -> 6ac833bdc


NoJira: Fix Javadocs Warnings


Project: http://git-wip-us.apache.org/repos/asf/mahout/repo
Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/6ac833bd
Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/6ac833bd
Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/6ac833bd

Branch: refs/heads/master
Commit: 6ac833bdc78713effd3f94b97117a5f6cd6ffb7e
Parents: 4c85d6a
Author: smarthi <sm...@apache.org>
Authored: Mon May 2 19:21:24 2016 -0400
Committer: smarthi <sm...@apache.org>
Committed: Mon May 2 19:21:24 2016 -0400

----------------------------------------------------------------------
 .../org/apache/mahout/h2obindings/ops/AewUnary.java   | 13 ++++++-------
 .../apache/mahout/h2obindings/ops/CbindScalar.java    |  8 +++-----
 math/src/main/java/org/apache/mahout/math/Vector.java | 14 +++++++++-----
 .../org/apache/mahout/math/hadoop/MathHelper.java     | 12 ++++++------
 4 files changed, 24 insertions(+), 23 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mahout/blob/6ac833bd/h2o/src/main/java/org/apache/mahout/h2obindings/ops/AewUnary.java
----------------------------------------------------------------------
diff --git a/h2o/src/main/java/org/apache/mahout/h2obindings/ops/AewUnary.java b/h2o/src/main/java/org/apache/mahout/h2obindings/ops/AewUnary.java
index dd6d66e..6e9cd82 100644
--- a/h2o/src/main/java/org/apache/mahout/h2obindings/ops/AewUnary.java
+++ b/h2o/src/main/java/org/apache/mahout/h2obindings/ops/AewUnary.java
@@ -18,15 +18,14 @@
 package org.apache.mahout.h2obindings.ops;
 
 import org.apache.mahout.h2obindings.drm.H2ODrm;
-
+import scala.Function1;
 import water.MRTask;
-import water.fvec.Frame;
-import water.fvec.Vec;
 import water.fvec.Chunk;
+import water.fvec.Frame;
 import water.fvec.NewChunk;
+import water.fvec.Vec;
 
 import java.io.Serializable;
-import scala.Function1;
 
 /**
  * MapBlock operator.
@@ -38,7 +37,7 @@ public class AewUnary {
    *
    * @param drmA DRM representing matrix A.
    * @param f UnaryFunc f, that accepts and Double and returns a Double.
-   * @param z Whether or not to execute function on zeroes (in case of sparse DRM).
+   * @param evalZeros Whether or not to execute function on zeroes (in case of sparse DRM).
    * @return new DRM constructed from mapped values of drmA through f.
    */
   public static H2ODrm exec(H2ODrm drmA, Object f, final boolean evalZeros) {
@@ -67,7 +66,7 @@ public class AewUnary {
             for (int r = chk.nextNZ(-1); r < ChunkLen; r = chk.nextNZ(prev_offset)) {
               if (r - prev_offset > 1)
                 ncs[c].addZeros(r - prev_offset - 1);
-              ncs[c].addNum((double)f.apply((java.lang.Double)chk.atd(r)));
+              ncs[c].addNum((double)f.apply(chk.atd(r)));
               prev_offset = r;
             }
             if (ChunkLen - prev_offset > 1)
@@ -75,7 +74,7 @@ public class AewUnary {
           } else {
             /* dense or non-skip zeros */
             for (int r = 0; r < ChunkLen; r++) {
-              ncs[c].addNum((double)f.apply((java.lang.Double)chk.atd(r)));
+              ncs[c].addNum((double)f.apply(chk.atd(r)));
             }
           }
         }

http://git-wip-us.apache.org/repos/asf/mahout/blob/6ac833bd/h2o/src/main/java/org/apache/mahout/h2obindings/ops/CbindScalar.java
----------------------------------------------------------------------
diff --git a/h2o/src/main/java/org/apache/mahout/h2obindings/ops/CbindScalar.java b/h2o/src/main/java/org/apache/mahout/h2obindings/ops/CbindScalar.java
index bed0d10..4ff8244 100644
--- a/h2o/src/main/java/org/apache/mahout/h2obindings/ops/CbindScalar.java
+++ b/h2o/src/main/java/org/apache/mahout/h2obindings/ops/CbindScalar.java
@@ -17,12 +17,9 @@
 
 package org.apache.mahout.h2obindings.ops;
 
-import water.MRTask;
+import org.apache.mahout.h2obindings.drm.H2ODrm;
 import water.fvec.Frame;
 import water.fvec.Vec;
-import water.fvec.Chunk;
-
-import org.apache.mahout.h2obindings.drm.H2ODrm;
 
 /**
  * R-like cbind like operator, on a DRM and a new column containing
@@ -34,7 +31,8 @@ public class CbindScalar {
    * the given scalar.
    *
    * @param drmA DRM representing matrix A.
-   * @param d value to be filled in new column.
+   * @param scalar value to be filled in new column.
+   * @param leftbind true if binding to the left
    * @return new DRM containing columns of A and d.
    */
   public static H2ODrm exec(H2ODrm drmA, double scalar, boolean leftbind) {

http://git-wip-us.apache.org/repos/asf/mahout/blob/6ac833bd/math/src/main/java/org/apache/mahout/math/Vector.java
----------------------------------------------------------------------
diff --git a/math/src/main/java/org/apache/mahout/math/Vector.java b/math/src/main/java/org/apache/mahout/math/Vector.java
index 4480b0a..ae9da6e 100644
--- a/math/src/main/java/org/apache/mahout/math/Vector.java
+++ b/math/src/main/java/org/apache/mahout/math/Vector.java
@@ -93,15 +93,19 @@ public interface Vector extends Cloneable {
   int size();
 
   /**
-   * @return true iff this implementation should be considered dense -- that it explicitly
+   * true if this implementation should be considered dense -- that it explicitly
    *  represents every value
+   *
+   * @return true or false
    */
   boolean isDense();
 
   /**
+   * true if this implementation should be considered to be iterable in index order in an efficient way.
+   * In particular this implies that {@link #all()} and {@link #nonZeroes()} ()} return elements
+   * in ascending order by index.
+   *
    * @return true iff this implementation should be considered to be iterable in index order in an efficient way.
-   *  In particular this implies that {@link #all()} and {@link #nonZeroes()} ()} return elements
-   *  in ascending order by index.
    */
   boolean isSequentialAccess();
 
@@ -192,8 +196,8 @@ public interface Vector extends Cloneable {
   /**
    * Return a new empty vector of the same underlying class as the receiver with given cardinality
    *
-   * @param cardinality
-   * @return
+   * @param cardinality - size of vector
+   * @return {@link Vector}
    */
   Vector like(int cardinality);
 

http://git-wip-us.apache.org/repos/asf/mahout/blob/6ac833bd/mr/src/test/java/org/apache/mahout/math/hadoop/MathHelper.java
----------------------------------------------------------------------
diff --git a/mr/src/test/java/org/apache/mahout/math/hadoop/MathHelper.java b/mr/src/test/java/org/apache/mahout/math/hadoop/MathHelper.java
index a23f7b4..082c162 100644
--- a/mr/src/test/java/org/apache/mahout/math/hadoop/MathHelper.java
+++ b/mr/src/test/java/org/apache/mahout/math/hadoop/MathHelper.java
@@ -17,11 +17,6 @@
 
 package org.apache.mahout.math.hadoop;
 
-import java.io.IOException;
-import java.text.DecimalFormat;
-import java.text.DecimalFormatSymbols;
-import java.util.Locale;
-
 import com.google.common.io.Closeables;
 import org.apache.hadoop.conf.Configuration;
 import org.apache.hadoop.fs.FileSystem;
@@ -43,6 +38,11 @@ import org.easymock.EasyMock;
 import org.easymock.IArgumentMatcher;
 import org.junit.Assert;
 
+import java.io.IOException;
+import java.text.DecimalFormat;
+import java.text.DecimalFormatSymbols;
+import java.util.Locale;
+
 /**
  * a collection of small helper methods useful for unit-testing mathematical operations
  */
@@ -157,7 +157,7 @@ public final class MathHelper {
    */
   public static OpenIntObjectHashMap<Vector> readMatrixRows(Configuration conf, Path path) {
     boolean readOneRow = false;
-    OpenIntObjectHashMap<Vector> rows = new OpenIntObjectHashMap<Vector>();
+    OpenIntObjectHashMap<Vector> rows = new OpenIntObjectHashMap<>();
     for (Pair<IntWritable,VectorWritable> record :
         new SequenceFileIterable<IntWritable,VectorWritable>(path, true, conf)) {
       IntWritable key = record.getFirst();