spec: add Matrix datatype #8
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
birkenfeld
commented
Feb 20, 2024
| ``"names"``: | ||
| A list of names for each dimension in the data. | ||
|
|
||
| ``"maxlengths"``: |
|
|
||
| As a JSON object containing the following items: | ||
|
|
||
| ``"dims"``: |
| - ``<`` or ``>`` to indicate little or big endianness. | ||
| - ``i``, ``u``, ``f`` to indicate signed or unsigned integers or floating | ||
| point numbers. | ||
| - a number to indicate the number of bytes per element (usually up to 8). |
| Example: ``{"dims": [2, 3], "data": "AACAPwAAAEAAAEBAAACAQAAAoEAAAMBA"}`` | ||
|
|
||
| The order of the matrix elements is defined so that the dimension with the | ||
| fastest running index comes first in ``dims``, ``names`` and ``maxlengths``. |
There was a problem hiding this comment.
better description?
... first vary the first dimension, then the second and so on...
| ``"dims"``: | ||
| The actual length of each dimension in the data. | ||
|
|
||
| ``"data"``: |
| - a number to indicate the number of bytes per element (usually up to 8). | ||
|
|
||
| Example: ``"<u4"`` is a little-endian encoded 32-bit unsigned integer. | ||
|
|
There was a problem hiding this comment.
remark: compression possible with new keyword
| @@ -119,7 +119,7 @@ Accessibles: | |||
| ``get_data()``. | |||
|
|
|||
| ``get_data()`` | |||
There was a problem hiding this comment.
remove parens from commands
| @@ -119,7 +119,7 @@ Accessibles: | |||
| ``get_data()``. | |||
|
|
|||
| ``get_data()`` | |||
| Optional: returns the channel's matrix data, see below for details. | |||
| Optional: returns the channel's matrix data, with a ``matrix`` data type. | |||
There was a problem hiding this comment.
Suggested change
| Optional: returns the channel's matrix data, with a ``matrix`` data type. | |
| Optional: returns the channel's data, with a ``matrix`` data type. |
birkenfeld
force-pushed
the
measurable
branch
from
4dd9f6c
to
5115ac6
Compare
birkenfeld
force-pushed
the
measurable
branch
from
5115ac6
to
aba0f67
Compare
birkenfeld
force-pushed
the
measurable
branch
from
aba0f67
to
abd1c12
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.