Skip to content

Commit e2c5e87

Browse files
eguiraudetejedor
authored andcommitted
[TDF][NFC] Align user guide to reference guide
1 parent c745e30 commit e2c5e87

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tree/treeplayer/src/TDataFrame.cxx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -536,21 +536,21 @@ once, a run is triggered.
536536
### <a name="ranges"></a>Ranges
537537
When `TDataFrame` is not being used in a multi-thread environment (i.e. no call to `EnableImplicitMT` was made),
538538
`Range` transformations are available. These act very much like filters but instead of basing their decision on
539-
a filter expression, they rely on `start`,`stop` and `stride` parameters.
539+
a filter expression, they rely on `begin`,`end` and `stride` parameters.
540540
541-
- `start`: number of entries that will be skipped before starting processing again
542-
- `stop`: maximum number of entries that will be processed
543-
- `stride`: only process one entry every `stride` entries
541+
- `begin`: initial entry number considered for this range.
542+
- `end`: final entry number (excluded) considered for this range. 0 means that the range goes until the end of the dataset.
543+
- `stride`: process one entry of the [begin, end) range every `stride` entries. Must be strictly greater than 0.
544544
545-
The actual number of entries processed downstream of a `Range` node will be `(stop - start)/stride` (or less if less
545+
The actual number of entries processed downstream of a `Range` node will be `(end - begin)/stride` (or less if less
546546
entries than that are available).
547547
548548
Note that ranges act "locally", not based on the global entry count: `Range(10,50)` means "skip the first 10 entries
549549
*that reach this node*, let the next 40 entries pass, then stop processing". If a range node hangs from a filter node,
550-
and the range has a `start` parameter of 10, that means the range will skip the first 10 entries *that pass the
550+
and the range has a `begin` parameter of 10, that means the range will skip the first 10 entries *that pass the
551551
preceding filter*.
552552
553-
Ranges allow "early quitting": if all branches of execution of a functional graph reached their `stop` value of
553+
Ranges allow "early quitting": if all branches of execution of a functional graph reached their `end` value of
554554
processed entries, the event-loop is immediately interrupted. This is useful for debugging and quick data explorations.
555555
556556
### <a name="custom-columns"></a> Custom columns

0 commit comments

Comments
 (0)