Merge branch 'deephaven:main' into docs-ci-condition-on-latest-link

stanbrub · Jun 24, 2024 · dc459f7 · dc459f7
2 parents 8ec4812 + 5d1c519
commit dc459f7
Show file tree

Hide file tree

Showing 318 changed files with 18,014 additions and 2,037 deletions.
diff --git a/.github/workflows/check-ci.yml b/.github/workflows/check-ci.yml
@@ -2,7 +2,7 @@ name: Check CI
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [ 'main', 'rc/v*' ]
   push:
     branches: [ 'main', 'check/**', 'release/v*' ]
 

diff --git a/.github/workflows/create-docs-issues.yml b/.github/workflows/create-docs-issues.yml
@@ -4,6 +4,7 @@ on:
   pull_request_target:
     branches:
       - main
+      - 'rc/v*'
     types:
       - closed
 

diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml
@@ -2,7 +2,7 @@ name: Docs CI
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [ 'main', 'rc/v*' ]
   push:
     branches: [ 'main', 'release/v*' ]
 

diff --git a/.github/workflows/label-check-ci.yml b/.github/workflows/label-check-ci.yml
@@ -10,7 +10,7 @@ on:
     # effect the labels because the merge requirements need checks to pass against the most recent
     # commit.
     types: [ opened, synchronize, reopened, labeled, unlabeled ]
-    branches: [ main ]
+    branches: [ 'main', 'rc/v*' ]
 
 jobs:
   doc-labels:

diff --git a/.github/workflows/publish-ci.yml b/.github/workflows/publish-ci.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches: [ 'main', 'release/v*' ]
   pull_request:
-    branches: [ main ]
+    branches: [ 'main', 'rc/v*' ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

diff --git a/.github/workflows/quick-ci.yml b/.github/workflows/quick-ci.yml
@@ -2,7 +2,7 @@ name: Quick CI
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [ 'main', 'rc/v*' ]
   push:
     branches: [ 'main', 'check/**', 'release/v*' ]
 

diff --git a/Base/src/main/java/io/deephaven/base/MathUtil.java b/Base/src/main/java/io/deephaven/base/MathUtil.java
@@ -8,6 +8,11 @@
  */
 public class MathUtil {
 
+    /**
+     * The maximum power of 2.
+     */
+    public static final int MAX_POWER_OF_2 = 1 << 30;
+
     /**
      * Compute ceil(log2(x)). See {@link Integer#numberOfLeadingZeros(int)}.
      *
@@ -108,4 +113,36 @@ public static int base10digits(int n) {
         }
         return base10guess;
     }
+
+    /**
+     * Rounds up to the next power of 2 for {@code x}; if {@code x} is already a power of 2, {@code x} will be returned.
+     * Values outside the range {@code 1 <= x <= MAX_POWER_OF_2} will return {@code 1}.
+     *
+     * <p>
+     * Equivalent to {@code Math.max(Integer.highestOneBit(x - 1) << 1, 1)}.
+     *
+     * @param x the value
+     * @return the next power of 2 for {@code x}
+     * @see #MAX_POWER_OF_2
+     */
+    public static int roundUpPowerOf2(int x) {
+        return Math.max(Integer.highestOneBit(x - 1) << 1, 1);
+    }
+
+    /**
+     * Rounds up to the next power of 2 for {@code size <= MAX_POWER_OF_2}, otherwise returns
+     * {@link ArrayUtil#MAX_ARRAY_SIZE}.
+     *
+     * <p>
+     * Equivalent to {@code size <= MAX_POWER_OF_2 ? roundUpPowerOf2(size) : ArrayUtil.MAX_ARRAY_SIZE}.
+     *
+     * @param size the size
+     * @return the
+     * @see #MAX_POWER_OF_2
+     * @see #roundUpPowerOf2(int)
+     * @see ArrayUtil#MAX_ARRAY_SIZE
+     */
+    public static int roundUpArraySize(int size) {
+        return size <= MAX_POWER_OF_2 ? roundUpPowerOf2(size) : ArrayUtil.MAX_ARRAY_SIZE;
+    }
 }
diff --git a/Base/src/main/java/io/deephaven/base/ringbuffer/ByteRingBuffer.java b/Base/src/main/java/io/deephaven/base/ringbuffer/ByteRingBuffer.java
@@ -7,7 +7,7 @@
 // @formatter:off
 package io.deephaven.base.ringbuffer;
 
-import io.deephaven.base.ArrayUtil;
+import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
 
 import java.io.Serializable;
@@ -20,8 +20,6 @@
  * determination of storage indices through a mask operation.
  */
 public class ByteRingBuffer implements Serializable {
-    /** Maximum capacity is the highest power of two that can be allocated (i.e. <= than ArrayUtil.MAX_ARRAY_SIZE). */
-    static final int RING_BUFFER_MAX_CAPACITY = Integer.highestOneBit(ArrayUtil.MAX_ARRAY_SIZE);
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     byte[] storage;
@@ -45,21 +43,13 @@ public ByteRingBuffer(int capacity) {
      * @param growable whether to allow growth when the buffer is full.
      */
     public ByteRingBuffer(int capacity, boolean growable) {
-        Assert.leq(capacity, "ByteRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(capacity, "ByteRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
 
         // use next larger power of 2 for our storage
-        final int newCapacity;
-        if (capacity < 2) {
-            // sensibly handle the size=0 and size=1 cases
-            newCapacity = 1;
-        } else {
-            newCapacity = Integer.highestOneBit(capacity - 1) << 1;
-        }
-
         // reset the data structure members
-        storage = new byte[newCapacity];
+        storage = new byte[MathUtil.roundUpPowerOf2(capacity)];
         mask = storage.length - 1;
         tail = head = 0;
     }
@@ -73,9 +63,9 @@ protected void grow(int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
-        Assert.leq(newCapacity, "ByteRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(newCapacity, "ByteRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
-        final byte[] newStorage = new byte[Integer.highestOneBit((int) newCapacity - 1) << 1];
+        final byte[] newStorage = new byte[MathUtil.roundUpPowerOf2((int) newCapacity)];
 
         // move the current data to the new buffer
         copyRingBufferToArray(newStorage);

diff --git a/Base/src/main/java/io/deephaven/base/ringbuffer/CharRingBuffer.java b/Base/src/main/java/io/deephaven/base/ringbuffer/CharRingBuffer.java
@@ -3,7 +3,7 @@
 //
 package io.deephaven.base.ringbuffer;
 
-import io.deephaven.base.ArrayUtil;
+import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
 
 import java.io.Serializable;
@@ -16,8 +16,6 @@
  * determination of storage indices through a mask operation.
  */
 public class CharRingBuffer implements Serializable {
-    /** Maximum capacity is the highest power of two that can be allocated (i.e. <= than ArrayUtil.MAX_ARRAY_SIZE). */
-    static final int RING_BUFFER_MAX_CAPACITY = Integer.highestOneBit(ArrayUtil.MAX_ARRAY_SIZE);
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     char[] storage;
@@ -41,21 +39,13 @@ public CharRingBuffer(int capacity) {
      * @param growable whether to allow growth when the buffer is full.
      */
     public CharRingBuffer(int capacity, boolean growable) {
-        Assert.leq(capacity, "CharRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(capacity, "CharRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
 
         // use next larger power of 2 for our storage
-        final int newCapacity;
-        if (capacity < 2) {
-            // sensibly handle the size=0 and size=1 cases
-            newCapacity = 1;
-        } else {
-            newCapacity = Integer.highestOneBit(capacity - 1) << 1;
-        }
-
         // reset the data structure members
-        storage = new char[newCapacity];
+        storage = new char[MathUtil.roundUpPowerOf2(capacity)];
         mask = storage.length - 1;
         tail = head = 0;
     }
@@ -69,9 +59,9 @@ protected void grow(int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
-        Assert.leq(newCapacity, "CharRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(newCapacity, "CharRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
-        final char[] newStorage = new char[Integer.highestOneBit((int) newCapacity - 1) << 1];
+        final char[] newStorage = new char[MathUtil.roundUpPowerOf2((int) newCapacity)];
 
         // move the current data to the new buffer
         copyRingBufferToArray(newStorage);

diff --git a/Base/src/main/java/io/deephaven/base/ringbuffer/DoubleRingBuffer.java b/Base/src/main/java/io/deephaven/base/ringbuffer/DoubleRingBuffer.java
@@ -7,7 +7,7 @@
 // @formatter:off
 package io.deephaven.base.ringbuffer;
 
-import io.deephaven.base.ArrayUtil;
+import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
 
 import java.io.Serializable;
@@ -20,8 +20,6 @@
  * determination of storage indices through a mask operation.
  */
 public class DoubleRingBuffer implements Serializable {
-    /** Maximum capacity is the highest power of two that can be allocated (i.e. <= than ArrayUtil.MAX_ARRAY_SIZE). */
-    static final int RING_BUFFER_MAX_CAPACITY = Integer.highestOneBit(ArrayUtil.MAX_ARRAY_SIZE);
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     double[] storage;
@@ -45,21 +43,13 @@ public DoubleRingBuffer(int capacity) {
      * @param growable whether to allow growth when the buffer is full.
      */
     public DoubleRingBuffer(int capacity, boolean growable) {
-        Assert.leq(capacity, "DoubleRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(capacity, "DoubleRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
 
         // use next larger power of 2 for our storage
-        final int newCapacity;
-        if (capacity < 2) {
-            // sensibly handle the size=0 and size=1 cases
-            newCapacity = 1;
-        } else {
-            newCapacity = Integer.highestOneBit(capacity - 1) << 1;
-        }
-
         // reset the data structure members
-        storage = new double[newCapacity];
+        storage = new double[MathUtil.roundUpPowerOf2(capacity)];
         mask = storage.length - 1;
         tail = head = 0;
     }
@@ -73,9 +63,9 @@ protected void grow(int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
-        Assert.leq(newCapacity, "DoubleRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(newCapacity, "DoubleRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
-        final double[] newStorage = new double[Integer.highestOneBit((int) newCapacity - 1) << 1];
+        final double[] newStorage = new double[MathUtil.roundUpPowerOf2((int) newCapacity)];
 
         // move the current data to the new buffer
         copyRingBufferToArray(newStorage);

diff --git a/Base/src/main/java/io/deephaven/base/ringbuffer/FloatRingBuffer.java b/Base/src/main/java/io/deephaven/base/ringbuffer/FloatRingBuffer.java
@@ -7,7 +7,7 @@
 // @formatter:off
 package io.deephaven.base.ringbuffer;
 
-import io.deephaven.base.ArrayUtil;
+import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
 
 import java.io.Serializable;
@@ -20,8 +20,6 @@
  * determination of storage indices through a mask operation.
  */
 public class FloatRingBuffer implements Serializable {
-    /** Maximum capacity is the highest power of two that can be allocated (i.e. <= than ArrayUtil.MAX_ARRAY_SIZE). */
-    static final int RING_BUFFER_MAX_CAPACITY = Integer.highestOneBit(ArrayUtil.MAX_ARRAY_SIZE);
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     float[] storage;
@@ -45,21 +43,13 @@ public FloatRingBuffer(int capacity) {
      * @param growable whether to allow growth when the buffer is full.
      */
     public FloatRingBuffer(int capacity, boolean growable) {
-        Assert.leq(capacity, "FloatRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(capacity, "FloatRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
 
         // use next larger power of 2 for our storage
-        final int newCapacity;
-        if (capacity < 2) {
-            // sensibly handle the size=0 and size=1 cases
-            newCapacity = 1;
-        } else {
-            newCapacity = Integer.highestOneBit(capacity - 1) << 1;
-        }
-
         // reset the data structure members
-        storage = new float[newCapacity];
+        storage = new float[MathUtil.roundUpPowerOf2(capacity)];
         mask = storage.length - 1;
         tail = head = 0;
     }
@@ -73,9 +63,9 @@ protected void grow(int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
-        Assert.leq(newCapacity, "FloatRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(newCapacity, "FloatRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
-        final float[] newStorage = new float[Integer.highestOneBit((int) newCapacity - 1) << 1];
+        final float[] newStorage = new float[MathUtil.roundUpPowerOf2((int) newCapacity)];
 
         // move the current data to the new buffer
         copyRingBufferToArray(newStorage);

diff --git a/Base/src/main/java/io/deephaven/base/ringbuffer/IntRingBuffer.java b/Base/src/main/java/io/deephaven/base/ringbuffer/IntRingBuffer.java
@@ -7,7 +7,7 @@
 // @formatter:off
 package io.deephaven.base.ringbuffer;
 
-import io.deephaven.base.ArrayUtil;
+import io.deephaven.base.MathUtil;
 import io.deephaven.base.verify.Assert;
 
 import java.io.Serializable;
@@ -20,8 +20,6 @@
  * determination of storage indices through a mask operation.
  */
 public class IntRingBuffer implements Serializable {
-    /** Maximum capacity is the highest power of two that can be allocated (i.e. <= than ArrayUtil.MAX_ARRAY_SIZE). */
-    static final int RING_BUFFER_MAX_CAPACITY = Integer.highestOneBit(ArrayUtil.MAX_ARRAY_SIZE);
     static final long FIXUP_THRESHOLD = 1L << 62;
     final boolean growable;
     int[] storage;
@@ -45,21 +43,13 @@ public IntRingBuffer(int capacity) {
      * @param growable whether to allow growth when the buffer is full.
      */
     public IntRingBuffer(int capacity, boolean growable) {
-        Assert.leq(capacity, "IntRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(capacity, "IntRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
         this.growable = growable;
 
         // use next larger power of 2 for our storage
-        final int newCapacity;
-        if (capacity < 2) {
-            // sensibly handle the size=0 and size=1 cases
-            newCapacity = 1;
-        } else {
-            newCapacity = Integer.highestOneBit(capacity - 1) << 1;
-        }
-
         // reset the data structure members
-        storage = new int[newCapacity];
+        storage = new int[MathUtil.roundUpPowerOf2(capacity)];
         mask = storage.length - 1;
         tail = head = 0;
     }
@@ -73,9 +63,9 @@ protected void grow(int increase) {
         final int size = size();
         final long newCapacity = (long) storage.length + increase;
         // assert that we are not asking for the impossible
-        Assert.leq(newCapacity, "IntRingBuffer capacity", RING_BUFFER_MAX_CAPACITY);
+        Assert.leq(newCapacity, "IntRingBuffer capacity", MathUtil.MAX_POWER_OF_2);
 
-        final int[] newStorage = new int[Integer.highestOneBit((int) newCapacity - 1) << 1];
+        final int[] newStorage = new int[MathUtil.roundUpPowerOf2((int) newCapacity)];
 
         // move the current data to the new buffer
         copyRingBufferToArray(newStorage);