Skip to content

GH-602: Move ALP encoding specification to AlpEncoding.md - #608

Merged
alamb merged 3 commits into
apache:masterfrom
alamb:gh-602-alp-separate-file
Aug 19, 2026
Merged

GH-602: Move ALP encoding specification to AlpEncoding.md#608
alamb merged 3 commits into
apache:masterfrom
alamb:gh-602-alp-separate-file

Conversation

@alamb

@alamb alamb commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Rationale for this change

As suggested by @pitrou in #557 (comment), the ALP algorithm description is long enough that it deserves its own file, following the pattern of other detailed specifications.

What changes are included in this PR?

This PR is a straight move of the spec text, with no changes to the content:

The moved text is verbatim except:

  1. Update some links to point at Encodings.md
  2. Updated headings level (### --> #) to reflect standalone doc

Do these changes have api implications?

No, this is a documentation reorganization only. parquet.thrift already refers readers to Encodings.md, which now links onward to the new file.

🤖 Generated with claude code, reviewed by me (@alamb)

Move the ALP algorithm description (everything from the Overview section
onward) out of Encodings.md into a new AlpEncoding.md, keeping the
introductory description and a link in Encodings.md.

The content is moved verbatim; the only edit is updating the
RLE/Bit-Packing Hybrid link to point back to Encodings.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@alamb
alamb marked this pull request as ready for review August 13, 2026 16:55
@alamb alamb changed the title GH-602: Move detailed ALP encoding specification to AlpEncoding.md GH-602: Move ALP encoding specification to AlpEncoding.md Aug 13, 2026
Comment thread Encodings.md
readings) while remaining fully lossless. Each value is encoded independently,
enabling random access to individual values and parallel encoding/decoding.

#### Overview

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The move looks right.
This leaves the basic description in the Encodings.md file and moves the details (encoding, decoding, layout) to the ALP specific file.

@alamb

alamb commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

Since this is just a mechanical move, and it has several approvals already, I will merge it in

Thank you @prtkgaur @divjotarora @RussellSpitzer @wgtmac and @etseidl 🙏

@alamb
alamb merged commit 24102ed into apache:master Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ALP] Move ALP description into its own file (rather than inlined in Encoding.md)

6 participants