You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2023/03/20 02:54:58 UTC
[datasketches-java] 01/01: Found a minor discrepancy between the documentation of the getQuantiles(int numEvenlySpaced) methods and the implementation of the QuantilesUtil.evenlySpaced(...) method.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch minor-updates
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git
commit 0bea5d67123803a38a8b609f4ec9d1109b1f7a4b
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Sun Mar 19 19:54:46 2023 -0700
Found a minor discrepancy between the documentation of the
getQuantiles(int numEvenlySpaced) methods and the implementation of the
QuantilesUtil.evenlySpaced(...) method.
The javadocs of the getQuantiles methods (for all quantiles sketches)
claimed that a "numEvenlySpaced == 1" was valid, yet the implementation
would throw an exception if "numEvenlySpaced < 2".
So I updated the implementation so that the implementation matched the
javadocs.
I also updated the relevant quantiles javadocs to reflect that this
exception could be thrown.
The only place this QuantilesUtil.evenlySpaced(...) method was used was
for these quantiles methods, so no place else in the library used this
method.
---
.../datasketches/quantilescommon/QuantilesDoublesAPI.java | 2 +-
.../datasketches/quantilescommon/QuantilesFloatsAPI.java | 2 +-
.../datasketches/quantilescommon/QuantilesGenericAPI.java | 2 +-
.../org/apache/datasketches/quantilescommon/QuantilesUtil.java | 10 ++++++----
4 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.java b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.java
index 7dd57f59..5479b294 100644
--- a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.java
+++ b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.java
@@ -253,7 +253,7 @@ public interface QuantilesDoublesAPI extends QuantilesAPI {
* @param searchCrit if INCLUSIVE, the given ranks include all quantiles ≤ the quantile directly corresponding to
* each rank.
* @return an array of quantiles that are evenly spaced by their ranks.
- * @throws IllegalArgumentException if sketch is empty.
+ * @throws IllegalArgumentException if sketch is empty or if <i>numEvenlySpaced < 1</i>.
* @see org.apache.datasketches.quantilescommon.QuantileSearchCriteria
*/
double[] getQuantiles(int numEvenlySpaced, QuantileSearchCriteria searchCrit);
diff --git a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.java b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.java
index 24032b42..528a9212 100644
--- a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.java
+++ b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesFloatsAPI.java
@@ -252,7 +252,7 @@ public interface QuantilesFloatsAPI extends QuantilesAPI {
* @param searchCrit if INCLUSIVE, the given ranks include all quantiles ≤ the quantile directly corresponding to
* each rank.
* @return an array of quantiles that are evenly spaced by their ranks.
- * @throws IllegalArgumentException if sketch is empty.
+ * @throws IllegalArgumentException if sketch is empty or if <i>numEvenlySpaced < 1</i>.
* @see org.apache.datasketches.quantilescommon.QuantileSearchCriteria
*/
float[] getQuantiles(int numEvenlySpaced, QuantileSearchCriteria searchCrit);
diff --git a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.java b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.java
index 06e51f09..20150870 100644
--- a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.java
+++ b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesGenericAPI.java
@@ -253,7 +253,7 @@ public interface QuantilesGenericAPI<T> extends QuantilesAPI {
* @param searchCrit if INCLUSIVE, the given ranks include all quantiles ≤ the quantile directly corresponding to
* each rank.
* @return an array of quantiles that are evenly spaced by their ranks.
- * @throws IllegalArgumentException if sketch is empty.
+ * @throws IllegalArgumentException if sketch is empty or if <i>numEvenlySpaced < 1</i>.
* @see org.apache.datasketches.quantilescommon.QuantileSearchCriteria
*/
T[] getQuantiles(int numEvenlySpaced, QuantileSearchCriteria searchCrit);
diff --git a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesUtil.java b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesUtil.java
index 8900ebcd..a57cb8e4 100644
--- a/src/main/java/org/apache/datasketches/quantilescommon/QuantilesUtil.java
+++ b/src/main/java/org/apache/datasketches/quantilescommon/QuantilesUtil.java
@@ -83,22 +83,24 @@ public final class QuantilesUtil {
* Returns a double array of evenly spaced values between value1 and value2 inclusive.
* If value2 > value1, the resulting sequence will be increasing.
* If value2 < value1, the resulting sequence will be decreasing.
+ * If num == 1, value1 will be in index 0 of the returned array.
* @param value1 will be in index 0 of the returned array
* @param value2 will be in the highest index of the returned array
- * @param num the total number of values including value1 and value2. Must be 2 or greater.
+ * @param num the total number of values including value1 and value2. Must be 1 or greater.
* @return a double array of evenly spaced values between value1 and value2 inclusive.
+ * @throws IllegalArgumentException if <i>num</i> < 1.
*/
public static double[] evenlySpaced(final double value1, final double value2, final int num) {
- if (num < 2) {
- throw new SketchesArgumentException("num must be >= 2");
+ if (num < 1) {
+ throw new IllegalArgumentException("num must be >= 1");
}
final double[] out = new double[num];
out[0] = value1;
+ if (num == 1) { return out; }
out[num - 1] = value2;
if (num == 2) { return out; }
final double delta = (value2 - value1) / (num - 1);
-
for (int i = 1; i < num - 1; i++) { out[i] = i * delta + value1; }
return out;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org