Skip to content

Adds index_codecs to the sharding codec #253

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jul 26, 2023
Merged

Adds index_codecs to the sharding codec #253

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
065cb0c
adds index_codecs to the sharding spec
normanrz Jul 19, 2023
25ef408
tweaks
normanrz Jul 19, 2023
b8e3995
applied pr feedback
normanrz Jul 19, 2023
72165cc
Update docs/v3/codecs/crc32c/v1.0.rst
normanrz Jul 25, 2023
f1cca01
clarified c.compute_encoded_size signature
normanrz Jul 25, 2023
5924fc1
Update v3.0.rst
normanrz Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/v3/core/v3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1186,10 +1186,19 @@ of an additional operation:
encoded representation is a byte string, then ``decoded_regions``
specifies a list of byte ranges.

- ``c.compute_encoded_size(input_size)``, a procedure that determines the byte
size of the encoded representation given a byte size of the decoded representation.
- ``c.compute_encoded_size(input_size)``, a procedure that determines the
size of the encoded representation given a size of the decoded representation.
This procedure cannot be implemented for codecs that produce variable-sized
encoded representations, such as compression algorithms.
encoded representations, such as compression algorithms. Depending on the
type of the codec, the signature could differ:

- ``c.compute_encoded_size(array_size, dtype) -> (array_size, dtpye)``
for ``array -> array`` codecs, where ``array_size`` is the number of items
in the array, i.e., the product of the components of the array's shape;
- ``c.compute_encoded_size(array_size, dtype) -> byte_size``
for ``array -> bytes`` codecs;
- ``c.compute_encoded_size(byte_size) -> byte_size``
for ``bytes -> bytes`` codecs.

.. note::

Expand Down