[datasketches-java] branch req_inclusive updated: deprecated ltEq flag

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

alsay pushed a commit to branch req_inclusive
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git


The following commit(s) were added to refs/heads/req_inclusive by this push:
     new 94aae24d deprecated ltEq flag
94aae24d is described below

commit 94aae24d8e1ee04eb4ce1fe7b5c05210c10c283f
Author: AlexanderSaydakov <Al...@users.noreply.github.com>
AuthorDate: Tue Jul 12 15:46:43 2022 -0700

    deprecated ltEq flag
---
 src/main/java/org/apache/datasketches/req/BaseReqSketch.java | 6 ++++--
 src/main/java/org/apache/datasketches/req/ReqSketch.java     | 4 ++++
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/datasketches/req/BaseReqSketch.java b/src/main/java/org/apache/datasketches/req/BaseReqSketch.java
index 299e9d4d..d23e5fae 100644
--- a/src/main/java/org/apache/datasketches/req/BaseReqSketch.java
+++ b/src/main/java/org/apache/datasketches/req/BaseReqSketch.java
@@ -131,7 +131,7 @@ abstract class BaseReqSketch {
   public abstract double[] getPMF(float[] splitPoints);
 
   /**
-   * Gets the approximate quantile of the given normalized rank based on the lteq criterion.
+   * Gets the approximate quantile of the given normalized rank based on the given criterion.
    * The normalized rank must be in the range [0.0, 1.0] (inclusive, inclusive).
    * @param normRank the given normalized rank.
    * @param inclusive if true, the given rank is considered inclusive.
@@ -165,7 +165,7 @@ abstract class BaseReqSketch {
   /**
    * Computes the normalized rank of the given value in the stream.
    * The normalized rank is the fraction of values less than the given value;
-   * or if lteq is true, the fraction of values less than or equal to the given value.
+   * or if inclusive is true, the fraction of values less than or equal to the given value.
    * @param value the given value.
    * @param inclusive if true the weight of the given value is included into its rank.
    * @return the normalized rank of the given value in the stream.
@@ -239,6 +239,7 @@ abstract class BaseReqSketch {
    * Returns the current comparison criterion. If true the value comparison criterion is
    * &le;, otherwise it will be the default, which is &lt;.
    * @return the current comparison criterion
+   * @deprecated
    */
   public abstract boolean isLessThanOrEqual();
 
@@ -265,6 +266,7 @@ abstract class BaseReqSketch {
 
   /**
    * Sets the chosen criterion for value comparison
+   * @deprecated
    *
    * @param ltEq (Less-than-or Equals) If true, the sketch will use the &le; criterion for comparing
    * values.  Otherwise, the criterion is strictly &lt;, the default.
diff --git a/src/main/java/org/apache/datasketches/req/ReqSketch.java b/src/main/java/org/apache/datasketches/req/ReqSketch.java
index e843bb76..e84ebafb 100644
--- a/src/main/java/org/apache/datasketches/req/ReqSketch.java
+++ b/src/main/java/org/apache/datasketches/req/ReqSketch.java
@@ -246,6 +246,10 @@ public class ReqSketch extends BaseReqSketch {
     return cumNnrArr;
   }
 
+  /**
+   * @deprecated
+   * @return ltEq flag
+   */
   boolean getLtEq() {
     return ltEq;
   }


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org