Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[manual][io] Rectify obsolete information about RNTuple default compression #1031

Merged

Conversation

silverweed
Copy link
Contributor

No description provided.

@silverweed silverweed added the documentation Improvements or additions to documentation label Nov 6, 2024
@silverweed silverweed self-assigned this Nov 6, 2024
@@ -298,7 +298,7 @@ Most analyses on the other hand will benefit from one of the fast compression al
The compression factor, that is, the saving of storage space, varies with the type of data. A buffer containing `N` identical values is compressed better than a set of values with higher entropy.

ROOT offers [several options](https://root.cern/doc/master/structROOT_1_1RCompressionSetting_1_1EAlgorithm.html#ad5ed4ef81888f5406ae0f018ff45fd96), such as LZMA with very high compression ratio, or LZ4 with very high decompression throughput, or ZSTD with a good compromise in performance.
The default compression for [`RNTuple`](https://root.cern/doc/master/structROOT_1_1Experimental_1_1RNTuple.html) is determined based on the data; for everything else it's zlib with compression level 1.
The default compression for [`RNTuple`](https://root.cern/doc/master/structROOT_1_1Experimental_1_1RNTuple.html) is ZSTD level 5; for everything else it's zlib with compression level 1.
Copy link
Member

Choose a reason for hiding this comment

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

While we're at it, this link should be updated to https://root.cern/doc/master/classROOT_1_1RNTuple.html following the move from Experimental (and it's a class already since a while)

@silverweed silverweed merged commit c59ac30 into root-project:main Nov 7, 2024
1 check passed
@silverweed silverweed deleted the ntuple_compression_manual_fix branch November 7, 2024 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants