ROOT::Experimental::RClusterDescriptor Class Reference

Meta-data for a set of ntuple clusters.

The cluster descriptor is built in two phases. In a first phase, the descriptor has only an ID. In a second phase, the event range, column group, page locations and column ranges are added. Both phases are populated by the RClusterDescriptorBuilder. Clusters usually span across all available columns but in some cases they can describe only a subset of the columns, for instance when describing friend ntuples.

Definition at line 230 of file RNTupleDescriptor.hxx.

Classes
struct	RColumnRange
	The window of element indexes of a particular column in a particular cluster. More...
class	RColumnRangeIterable
class	RPageRange
	Records the partition of data into pages for a particular column in a particular cluster. More...

Public Member Functions
	RClusterDescriptor ()=default
	RClusterDescriptor (const RClusterDescriptor &other)=delete
	RClusterDescriptor (RClusterDescriptor &&other)=default
RClusterDescriptor	Clone () const
bool	ContainsColumn (DescriptorId_t physicalId) const
std::uint64_t	GetBytesOnStorage () const
const RColumnRange &	GetColumnRange (DescriptorId_t physicalId) const
RColumnRangeIterable	GetColumnRangeIterable () const
	Returns an iterator over pairs { columnId, columnRange }. The iteration order is unspecified.
NTupleSize_t	GetFirstEntryIndex () const
DescriptorId_t	GetId () const
ClusterSize_t	GetNEntries () const
const RPageRange &	GetPageRange (DescriptorId_t physicalId) const
RClusterDescriptor &	operator= (const RClusterDescriptor &other)=delete
RClusterDescriptor &	operator= (RClusterDescriptor &&other)=default
bool	operator== (const RClusterDescriptor &other) const

Private Attributes
DescriptorId_t	fClusterId = kInvalidDescriptorId
std::unordered_map< DescriptorId_t, RColumnRange >	fColumnRanges
NTupleSize_t	fFirstEntryIndex = kInvalidNTupleIndex
	Clusters can be swapped by adjusting the entry offsets.
ClusterSize_t	fNEntries = kInvalidClusterIndex
std::unordered_map< DescriptorId_t, RPageRange >	fPageRanges

Friends
class	Internal::RClusterDescriptorBuilder

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

RClusterDescriptor() [1/3]

ROOT::Experimental::RClusterDescriptor::RClusterDescriptor ( )

default

RClusterDescriptor() [2/3]

ROOT::Experimental::RClusterDescriptor::RClusterDescriptor ( const RClusterDescriptor &  other )

delete

RClusterDescriptor() [3/3]

ROOT::Experimental::RClusterDescriptor::RClusterDescriptor ( RClusterDescriptor &&  other )

default

Member Function Documentation

Clone()

ROOT::Experimental::RClusterDescriptor ROOT::Experimental::RClusterDescriptor::Clone

(

)

const

Definition at line 251 of file RNTupleDescriptor.cxx.

ContainsColumn()

bool ROOT::Experimental::RClusterDescriptor::ContainsColumn ( DescriptorId_t  physicalId ) const

inline

Definition at line 367 of file RNTupleDescriptor.hxx.

GetBytesOnStorage()

std::uint64_t ROOT::Experimental::RClusterDescriptor::GetBytesOnStorage

(

)

const

Definition at line 240 of file RNTupleDescriptor.cxx.

GetColumnRange()

const RColumnRange & ROOT::Experimental::RClusterDescriptor::GetColumnRange ( DescriptorId_t  physicalId ) const

inline

Definition at line 363 of file RNTupleDescriptor.hxx.

GetColumnRangeIterable()

ROOT::Experimental::RClusterDescriptor::RColumnRangeIterable ROOT::Experimental::RClusterDescriptor::GetColumnRangeIterable

(

)

const

Returns an iterator over pairs { columnId, columnRange }. The iteration order is unspecified.

Definition at line 1157 of file RNTupleDescriptor.cxx.

GetFirstEntryIndex()

NTupleSize_t ROOT::Experimental::RClusterDescriptor::GetFirstEntryIndex ( ) const

inline

Definition at line 361 of file RNTupleDescriptor.hxx.

GetId()

DescriptorId_t ROOT::Experimental::RClusterDescriptor::GetId ( ) const

inline

Definition at line 360 of file RNTupleDescriptor.hxx.

GetNEntries()

ClusterSize_t ROOT::Experimental::RClusterDescriptor::GetNEntries ( ) const

inline

Definition at line 362 of file RNTupleDescriptor.hxx.

GetPageRange()

const RPageRange & ROOT::Experimental::RClusterDescriptor::GetPageRange ( DescriptorId_t  physicalId ) const

inline

Definition at line 364 of file RNTupleDescriptor.hxx.

operator=() [1/2]

RClusterDescriptor & ROOT::Experimental::RClusterDescriptor::operator= ( const RClusterDescriptor &  other )

delete

operator=() [2/2]

RClusterDescriptor & ROOT::Experimental::RClusterDescriptor::operator= ( RClusterDescriptor &&  other )

default

operator==()

bool ROOT::Experimental::RClusterDescriptor::operator==

(

const RClusterDescriptor &

other

)

const

Definition at line 234 of file RNTupleDescriptor.cxx.

Friends And Related Symbol Documentation

Internal::RClusterDescriptorBuilder

friend class Internal::RClusterDescriptorBuilder

friend

Definition at line 231 of file RNTupleDescriptor.hxx.

Member Data Documentation

fClusterId

DescriptorId_t ROOT::Experimental::RClusterDescriptor::fClusterId = kInvalidDescriptorId

private

Definition at line 338 of file RNTupleDescriptor.hxx.

fColumnRanges

std::unordered_map<DescriptorId_t, RColumnRange> ROOT::Experimental::RClusterDescriptor::fColumnRanges

private

Definition at line 344 of file RNTupleDescriptor.hxx.

fFirstEntryIndex

NTupleSize_t ROOT::Experimental::RClusterDescriptor::fFirstEntryIndex = kInvalidNTupleIndex

private

Clusters can be swapped by adjusting the entry offsets.

Definition at line 340 of file RNTupleDescriptor.hxx.

fNEntries

ClusterSize_t ROOT::Experimental::RClusterDescriptor::fNEntries = kInvalidClusterIndex

private

Definition at line 342 of file RNTupleDescriptor.hxx.

fPageRanges

std::unordered_map<DescriptorId_t, RPageRange> ROOT::Experimental::RClusterDescriptor::fPageRanges

private

Definition at line 345 of file RNTupleDescriptor.hxx.

Libraries for ROOT::Experimental::RClusterDescriptor:

---

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

• tree/ntuple/v7/inc/ROOT/RNTupleDescriptor.hxx
• tree/ntuple/v7/src/RNTupleDescriptor.cxx