leerho opened a new pull request, #784:
URL: https://github.com/apache/datasketches-java/pull/784

   ## Summary
   
   The tuple package had no single place that documents its serialized forms. 
This PR adds `tuple/PreambleUtil.java`, following the style of 
`theta/PreambleUtil`. It documents:
   
   - `CompactTupleSketch`, serial version 3 (current): the 1, 2 and 3 
preamble-long cases. This form is binary compatible with C++ and Go.
   - `CompactTupleSketch`, serial versions 1 and 2 (legacy, read only).
   - `QuickSelectSketch` (updatable), serial version 2. This form is 
deprecated, has no seed hash, and only Java reads it.
   - The flags byte of each form.
   - How entries and Summaries are laid out. The image does not record the 
Summary type.
   - The encodings of the example Summaries (`DoubleSummary`, `IntegerSummary` 
and `ArrayOfStringsSummary`), which are specific to Java.
   
   It also adds constants for the byte addresses and serial versions. The 
ArrayOfDoubles layouts are documented in their own classes and are out of scope.
   
   No behavior change: documentation and constants only, and no existing code 
is modified. Switching `CompactTupleSketch` and `QuickSelectSketch` to the new 
constants can follow separately.
   
   ## Verification
   
   `mvn verify` passes, including javadoc and style checks.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to