(datasketches-java) 01/01: update sorted view javadoc getNumRetained.

[le...@apache.org]

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

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

commit b21e91c8d3f1773e222c839039562e6955397daf
Author: Lee Rhodes <le...@gmail.com>
AuthorDate: Wed Apr 17 09:24:44 2024 -0700

    update sorted view javadoc getNumRetained.
---
 .../java/org/apache/datasketches/quantilescommon/SortedView.java     | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/datasketches/quantilescommon/SortedView.java b/src/main/java/org/apache/datasketches/quantilescommon/SortedView.java
index 93803552..f789bfc5 100644
--- a/src/main/java/org/apache/datasketches/quantilescommon/SortedView.java
+++ b/src/main/java/org/apache/datasketches/quantilescommon/SortedView.java
@@ -49,8 +49,9 @@ public interface SortedView {
   long getN();
 
   /**
-   * Gets the number of quantiles retained by the sketch.
-   * @return the number of quantiles retained by the sketch
+   * Gets the number of quantiles retained by this sorted view.
+   * This may be slightly different from the function with the same name when called from the originating sketch.
+   * @return the number of quantiles retained by this sorted view
    */
   int getNumRetained();
 


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