Skip to content

Commit

Permalink
Add a note about bit-endianness
Browse files Browse the repository at this point in the history
  • Loading branch information
AlenkaF committed Jun 10, 2024
1 parent 2524fda commit 9f9bbff
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/source/format/Intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,19 @@ in an array may be semantically null, whether primitive or nested data type.

In Arrow, a dedicated buffer, known as the validity (or "null") bitmap,
is used alongside the data indicating whether each value in the array is
null or not: a value of 1
means that the value is not-null ("valid"), whereas a value of 0 indicates
that the value is null.
null or not: a value of 1 means that the value is not-null ("valid"), whereas
a value of 0 indicates that the value is null.

This validity bitmap is optional: if there are no missing values in
the array the buffer does not need to be allocated (as in the example
column 1 in the diagram below).

.. note::

We read validity bitmaps right-to-left within a group of 8 bits due to
`bit-endianness <https://en.wikipedia.org/wiki/Bit_numbering>`_ being
used.

Primitive layouts
=================

Expand Down

0 comments on commit 9f9bbff

Please sign in to comment.