DATAFU-100 Deprecate HyperLogLogPlusPlus
I also fixed some unrelated javadoc issues.
Signed-off-by: Eyal Allweil <eyal@apache.org>
diff --git a/datafu-pig/src/main/java/datafu/pig/hash/HasherRand.java b/datafu-pig/src/main/java/datafu/pig/hash/HasherRand.java
index c5be5cd..c5707fd 100644
--- a/datafu-pig/src/main/java/datafu/pig/hash/HasherRand.java
+++ b/datafu-pig/src/main/java/datafu/pig/hash/HasherRand.java
@@ -39,7 +39,7 @@
* record. The seed is generated by the front end (i.e. when you launch your
* script) and so is identical for every task.
*
- * See also @Hasher
+ * @see datafu.pig.hash.Hasher
*/
public class HasherRand extends Hasher
{
@@ -50,26 +50,25 @@
* Generates hash values according to murmur3-32, a non-cryptographic-strength
* hash function with good mixing.
*
- * @param algorithm
* @throws IllegalArgumentException, RuntimeException
- * @see Hasher(String alg)
+ * @see #HasherRand(String alg)
*/
public HasherRand() throws IllegalArgumentException, RuntimeException
{
this("murmur3-32");
}
- /*
- * @param algorithm
+ /**
+ * @param alg
* @throws IllegalArgumentException, RuntimeException
- * @see Hasher(String alg)
+ * @see #HasherRand()
*/
public HasherRand(String alg) throws IllegalArgumentException, RuntimeException
{
algorithm = alg;
}
- /*
+ /**
* @param val the single string to hash
* @return val, hashed according to the algorithm specified at instantiation
*/
@@ -84,8 +83,11 @@
return super.call(val);
}
- /*
+ /**
* Generate a seed exactly once on the front end, so all workers get same value
+
+ * @param in_schema Input schema
+ * @param out_schema Output schema
*/
@Override
protected void onReady(Schema in_schema, Schema out_schema) {
diff --git a/datafu-pig/src/main/java/datafu/pig/stats/HyperLogLogPlusPlus.java b/datafu-pig/src/main/java/datafu/pig/stats/HyperLogLogPlusPlus.java
index 104e99b..b0753e2 100644
--- a/datafu-pig/src/main/java/datafu/pig/stats/HyperLogLogPlusPlus.java
+++ b/datafu-pig/src/main/java/datafu/pig/stats/HyperLogLogPlusPlus.java
@@ -51,6 +51,7 @@
* This is a streaming implementation, and therefore the input data does not need to be sorted.
* </p>
*
+ * @deprecated This will be removed in the next major release.
*/
public class HyperLogLogPlusPlus extends AlgebraicEvalFunc<Long>
{
