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

No shuffle repeat #589

Merged
merged 2 commits into from
Feb 21, 2024
Merged

No shuffle repeat #589

merged 2 commits into from
Feb 21, 2024

Conversation

FrancescAlted
Copy link
Member

We introduced the capability of repeating the shuffle filter (and only the shuffle) in C-Blosc2, but we recently discovered issues when using repeat values that are odd (i.e. not even). This PR removes this capability because:

  1. It is buggy
  2. It was not documented
  3. In our tests, it does not provide any significant advantage in compression ratio
  4. It complicates code

As it was not documented (besides than buggy), we don't expect this would break anybody's code.

Also, this PR completes documentation on internal filters (essentially, it explicitly says that filters_meta does not have any effect on shuffle, bitshuffle and delta filters).

Copy link
Collaborator

@martaiborra martaiborra left a comment

Choose a reason for hiding this comment

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

LGTM!

@FrancescAlted FrancescAlted merged commit 1dd1e55 into main Feb 21, 2024
33 checks passed
@FrancescAlted FrancescAlted deleted the no-shuffle-repeat branch February 21, 2024 10:52
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.

2 participants