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

Document the default b-tree k values in the file format spec #5293

Open
fortnern opened this issue Feb 5, 2025 · 0 comments
Open

Document the default b-tree k values in the file format spec #5293

fortnern opened this issue Feb 5, 2025 · 0 comments
Assignees
Labels
Component - Documentation Doxygen, markdown, etc.

Comments

@fortnern
Copy link
Member

fortnern commented Feb 5, 2025

For version 1 b-trees, knowing the "k" value (related to the node size) is necessary to parse the file format. In some circumstances, this k value is not stored in the file and it is implied that it is the default value. However, the file format spec never lists what these default values are. They are:

For chunk indices: 32
For group symbol tables (internal nodes): 16
For group symbol tables (leaf node): 4

These should be listed in the file format spec because without knowing them it is impossible to parse or create an HDF5 file that uses the implied defaults.

The defaults are implied under one of these conditions:

  • For a version 0 superblock the chunk index k value is never stored, it is always the default 32
  • For a version 3+ superblock if the B-tree k values message is not present in the superblock they are assumed to be the default values
@fortnern fortnern added the Component - Documentation Doxygen, markdown, etc. label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc.
Projects
None yet
Development

No branches or pull requests

2 participants