Skip to content

Commit 11fe0c4

Browse files
dfa1claude
andcommitted
style: S7474+S6218 in new lazy array files
- Convert {code}/{link} → backtick/[ClassName] in /// Markdown javadoc across 20 new lazy array files (RLE, RunEnd, Sparse, AlpRd) - Add @SuppressWarnings("java:S6218") to LazyAlpRdDoubleArray and LazyAlpRdFloatArray (internal data carriers with array components) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent ac09d3e commit 11fe0c4

20 files changed

Lines changed: 81 additions & 79 deletions

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyAlpRdDoubleArray.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,28 @@
55
import java.util.function.DoubleBinaryOperator;
66
import java.util.function.DoubleConsumer;
77

8-
/// Lazy ALP-RD-encoded {@link DoubleArray}.
8+
/// Lazy ALP-RD-encoded [DoubleArray].
99
///
1010
/// ALP-RD splits each f64 into a "left" u16 dictionary code and a "right" u64 payload
1111
/// (the low `rightBitWidth` bits of the original bit pattern). Reconstruction is
1212
/// `Double.longBitsToDouble((dict[left[i]] << rightBitWidth) | right[i])`. A small
1313
/// patches table overrides the dict lookup at specific absolute indices for outlier
1414
/// values that don't compress through the dictionary.
1515
///
16-
/// {@code getDouble(i)} resolves on demand: read left/right children, dispatch through
16+
/// `getDouble(i)` resolves on demand: read left/right children, dispatch through
1717
/// dict (or patch if `i + patchOffset` hits a patch index), shift+or, then bits-to-double.
1818
///
1919
/// @param dtype logical element type
2020
/// @param length total logical row count
2121
/// @param dict small u16 dictionary lookup table (length typically ≤ 16)
22-
/// @param rightBitWidth a bit width of the right payload
22+
/// @param rightBitWidth bit width of the right payload
2323
/// @param leftArr per-row u16 dict codes
2424
/// @param rightArr per-row u64 right payloads (raw bits)
25-
/// @param patchIndices sorted absolute indices of patched rows (or {@code null} when no patches)
25+
/// @param patchIndices sorted absolute indices of patched rows (or `null` when no patches)
2626
/// @param patchLeftValues actual left u16 values for patched rows; aligned with
27-
/// {@code patchIndices}
27+
/// `patchIndices`
2828
/// @param patchOffset absolute origin subtracted from row positions before patch lookup
29+
@SuppressWarnings("java:S6218") // internal data carrier; record components are arrays of immutable primitives or refs that flow through pipelines without ever being compared.
2930
public record LazyAlpRdDoubleArray(
3031
DType dtype, long length,
3132
short[] dict, int rightBitWidth,

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyAlpRdFloatArray.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44

55
import java.util.function.DoubleBinaryOperator;
66

7-
/// Lazy ALP-RD-encoded {@link FloatArray}. See {@link LazyAlpRdDoubleArray} for the
7+
/// Lazy ALP-RD-encoded [FloatArray]. See [LazyAlpRdDoubleArray] for the
88
/// dict + right + patches reconstruction model. The right payload is u32 instead of
9-
/// u64 and the result is reinterpreted via {@link Float#intBitsToFloat}.
9+
/// u64 and the result is reinterpreted via [Float#intBitsToFloat].
1010
///
1111
/// @param dtype logical element type
1212
/// @param length total logical row count
1313
/// @param dict small u16 dictionary lookup table
1414
/// @param rightBitWidth bit width of the right payload
1515
/// @param leftArr per-row u16 dict codes
1616
/// @param rightArr per-row u32 right payloads (raw bits)
17-
/// @param patchIndices sorted absolute indices of patched rows (or {@code null})
17+
/// @param patchIndices sorted absolute indices of patched rows (or `null`)
1818
/// @param patchLeftValues actual left u16 values for patched rows
1919
/// @param patchOffset absolute origin subtracted from row positions before patch lookup
20+
@SuppressWarnings("java:S6218") // internal data carrier; record components are arrays of immutable primitives or refs that flow through pipelines without ever being compared.
2021
public record LazyAlpRdFloatArray(
2122
DType dtype, long length,
2223
short[] dict, int rightBitWidth,

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRleByteArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import java.util.function.LongBinaryOperator;
66

7-
/// Lazy FastLanes-RLE-encoded {@link ByteArray}. See {@link LazyRleLongArray} for semantics.
7+
/// Lazy FastLanes-RLE-encoded [ByteArray]. See [LazyRleLongArray] for semantics.
88
///
99
/// @param dtype logical element type
1010
/// @param length total logical row count
@@ -15,7 +15,7 @@
1515
/// @param valuesLen total values pool length
1616
/// @param numChunks number of FastLanes chunks covered
1717
/// @param offset starting absolute position
18-
/// @param unsigned {@code true} when the dtype is U8 (affects {@link #getInt(long)} widening)
18+
/// @param unsigned `true` when the dtype is U8 (affects [#getInt(long)] widening)
1919
@SuppressWarnings("java:S6218") // internal data carrier; record components are arrays of immutable primitives or refs that flow through pipelines without ever being compared.
2020
public record LazyRleByteArray(
2121
DType dtype, long length, byte[] values, int[] indices,

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRleIntArray.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import java.util.function.IntBinaryOperator;
66
import java.util.function.IntConsumer;
77

8-
/// Lazy FastLanes-RLE-encoded {@link IntArray}. See {@link LazyRleLongArray} for semantics.
8+
/// Lazy FastLanes-RLE-encoded [IntArray]. See [LazyRleLongArray] for semantics.
99
///
1010
/// @param dtype logical element type
1111
/// @param length total logical row count

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRleLongArray.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
import java.util.function.LongBinaryOperator;
66
import java.util.function.LongConsumer;
77

8-
/// Lazy FastLanes-RLE-encoded {@link LongArray}.
8+
/// Lazy FastLanes-RLE-encoded [LongArray].
99
///
1010
/// FastLanes RLE encodes 1024-row chunks of values + indices. For each chunk the
11-
/// distinct values are concatenated into {@code values}; the per-row local index
12-
/// into the chunk's value range lives in {@code indices}; {@code valuesIdxOffsets}
13-
/// gives the chunk-start offset into the global values pool. {@code getLong(i)}
14-
/// resolves {@code values[valuesIdxOffsets[chunkIdx(i)] + clampedLocalIdx(...)]}.
11+
/// distinct values are concatenated into `values`; the per-row local index
12+
/// into the chunk's value range lives in `indices`; `valuesIdxOffsets`
13+
/// gives the chunk-start offset into the global values pool. `getLong(i)`
14+
/// resolves `values[valuesIdxOffsets[chunkIdx(i)] + clampedLocalIdx(...)]`.
1515
///
16-
/// {@code forEachLong} / {@code fold} iterate chunk-by-chunk so the constant-run
16+
/// `forEachLong` / `fold` iterate chunk-by-chunk so the constant-run
1717
/// fast path (`numChunkValues <= 1`) emits each value once with a tight inner loop.
1818
///
1919
/// @param dtype logical element type
2020
/// @param length total logical row count
2121
/// @param values concatenated distinct values per chunk
22-
/// @param indices per-row local index table; length {@code numChunks * 1024}
23-
/// @param valuesIdxOffsets per-chunk values-pool start offsets; length {@code numChunks}
22+
/// @param indices per-row local index table; length `numChunks * 1024`
23+
/// @param valuesIdxOffsets per-chunk values-pool start offsets; length `numChunks`
2424
/// @param firstOffset absolute origin of the values pool
2525
/// @param valuesLen total values pool length
2626
/// @param numChunks number of FastLanes chunks covered
27-
/// @param offset starting absolute position; logical row {@code i} maps to
28-
/// absolute {@code i + offset}
27+
/// @param offset starting absolute position; logical row `i` maps to
28+
/// absolute `i + offset`
2929
@SuppressWarnings("java:S6218") // internal data carrier; record components are arrays of immutable primitives or refs that flow through pipelines without ever being compared.
3030
public record LazyRleLongArray(
3131
DType dtype, long length, long[] values, int[] indices,

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRleShortArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import java.util.function.LongBinaryOperator;
66

7-
/// Lazy FastLanes-RLE-encoded {@link ShortArray}. See {@link LazyRleLongArray} for semantics.
7+
/// Lazy FastLanes-RLE-encoded [ShortArray]. See [LazyRleLongArray] for semantics.
88
///
99
/// @param dtype logical element type
1010
/// @param length total logical row count
@@ -15,7 +15,7 @@
1515
/// @param valuesLen total values pool length
1616
/// @param numChunks number of FastLanes chunks covered
1717
/// @param offset starting absolute position
18-
/// @param unsigned {@code true} when the dtype is U16 (affects {@link #getInt(long)} widening)
18+
/// @param unsigned `true` when the dtype is U16 (affects [#getInt(long)] widening)
1919
@SuppressWarnings("java:S6218") // internal data carrier; record components are arrays of immutable primitives or refs that flow through pipelines without ever being compared.
2020
public record LazyRleShortArray(
2121
DType dtype, long length, short[] values, int[] indices,

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRunEndByteArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
import java.util.function.LongBinaryOperator;
66

7-
/// Lazy RunEnd-encoded {@link ByteArray}. See {@link LazyRunEndLongArray} for semantics.
7+
/// Lazy RunEnd-encoded [ByteArray]. See [LazyRunEndLongArray] for semantics.
88
///
99
/// @param dtype logical element type
1010
/// @param length total logical row count
1111
/// @param values values per run
12-
/// @param runEnds cumulative run-end positions (absolute, before {@code offset})
12+
/// @param runEnds cumulative run-end positions (absolute, before `offset`)
1313
/// @param offset starting absolute position
1414
public record LazyRunEndByteArray(DType dtype, long length, ByteArray values, Array runEnds, long offset)
1515
implements ByteArray {

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRunEndIntArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
import java.util.function.IntBinaryOperator;
66
import java.util.function.IntConsumer;
77

8-
/// Lazy RunEnd-encoded {@link IntArray}. See {@link LazyRunEndLongArray} for semantics.
8+
/// Lazy RunEnd-encoded [IntArray]. See [LazyRunEndLongArray] for semantics.
99
///
1010
/// @param dtype logical element type
1111
/// @param length total logical row count
1212
/// @param values values per run
13-
/// @param runEnds cumulative run-end positions (absolute, before {@code offset})
13+
/// @param runEnds cumulative run-end positions (absolute, before `offset`)
1414
/// @param offset starting absolute position
1515
public record LazyRunEndIntArray(DType dtype, long length, IntArray values, Array runEnds, long offset)
1616
implements IntArray {

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRunEndLongArray.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
import java.util.function.LongBinaryOperator;
66
import java.util.function.LongConsumer;
77

8-
/// Lazy RunEnd-encoded {@link LongArray}. {@code getLong(i) = values.getLong(findRun(i + offset))}.
9-
/// {@code forEachLong} / {@code fold} walk runs (one binary search at start, then per-run loops)
8+
/// Lazy RunEnd-encoded [LongArray]. `getLong(i) = values.getLong(findRun(i + offset))`.
9+
/// `forEachLong` / `fold` walk runs (one binary search at start, then per-run loops)
1010
/// so sequential reads are O(numRuns) work plus length emissions.
1111
///
12-
/// The {@code runEnds} array is typed as {@link Array} because the run-ends ptype varies with
13-
/// the longest-run count — backed by one of {@link ByteArray}, {@link ShortArray},
14-
/// {@link IntArray}, {@link LongArray}.
12+
/// The `runEnds` array is typed as [Array] because the run-ends ptype varies with
13+
/// the longest-run count — backed by one of [ByteArray], [ShortArray],
14+
/// [IntArray], [LongArray].
1515
///
1616
/// @param dtype logical element type
1717
/// @param length total logical row count
18-
/// @param values values per run; length = {@code numRuns}
19-
/// @param runEnds cumulative run-end positions (absolute, before {@code offset});
20-
/// length = {@code numRuns}
21-
/// @param offset starting absolute position; logical row {@code i} maps to
22-
/// absolute {@code i + offset}
18+
/// @param values values per run; length = `numRuns`
19+
/// @param runEnds cumulative run-end positions (absolute, before `offset`);
20+
/// length = `numRuns`
21+
/// @param offset starting absolute position; logical row `i` maps to
22+
/// absolute `i + offset`
2323
public record LazyRunEndLongArray(DType dtype, long length, LongArray values, Array runEnds, long offset)
2424
implements LongArray {
2525

reader/src/main/java/io/github/dfa1/vortex/reader/array/LazyRunEndShortArray.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
import java.util.function.LongBinaryOperator;
66

7-
/// Lazy RunEnd-encoded {@link ShortArray}. See {@link LazyRunEndLongArray} for semantics.
7+
/// Lazy RunEnd-encoded [ShortArray]. See [LazyRunEndLongArray] for semantics.
88
///
99
/// @param dtype logical element type
1010
/// @param length total logical row count
1111
/// @param values values per run
12-
/// @param runEnds cumulative run-end positions (absolute, before {@code offset})
12+
/// @param runEnds cumulative run-end positions (absolute, before `offset`)
1313
/// @param offset starting absolute position
1414
public record LazyRunEndShortArray(DType dtype, long length, ShortArray values, Array runEnds, long offset)
1515
implements ShortArray {

0 commit comments

Comments
 (0)