Merge branch 'deephaven:main' into formatted-autocomplete-md

Author: wusteven815

.github/workflows/links.yml

@@ -9,6 +9,7 @@ on:
 jobs:
   linkChecker:
     runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'deephaven' }}
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/nightly-check-ci.yml

@@ -102,7 +102,7 @@ jobs:
       - name: Slack Nightly Failure
         uses: slackapi/slack-github-action@v1.27.0
         id: slack-nightly-failure
-        if: ${{ failure() && github.repository_owner == 'deephaven' }}
+        if: ${{ failure() && github.repository_owner == 'deephaven' && github.ref == 'refs/heads/main' }}
         with:
           payload: |
             {

.lycheeignore

@@ -1,4 +1,5 @@
 http://localhost:
+https://localhost:
 https://docs.deephaven.io/
 https://10.0.1.50:8123/iris/connection.json
 https://deephaven.io/core/release/vX.Y.Z/javadoc

Base/gradle.properties

@@ -1 +1,2 @@
 io.deephaven.project.ProjectType=JAVA_PUBLIC
+languageLevel=8

Base/src/main/java/io/deephaven/base/FileUtils.java

@@ -282,7 +282,7 @@ public static URI convertToURI(final String source, final boolean isDirectory) {
                 return convertToURI(new File(uri), isDirectory);
             }
             String path = uri.getPath();
-            final boolean endsWithSlash = path.charAt(path.length() - 1) == URI_SEPARATOR_CHAR;
+            final boolean endsWithSlash = !path.isEmpty() && path.charAt(path.length() - 1) == URI_SEPARATOR_CHAR;
             if (!isDirectory && endsWithSlash) {
                 throw new IllegalArgumentException("Non-directory URI should not end with a slash: " + uri);
             }

Stats/src/main/java/io/deephaven/stats/util/OSUtil.java Base/src/main/java/io/deephaven/base/OSUtil.java

@@ -1,7 +1,7 @@
 //
 // Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
 //
-package io.deephaven.stats.util;
+package io.deephaven.base;
 
 import org.jetbrains.annotations.NotNull;
 

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingByteRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingCharRingBuffer.java

@@ -430,11 +430,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingDoubleRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingFloatRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingIntRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingLongRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingObjectRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/AggregatingShortRingBuffer.java

@@ -434,11 +434,16 @@ public void clear() {
         final long prevHead = internalBuffer.head;
         final int prevSize = size();
 
-        internalBuffer.clear();
+        // Reset the pointers in the ring buffer without clearing the storage array. This leaves existing `identityVal`
+        // entries in place for the next `evaluate()` call.
+        internalBuffer.head = internalBuffer.tail = 0;
 
         calcHead = calcTail = 0;
-        // Reset the cleared storage entries to the identity value
+
+        // Reset the previously populated storage entries to the identity value. After this call, all entries in the
+        // storage buffer are `identityVal`
         fillWithIdentityVal(prevHead, prevSize);
+
         // Reset the tree buffer with the identity value
         Arrays.fill(treeStorage, identityVal);
     }

Base/src/main/java/io/deephaven/base/ringbuffer/ByteRingBuffer.java

@@ -9,6 +9,7 @@
 
 import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
+import org.jetbrains.annotations.TestOnly;
 
 import java.io.Serializable;
 import java.util.NoSuchElementException;
@@ -19,7 +20,7 @@
  * {@code long} values. Head and tail will not wrap around; instead we use storage arrays sized to 2^N to allow fast
  * determination of storage indices through a mask operation.
  */
-public class ByteRingBuffer implements Serializable {
+public class ByteRingBuffer implements RingBuffer, Serializable {
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     byte[] storage;
@@ -32,7 +33,7 @@ public class ByteRingBuffer implements Serializable {
      *
      * @param capacity minimum capacity of the ring buffer
      */
-    public ByteRingBuffer(int capacity) {
+    public ByteRingBuffer(final int capacity) {
         this(capacity, true);
     }
 
@@ -42,7 +43,7 @@ public ByteRingBuffer(int capacity) {
      * @param capacity minimum capacity of ring buffer
      * @param growable whether to allow growth when the buffer is full.
      */
-    public ByteRingBuffer(int capacity, boolean growable) {
+    public ByteRingBuffer(final int capacity, final boolean growable) {
         Assert.leq(capacity, "ByteRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
@@ -59,7 +60,7 @@ public ByteRingBuffer(int capacity, boolean growable) {
      * 
      * @param increase Increase amount. The ring buffer's capacity will be increased by at least this amount.
      */
-    protected void grow(int increase) {
+    protected void grow(final int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
@@ -83,7 +84,7 @@ protected void grow(int increase) {
      * 
      * @param dest The destination buffer.
      */
-    protected void copyRingBufferToArray(byte[] dest) {
+    protected void copyRingBufferToArray(final byte[] dest) {
         final int size = size();
         final int storageHead = (int) (head & mask);
 
@@ -99,27 +100,35 @@ protected void copyRingBufferToArray(byte[] dest) {
         System.arraycopy(storage, 0, dest, firstCopyLen, secondCopyLen);
     }
 
+    @Override
     public boolean isFull() {
         return size() == storage.length;
     }
 
+    @Override
     public boolean isEmpty() {
         return tail == head;
     }
 
+    @Override
     public int size() {
         return Math.toIntExact(tail - head);
     }
 
+    @Override
     public int capacity() {
         return storage.length;
     }
 
+    @Override
     public int remaining() {
         return storage.length - size();
     }
 
+    @Override
     public void clear() {
+        // region object-bulk-clear
+        // endregion object-bulk-clear
         tail = head = 0;
     }
 
@@ -131,7 +140,7 @@ public void clear() {
      * @throws UnsupportedOperationException when {@code growable} is {@code false} and buffer is full
      * @return {@code true} if the byte was added successfully
      */
-    public boolean add(byte e) {
+    public boolean add(final byte e) {
         if (isFull()) {
             if (!growable) {
                 throw new UnsupportedOperationException("Ring buffer is full and growth is disabled");
@@ -151,7 +160,8 @@ public boolean add(byte e) {
      * @param count the minimum number of empty entries in the buffer after this call
      * @throws UnsupportedOperationException when {@code growable} is {@code false} and buffer is full
      */
-    public void ensureRemaining(int count) {
+    @Override
+    public void ensureRemaining(final int count) {
         if (remaining() < count) {
             if (!growable) {
                 throw new UnsupportedOperationException("Ring buffer is full and growth is disabled");
@@ -168,7 +178,7 @@ public void ensureRemaining(int count) {
      *
      * @param e the value to add to the buffer
      */
-    public void addUnsafe(byte e) {
+    public void addUnsafe(final byte e) {
         // This is an extremely paranoid wrap check that in all likelihood will never run. With FIXUP_THRESHOLD at
         // 1 << 62, and the user pushing 2^32 values per second(!), it will take 68 years to wrap this counter .
         if (tail >= FIXUP_THRESHOLD) {
@@ -188,7 +198,7 @@ public void addUnsafe(byte e) {
      * @param notFullResult value to return is the buffer is not full
      * @return the overwritten entry if the buffer is full, the provided value otherwise
      */
-    public byte addOverwrite(byte e, byte notFullResult) {
+    public byte addOverwrite(final byte e, final byte notFullResult) {
         byte val = notFullResult;
         if (isFull()) {
             val = remove();
@@ -204,7 +214,7 @@ public byte addOverwrite(byte e, byte notFullResult) {
      * @param e the byte to be added to the buffer
      * @return true if the value was added successfully, false otherwise
      */
-    public boolean offer(byte e) {
+    public boolean offer(final byte e) {
         if (isFull()) {
             return false;
         }
@@ -218,7 +228,7 @@ public boolean offer(byte e) {
      * @param count The number of elements to remove.
      * @throws NoSuchElementException if the buffer is empty
      */
-    public byte[] remove(int count) {
+    public byte[] remove(final int count) {
         final int size = size();
         if (size < count) {
             throw new NoSuchElementException();
@@ -264,7 +274,7 @@ public byte removeUnsafe() {
      * @param onEmpty the value to return if the ring buffer is empty
      * @return The removed element if the ring buffer was non-empty, otherwise the value of 'onEmpty'
      */
-    public byte poll(byte onEmpty) {
+    public byte poll(final byte onEmpty) {
         if (isEmpty()) {
             return onEmpty;
         }
@@ -291,7 +301,7 @@ public byte element() {
      * @param onEmpty the value to return if the ring buffer is empty
      * @return The head element if the ring buffer is non-empty, otherwise the value of 'onEmpty'
      */
-    public byte peek(byte onEmpty) {
+    public byte peek(final byte onEmpty) {
         if (isEmpty()) {
             return onEmpty;
         }
@@ -314,7 +324,7 @@ public byte front() {
      * @throws NoSuchElementException if the buffer is empty
      * @return The element at the specified offset
      */
-    public byte front(int offset) {
+    public byte front(final int offset) {
         if (offset < 0 || offset >= size()) {
             throw new NoSuchElementException();
         }
@@ -341,7 +351,7 @@ public byte back() {
      * @param onEmpty the value to return if the ring buffer is empty
      * @return The tail element if the ring buffer is non-empty, otherwise the value of 'onEmpty'
      */
-    public byte peekBack(byte onEmpty) {
+    public byte peekBack(final byte onEmpty) {
         if (isEmpty()) {
             return onEmpty;
         }
@@ -385,4 +395,14 @@ public void remove() {
             throw new UnsupportedOperationException();
         }
     }
+
+    /**
+     * Get the storage array for this ring buffer. This is intended for testing and debugging purposes only.
+     *
+     * @return The storage array for this ring buffer.
+     */
+    @TestOnly
+    public byte[] getStorage() {
+        return storage;
+    }
 }