Skip to content
Open
Changes from all commits
Commits
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
84 changes: 61 additions & 23 deletions docs/doxygen/dox/H5.format.4.0.dox
Original file line number Diff line number Diff line change
Expand Up @@ -7584,29 +7584,32 @@
<th width="25%">byte</th>
<th>byte</th>
</tr>
<tr align="center">
<tr>
<td>Version</td>
<td>Dimensionality</td>
<td>Layout Class</td>
<td>Reserved <em>(zero)</em></td>
</tr>
<tr align="center">
<tr>
<td colspan="4">Reserved <em>(zero)</em></td>
</tr>
<tr align="center">
<tr>
<td colspan="4"><br />Data Address<sup>O</sup> <em>(optional)</em><br /><br /></td>
</tr>
<tr align="center">
<tr>
<td colspan="4">Dimension 0 Size</td>
</tr>
<tr align="center">
<tr>
<td colspan="4">Dimension 1 Size</td>
</tr>
<tr align="center">
<tr>
<td colspan="4">...</td>
</tr>
<tr>
<td colspan="4">Dataset Element Size <em>(optional)</em></td>
<td colspan="4">Dimension \#(n - 1) Size</td>
</tr>
<tr>
<td colspan="4">Dataset Element Size</td>
</tr>
<tr>
<td colspan="4">Compact Data Size <em>(optional)</em></td>
Expand Down Expand Up @@ -7652,8 +7655,10 @@
<tr valign=top>
<td>Dimensionality</td>
<td>An array has a fixed dimensionality. This field specifies the number of dimension size fields later
in the message. The value stored for chunked storage is 1 greater than the number of dimensions in
the dataset&rsquo;s dataspace. For example, 2 is stored for a 1 dimensional dataset.</td>
in the message.
<br />For chunked storage, the value stored is one greater than the dataset&rsquo;s actual number of
dimensions. For example, a 1-dimensional dataset stores a value of 2.
This increment accounts for the dataset element size which occupies the final dimension entry.</td>
</tr>
<tr valign=top>
<td>Layout Class</td>
Expand Down Expand Up @@ -7688,19 +7693,28 @@
</tr>
<tr valign=top>
<td>Dimension \#n Size</td>
<td>For contiguous and compact storage the dimensions define the entire size of the array while for chunked storage
they define the size of a single chunk. In all cases, they are in units of array elements (not bytes). The
first dimension stored in the list of dimensions is the slowest changing dimension and the last dimension
stored is the fastest changing dimension.</td>
<td>For contiguous and compact storage the dimensions define the entire size of the array.
They are in units of array elements (not bytes).
The first dimension stored in the list of dimensions is the slowest changing dimension and the last dimension
stored is the fastest changing dimension.
<br />For chunked storage, the dimensions define the size of a single chunk. They are in
units of array elements (not bytes).
The first dimension stored in the list of dimensions is the slowest changing dimension and the
(n - 1) dimension stored is the fastest changing dimension.
The last dimension stored is the dataset element size.</td>
</tr>
<tr>
<td>Dataset Element Size</td>
<td>The size of a dataset element, in bytes. This field is only present for chunked storage.</td>
<td>The size of a dataset element, in bytes.
This field is only present for chunked data storage
and is stored as the last dimension entry in the array of dimensions.
See previous field description.</td>
</tr>
<tr>
<td>Compact Data Size</td>
<td>This field is only present for compact data storage. It contains the size of the raw data for the
dataset array, in bytes.</td>
</tr>
<tr>
<td>Compact Data</td>
<td>This field is only present for compact data storage. It contains the raw data for the dataset
Expand Down Expand Up @@ -7879,7 +7893,7 @@
<td colspan="4">...</td>
</tr>
<tr>
<td colspan="4">Dimension \#n Size</td>
<td colspan="4">Dimension \#(n - 1) Size</td>
</tr>
<tr>
<td colspan="4">Dataset Element Size</td>
Expand All @@ -7896,8 +7910,11 @@
</tr>
<tr>
<td>Dimensionality</td>
<td>>A chunk has a fixed dimensionality. This field specifies the number of dimension size fields
later in the message.</td>
<td>A chunk has a fixed dimensionality.
This field specifies the number of dimension size fields
later in the message. The value stored is 1 greater than the dataset&rsquo;s actual
number of dimensions. For example, a 1-dimensional dataset stores a value of 2.
This increment accounts for the dataset element size which occupies the final dimension entry.</td>
</tr>
<tr>
<td>Address</td>
Expand All @@ -7910,11 +7927,15 @@
<td>Dimension \#n Size</td>
<td>These values define the dimension size of a single chunk, in units of array elements (not bytes).
The first dimension stored in the list of dimensions is the slowest changing dimension and the
last dimension stored is the fastest changing dimension.</td>
(n - 1) dimension stored is the fastest changing dimension.
The final dimension stored is the dataset element size.</td>
</tr>
<tr>
<td>Dataset Element Size</td>
<td>The size of a dataset element, in bytes.</td>
<td>The size of a dataset element, in bytes.
This field is only present for chunked data storage
and is stored as the last dimension entry in the array of dimensions.
See previous field description.</td>
</tr>
</table>

Expand Down Expand Up @@ -8046,7 +8067,10 @@
<td colspan="4"><br />...<br /><br /></td>
</tr>
<tr>
<td colspan="4"><br />Dimension \#n Size <em>(variable size)</em><br /><br /></td>
<td colspan="4"><br />Dimension \#(n - 1) Size <em>(variable size)</em><br /><br /></td>
</tr>
<tr>
<td colspan="4"><br />Dataset Element Size <em>(variable size)</em><br /><br /></td>
</tr>
<tr>
<td>Chunk Indexing Type</td>
Expand Down Expand Up @@ -8088,8 +8112,14 @@
</tr>
<tr>
<td>Dimensionality</td>
<td>A chunk has fixed dimension. This field specifies the number of <em>Dimension Size</em> fields
later in the message.</td>
<td>A chunk has a fixed dimensionality.
This field specifies the number of dimension size fields
later in the message.
The value stored is 1 greater than the dataset&rsquo;s actual
number of dimensions. For example, a 1-dimensional dataset stores a value of 2.
This increment accounts for the dataset element size which occupies the final dimension entry.
</td>
</tr>
</tr>
<tr>
<td>Dimension Size Encoded Length</td>
Expand All @@ -8099,7 +8129,15 @@
<td>Dimension \#n Size</td>
<td>These values define the dimension size of a single chunk, in units of array elements (not bytes).
The first dimension stored in the list of dimensions is the slowest changing dimension and the
last dimension stored is the fastest changing dimension.</td>
(n - 1) dimension stored is the fastest changing dimension.
The final dimension stored is the dataset element size.</td>
</tr>
<tr>
<td>Dataset Element Size</td>
<td>The size of a dataset elemnt, in bytes.

Check failure on line 8137 in docs/doxygen/dox/H5.format.4.0.dox

View workflow job for this annotation

GitHub Actions / Check for spelling errors

elemnt ==> element
This field is only present for chunked data storage
and is stored as the last dimension entry in the array of dimensions.
See previous field description.</td>
</tr>
<tr>
<td>Chunk Indexing Type</td>
Expand Down