ROOT::Experimental::RNTupleAttrRange Class Reference

A range of main entries referred to by an attribute entry.

Each attribute entry contains a set of values referring to 0 or more contiguous entries in the main RNTuple. This class represents that contiguous range of entries.

Definition at line 40 of file RNTupleAttrReading.hxx.

Public Member Functions
	RNTupleAttrRange ()=default
ROOT::NTupleSize_t	GetEnd () const
	Returns one past the last valid index of the range, equal to GetStart() + GetLength().
std::optional< ROOT::NTupleSize_t >	GetFirst () const
	Returns the first valid entry index in the range. Returns nullopt if the range has zero length.
std::optional< std::pair< ROOT::NTupleSize_t, ROOT::NTupleSize_t > >	GetFirstLast () const
	Returns the pair { firstEntryIdx, lastEntryIdx } (inclusive). Returns nullopt if the range has zero length.
std::optional< ROOT::NTupleSize_t >	GetLast () const
	Returns the last valid entry index in the range. Returns nullopt if the range has zero length.
ROOT::NTupleSize_t	GetLength () const
ROOT::NTupleSize_t	GetStart () const
	Returns the beginning of the range.
std::pair< ROOT::NTupleSize_t, ROOT::NTupleSize_t >	GetStartLength () const
	Returns the pair { start, length }.

Static Public Member Functions
static RNTupleAttrRange	FromStartEnd (ROOT::NTupleSize_t start, ROOT::NTupleSize_t end)
	Creates an AttributeRange from [start, end), where end is one past the last valid entry of the range (FromStartEnd(0, 10) will create a range whose last valid index is 9).
static RNTupleAttrRange	FromStartLength (ROOT::NTupleSize_t start, ROOT::NTupleSize_t length)

Private Member Functions
	RNTupleAttrRange (ROOT::NTupleSize_t start, ROOT::NTupleSize_t length)

Private Attributes
ROOT::NTupleSize_t	fLength = 0
ROOT::NTupleSize_t	fStart = 0

#include <ROOT/RNTupleAttrReading.hxx>

Constructor & Destructor Documentation

RNTupleAttrRange() [1/2]

ROOT::Experimental::RNTupleAttrRange::RNTupleAttrRange ( ROOT::NTupleSize_t start, ROOT::NTupleSize_t length )

inlineprivate

Definition at line 44 of file RNTupleAttrReading.hxx.

RNTupleAttrRange() [2/2]

ROOT::Experimental::RNTupleAttrRange::RNTupleAttrRange ( )

default

Member Function Documentation

FromStartEnd()

static RNTupleAttrRange ROOT::Experimental::RNTupleAttrRange::FromStartEnd ( ROOT::NTupleSize_t start, ROOT::NTupleSize_t end )

inlinestatic

Creates an AttributeRange from [start, end), where end is one past the last valid entry of the range (FromStartEnd(0, 10) will create a range whose last valid index is 9).

Definition at line 54 of file RNTupleAttrReading.hxx.

FromStartLength()

static RNTupleAttrRange ROOT::Experimental::RNTupleAttrRange::FromStartLength ( ROOT::NTupleSize_t start, ROOT::NTupleSize_t length )

inlinestatic

Definition at line 47 of file RNTupleAttrReading.hxx.

GetEnd()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleAttrRange::GetEnd ( ) const

inline

Returns one past the last valid index of the range, equal to GetStart() + GetLength().

Definition at line 73 of file RNTupleAttrReading.hxx.

GetFirst()

std::optional< ROOT::NTupleSize_t > ROOT::Experimental::RNTupleAttrRange::GetFirst ( ) const

inline

Returns the first valid entry index in the range. Returns nullopt if the range has zero length.

Definition at line 63 of file RNTupleAttrReading.hxx.

GetFirstLast()

std::optional< std::pair< ROOT::NTupleSize_t, ROOT::NTupleSize_t > > ROOT::Experimental::RNTupleAttrRange::GetFirstLast ( ) const

inline

Returns the pair { firstEntryIdx, lastEntryIdx } (inclusive). Returns nullopt if the range has zero length.

Definition at line 77 of file RNTupleAttrReading.hxx.

GetLast()

std::optional< ROOT::NTupleSize_t > ROOT::Experimental::RNTupleAttrRange::GetLast ( ) const

inline

Returns the last valid entry index in the range. Returns nullopt if the range has zero length.

Definition at line 68 of file RNTupleAttrReading.hxx.

GetLength()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleAttrRange::GetLength ( ) const

inline

Definition at line 74 of file RNTupleAttrReading.hxx.

GetStart()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleAttrRange::GetStart ( ) const

inline

Returns the beginning of the range.

Note that this is not a valid index in the range if the range has zero length.

Definition at line 66 of file RNTupleAttrReading.hxx.

GetStartLength()

std::pair< ROOT::NTupleSize_t, ROOT::NTupleSize_t > ROOT::Experimental::RNTupleAttrRange::GetStartLength ( ) const

inline

Returns the pair { start, length }.

Definition at line 82 of file RNTupleAttrReading.hxx.

Member Data Documentation

fLength

ROOT::NTupleSize_t ROOT::Experimental::RNTupleAttrRange::fLength = 0

private

Definition at line 42 of file RNTupleAttrReading.hxx.

fStart

ROOT::NTupleSize_t ROOT::Experimental::RNTupleAttrRange::fStart = 0

private

Definition at line 41 of file RNTupleAttrReading.hxx.

Libraries for ROOT::Experimental::RNTupleAttrRange:

---

The documentation for this class was generated from the following file:

• tree/ntuple/inc/ROOT/RNTupleAttrReading.hxx