Skip to content

Commit

Permalink
[skip-ci][ntuple] specifications.md: document RNTupleCardinality
Browse files Browse the repository at this point in the history
See also: #12008
  • Loading branch information
jalopezg-git committed Feb 2, 2023
1 parent 7807859 commit 24ea0de
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions tree/ntuple/v7/doc/specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,14 @@ The on-disk representation is similar to a `std::vector<T>` where `T` is the val
- Child field of type `T`, which must by a type with RNTuple I/O support.
The name of the child field is `_0`.

### ROOT::Experimental::RNTupleCardinality

A field whose type is `ROOT::Experimental::RNTupleCardinality` is associated to a single column of type (Split)Index32 or (Split)Index64.
This field presents the offsets in the index column as lengths that correspond to the cardinality of the pointed-to collection.

The value for the $i$-th element is computed by subtracting the $(i-1)$-th value from the $i$-th value in the index column.
If $i == 0$, i.e. it falls on the start of a cluster, the $(i-1)$-th value in the index column is assumed to be 0, e.g. given the index column values `[1, 1, 3]`, the values yielded by `RNTupleCardinality` shall be `[1, 0, 2]`.

## Limits

TODO(jblomer)
Expand Down

0 comments on commit 24ea0de

Please sign in to comment.