Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::RClusterDescriptor::RColumnRange Class Referencefinal
RNTuple

The window of element indexes of a particular column in a particular cluster.

Definition at line 291 of file RNTupleDescriptor.hxx.

Public Member Functions

 RColumnRange ()=default
 RColumnRange (ROOT::DescriptorId_t physicalColumnId, ROOT::NTupleSize_t firstElementIndex, ROOT::NTupleSize_t nElements, std::optional< std::uint32_t > compressionSettings, bool suppressed=false)
bool Contains (ROOT::NTupleSize_t index) const
std::optional< std::uint32_t > GetCompressionSettings () const
ROOT::NTupleSize_t GetFirstElementIndex () const
ROOT::NTupleSize_t GetNElements () const
ROOT::DescriptorId_t GetPhysicalColumnId () const
void IncrementFirstElementIndex (ROOT::NTupleSize_t by)
void IncrementNElements (ROOT::NTupleSize_t by)
bool IsSuppressed () const
bool operator== (const RColumnRange &other) const
void SetCompressionSettings (std::optional< std::uint32_t > comp)
void SetFirstElementIndex (ROOT::NTupleSize_t idx)
void SetIsSuppressed (bool suppressed)
void SetNElements (ROOT::NTupleSize_t n)
void SetPhysicalColumnId (ROOT::DescriptorId_t id)

Private Attributes

std::optional< std::uint32_t > fCompressionSettings
 The usual format for ROOT compression settings (see Compression.h).
ROOT::NTupleSize_t fFirstElementIndex = ROOT::kInvalidNTupleIndex
 The global index of the first column element in the cluster.
bool fIsSuppressed = false
 Suppressed columns have an empty page range and unknown compression settings.
ROOT::NTupleSize_t fNElements = ROOT::kInvalidNTupleIndex
 The number of column elements in the cluster.
ROOT::DescriptorId_t fPhysicalColumnId = ROOT::kInvalidDescriptorId

#include <ROOT/RNTupleDescriptor.hxx>

Constructor & Destructor Documentation

◆ RColumnRange() [1/2]

ROOT::RClusterDescriptor::RColumnRange::RColumnRange ( )
default

◆ RColumnRange() [2/2]

ROOT::RClusterDescriptor::RColumnRange::RColumnRange ( ROOT::DescriptorId_t physicalColumnId,
ROOT::NTupleSize_t firstElementIndex,
ROOT::NTupleSize_t nElements,
std::optional< std::uint32_t > compressionSettings,
bool suppressed = false )
inline

Definition at line 312 of file RNTupleDescriptor.hxx.

Member Function Documentation

◆ Contains()

bool ROOT::RClusterDescriptor::RColumnRange::Contains ( ROOT::NTupleSize_t index) const
inline

Definition at line 347 of file RNTupleDescriptor.hxx.

◆ GetCompressionSettings()

std::optional< std::uint32_t > ROOT::RClusterDescriptor::RColumnRange::GetCompressionSettings ( ) const
inline

Definition at line 334 of file RNTupleDescriptor.hxx.

◆ GetFirstElementIndex()

ROOT::NTupleSize_t ROOT::RClusterDescriptor::RColumnRange::GetFirstElementIndex ( ) const
inline

Definition at line 326 of file RNTupleDescriptor.hxx.

◆ GetNElements()

ROOT::NTupleSize_t ROOT::RClusterDescriptor::RColumnRange::GetNElements ( ) const
inline

Definition at line 330 of file RNTupleDescriptor.hxx.

◆ GetPhysicalColumnId()

ROOT::DescriptorId_t ROOT::RClusterDescriptor::RColumnRange::GetPhysicalColumnId ( ) const
inline

Definition at line 323 of file RNTupleDescriptor.hxx.

◆ IncrementFirstElementIndex()

void ROOT::RClusterDescriptor::RColumnRange::IncrementFirstElementIndex ( ROOT::NTupleSize_t by)
inline

Definition at line 328 of file RNTupleDescriptor.hxx.

◆ IncrementNElements()

void ROOT::RClusterDescriptor::RColumnRange::IncrementNElements ( ROOT::NTupleSize_t by)
inline

Definition at line 332 of file RNTupleDescriptor.hxx.

◆ IsSuppressed()

bool ROOT::RClusterDescriptor::RColumnRange::IsSuppressed ( ) const
inline

Definition at line 337 of file RNTupleDescriptor.hxx.

◆ operator==()

bool ROOT::RClusterDescriptor::RColumnRange::operator== ( const RColumnRange & other) const
inline

Definition at line 340 of file RNTupleDescriptor.hxx.

◆ SetCompressionSettings()

void ROOT::RClusterDescriptor::RColumnRange::SetCompressionSettings ( std::optional< std::uint32_t > comp)
inline

Definition at line 335 of file RNTupleDescriptor.hxx.

◆ SetFirstElementIndex()

void ROOT::RClusterDescriptor::RColumnRange::SetFirstElementIndex ( ROOT::NTupleSize_t idx)
inline

Definition at line 327 of file RNTupleDescriptor.hxx.

◆ SetIsSuppressed()

void ROOT::RClusterDescriptor::RColumnRange::SetIsSuppressed ( bool suppressed)
inline

Definition at line 338 of file RNTupleDescriptor.hxx.

◆ SetNElements()

void ROOT::RClusterDescriptor::RColumnRange::SetNElements ( ROOT::NTupleSize_t n)
inline

Definition at line 331 of file RNTupleDescriptor.hxx.

◆ SetPhysicalColumnId()

void ROOT::RClusterDescriptor::RColumnRange::SetPhysicalColumnId ( ROOT::DescriptorId_t id)
inline

Definition at line 324 of file RNTupleDescriptor.hxx.

Member Data Documentation

◆ fCompressionSettings

std::optional<std::uint32_t> ROOT::RClusterDescriptor::RColumnRange::fCompressionSettings
private

The usual format for ROOT compression settings (see Compression.h).

The pages of a particular column in a particular cluster are all compressed with the same settings. If unset, the compression settings are undefined (deferred columns, suppressed columns).

Definition at line 300 of file RNTupleDescriptor.hxx.

◆ fFirstElementIndex

ROOT::NTupleSize_t ROOT::RClusterDescriptor::RColumnRange::fFirstElementIndex = ROOT::kInvalidNTupleIndex
private

The global index of the first column element in the cluster.

Definition at line 294 of file RNTupleDescriptor.hxx.

◆ fIsSuppressed

bool ROOT::RClusterDescriptor::RColumnRange::fIsSuppressed = false
private

Suppressed columns have an empty page range and unknown compression settings.

Their element index range, however, is aligned with the corresponding column of the primary column representation (see Section "Suppressed Columns" in the specification)

Definition at line 304 of file RNTupleDescriptor.hxx.

◆ fNElements

ROOT::NTupleSize_t ROOT::RClusterDescriptor::RColumnRange::fNElements = ROOT::kInvalidNTupleIndex
private

The number of column elements in the cluster.

Definition at line 296 of file RNTupleDescriptor.hxx.

◆ fPhysicalColumnId

ROOT::DescriptorId_t ROOT::RClusterDescriptor::RColumnRange::fPhysicalColumnId = ROOT::kInvalidDescriptorId
private

Definition at line 292 of file RNTupleDescriptor.hxx.

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