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 2024/08/16 20:55:06 UTC
(datasketches-java) branch doc_fixes_one_exception created (now e1057c27)
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a change to branch doc_fixes_one_exception
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git
at e1057c27 Mostly spelling errors and documentation corrections.
This branch includes the following new commits:
new e1057c27 Mostly spelling errors and documentation corrections.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org
(datasketches-java) 01/01: Mostly spelling errors and documentation corrections.
Posted by le...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch doc_fixes_one_exception
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git
commit e1057c27d4b2a88652c782df00c1c188a5881167
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Fri Aug 16 13:54:51 2024 -0700
Mostly spelling errors and documentation corrections.
One added exception check.
---
.../org/apache/datasketches/theta/ConcurrentHeapThetaBuffer.java | 4 ++--
.../org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java | 6 +++---
.../java/org/apache/datasketches/theta/DirectQuickSelectSketch.java | 4 ++++
src/main/java/org/apache/datasketches/theta/Rebuilder.java | 2 +-
src/main/java/org/apache/datasketches/theta/SetOperation.java | 2 +-
.../java/org/apache/datasketches/theta/SetOperationBuilder.java | 2 +-
src/main/java/org/apache/datasketches/theta/Sketch.java | 4 ++--
7 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/datasketches/theta/ConcurrentHeapThetaBuffer.java b/src/main/java/org/apache/datasketches/theta/ConcurrentHeapThetaBuffer.java
index 741db2f7..e7b3ddaa 100644
--- a/src/main/java/org/apache/datasketches/theta/ConcurrentHeapThetaBuffer.java
+++ b/src/main/java/org/apache/datasketches/theta/ConcurrentHeapThetaBuffer.java
@@ -94,7 +94,7 @@ final class ConcurrentHeapThetaBuffer extends HeapQuickSelectSketch {
* @param hash to be propagated
*/
private boolean propagateToSharedSketch(final long hash) {
- //noinspection StatementWithEmptyBody
+ //no inspection StatementWithEmptyBody
while (localPropagationInProgress.get()) {
} //busy wait until previous propagation completed
localPropagationInProgress.set(true);
@@ -108,7 +108,7 @@ final class ConcurrentHeapThetaBuffer extends HeapQuickSelectSketch {
* Propagates the content of the buffer as a sketch to the shared sketch
*/
private void propagateToSharedSketch() {
- //noinspection StatementWithEmptyBody
+ //no inspection StatementWithEmptyBody
while (localPropagationInProgress.get()) {
} //busy wait until previous propagation completed
diff --git a/src/main/java/org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java b/src/main/java/org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java
index 49a8140c..acc2da9b 100644
--- a/src/main/java/org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java
+++ b/src/main/java/org/apache/datasketches/theta/ConcurrentSharedThetaSketch.java
@@ -63,8 +63,8 @@ interface ConcurrentSharedThetaSketch {
void endPropagation(AtomicBoolean localPropagationInProgress, boolean isEager);
/**
- * Returns the value of the volatile theta manged by the shared sketch
- * @return the value of the volatile theta manged by the shared sketch
+ * Returns the value of the volatile theta managed by the shared sketch
+ * @return the value of the volatile theta managed by the shared sketch
*/
long getVolatileTheta();
@@ -124,7 +124,7 @@ interface ConcurrentSharedThetaSketch {
//
//For the external user all of the below methods can be obtained by casting the shared
//sketch to UpdateSketch. However, these methods here also act as an alias so that an
- //attempt to access these methods from the local buffer will be divered to the shared
+ //attempt to access these methods from the local buffer will be diverted to the shared
//sketch.
//From Sketch
diff --git a/src/main/java/org/apache/datasketches/theta/DirectQuickSelectSketch.java b/src/main/java/org/apache/datasketches/theta/DirectQuickSelectSketch.java
index a1ac53c6..ad9051a0 100644
--- a/src/main/java/org/apache/datasketches/theta/DirectQuickSelectSketch.java
+++ b/src/main/java/org/apache/datasketches/theta/DirectQuickSelectSketch.java
@@ -323,6 +323,10 @@ class DirectQuickSelectSketch extends DirectQuickSelectSketchR {
memReqSvr_ = (memReqSvr_ == null) ? wmem_.getMemoryRequestServer() : memReqSvr_;
+ if (memReqSvr_ == null) { //in case the MRS is not enabled or null.
+ throw new SketchesArgumentException("Out of Memory, MemoryRequestServer is null, cannot expand.");
+ }
+
final WritableMemory newDstMem = memReqSvr_.request(wmem_,reqBytes);
moveAndResize(wmem_, preambleLongs, lgArrLongs, newDstMem, tgtLgArrLongs, thetaLong);
diff --git a/src/main/java/org/apache/datasketches/theta/Rebuilder.java b/src/main/java/org/apache/datasketches/theta/Rebuilder.java
index 07093f65..b6e3de34 100644
--- a/src/main/java/org/apache/datasketches/theta/Rebuilder.java
+++ b/src/main/java/org/apache/datasketches/theta/Rebuilder.java
@@ -84,7 +84,7 @@ final class Rebuilder {
}
/**
- * Moves me (the entire sketch) to a new larger Memory location and rebuilds the hash table.
+ * Moves me (the entire updatable sketch) to a new larger Memory location and rebuilds the hash table.
* This assumes a Memory preamble of standard form with the correct value of thetaLong.
* Afterwards, the caller must update the local Memory reference, lgArrLongs
* and hashTableThreshold from the dstMemory and free the source Memory.
diff --git a/src/main/java/org/apache/datasketches/theta/SetOperation.java b/src/main/java/org/apache/datasketches/theta/SetOperation.java
index 4d8ebf0c..29336fb0 100644
--- a/src/main/java/org/apache/datasketches/theta/SetOperation.java
+++ b/src/main/java/org/apache/datasketches/theta/SetOperation.java
@@ -245,7 +245,7 @@ public abstract class SetOperation {
* <p>Note: Only certain set operators during stateful operations can be serialized.
* Only when they are stored into Memory will this be relevant.</p>
*
- * @param that A different non-null object
+ * @param that A different non-null and alive object
* @return true if the backing resource of <i>this</i> is the same as the backing resource
* of <i>that</i>.
*/
diff --git a/src/main/java/org/apache/datasketches/theta/SetOperationBuilder.java b/src/main/java/org/apache/datasketches/theta/SetOperationBuilder.java
index d788418d..4a35cf67 100644
--- a/src/main/java/org/apache/datasketches/theta/SetOperationBuilder.java
+++ b/src/main/java/org/apache/datasketches/theta/SetOperationBuilder.java
@@ -66,7 +66,7 @@ public class SetOperationBuilder {
* Sets the Maximum Nominal Entries (max K) for this set operation. The effective value of K of the result of a
* Set Operation can be less than max K, but never greater.
* The minimum value is 16 and the maximum value is 67,108,864, which is 2^26.
- * @param nomEntries <a href="{@docRoot}/resources/dictionary.html#nomEntries">Nominal Entres</a>
+ * @param nomEntries <a href="{@docRoot}/resources/dictionary.html#nomEntries">Nominal Entries</a>
* This will become the ceiling power of 2 if it is not a power of 2.
* @return this SetOperationBuilder
*/
diff --git a/src/main/java/org/apache/datasketches/theta/Sketch.java b/src/main/java/org/apache/datasketches/theta/Sketch.java
index 92768c8e..82a3fc80 100644
--- a/src/main/java/org/apache/datasketches/theta/Sketch.java
+++ b/src/main/java/org/apache/datasketches/theta/Sketch.java
@@ -602,8 +602,8 @@ public abstract class Sketch {
abstract int getCurrentPreambleLongs();
/**
- * Returns the Memory object if it exists, otherwise null.
- * @return the Memory object if it exists, otherwise null.
+ * Returns the backing Memory object if it exists, otherwise null.
+ * @return the backing Memory object if it exists, otherwise null.
*/
abstract Memory getMemory();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org