Skip to content

Commit affbe33

Browse files
committed
[ntuple][NFC] Improve GetEntryIndex documentation
Add a description of the behaviour of this method in case multiple entry indexes exist.
1 parent 4792c94 commit affbe33

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

tree/ntuple/inc/ROOT/RNTupleJoinTable.hxx

+4-1
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,13 @@ public:
198198
ROOT::NTupleSize_t entryOffset = 0);
199199

200200
/////////////////////////////////////////////////////////////////////////////
201-
/// \brief Get an entry index (if it exists) for the given join field (values), from any partition
201+
/// \brief Get an entry index (if it exists) for the given join field value(s), from any partition.
202202
///
203203
/// \param[in] valuePtrs A vector of pointers to the join field values to look up.
204204
///
205+
/// \note If one or more corresponding entries exist for the given value(s), the first entry index found in the join
206+
/// table is returned. To get *all* the entry indexes, use GetEntryIndexes.
207+
///
205208
/// \return An entry number that corresponds to `valuePtrs`. When there are no corresponding entries,
206209
/// `kInvalidNTupleIndex` is returned.
207210
ROOT::NTupleSize_t GetEntryIndex(const std::vector<void *> &valuePtrs) const;

0 commit comments

Comments
 (0)