Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Experimental::RFieldBase::RBulk Class Reference

Similar to RValue but manages an array of consecutive values.

Bulks have to come from the same cluster. Bulk I/O works with two bit masks: the mask of all the available entries in the current bulk and the mask of the required entries in a bulk read. The idea is that a single bulk may serve multiple read operations on the same range, where in each read operation a different subset of values is required. The memory of the value array is managed by the RBulk class.

Definition at line 232 of file RField.hxx.

Public Member Functions

 RBulk (const RBulk &)=delete
 
 RBulk (RBulk &&other)
 
 ~RBulk ()
 
void AdoptBuffer (void *buf, std::size_t capacity)
 
RBulkoperator= (const RBulk &)=delete
 
RBulkoperator= (RBulk &&other)
 
void * ReadBulk (RClusterIndex firstIndex, const bool *maskReq, std::size_t size)
 Reads 'size' values from the associated field, starting from 'firstIndex'.
 

Private Member Functions

 RBulk (RFieldBase *field)
 
bool ContainsRange (RClusterIndex firstIndex, std::size_t size) const
 
void CountValidValues ()
 
void * GetValuePtrAt (std::size_t idx) const
 
void ReleaseValues ()
 
void Reset (RClusterIndex firstIndex, std::size_t size)
 Sets a new range for the bulk.
 

Private Attributes

std::vector< unsigned char > fAuxData
 Reading arrays of complex values may require additional memory, for instance for the elements of arrays of vectors.
 
std::size_t fCapacity = 0
 The size of the array memory block in number of values.
 
std::unique_ptr< RFieldBase::RDeleterfDeleter
 
RFieldBasefField = nullptr
 The field that created the array of values.
 
RClusterIndex fFirstIndex
 Index of the first value of the array.
 
bool fIsAdopted = false
 True if the user provides the memory buffer for fValues.
 
std::unique_ptr< bool[]> fMaskAvail
 Masks invalid values in the array.
 
std::size_t fNValidValues = 0
 The sum of non-zero elements in the fMask.
 
std::size_t fSize = 0
 The number of available values in the array (provided their mask is set)
 
void * fValues = nullptr
 Cached deleter of fField.
 
std::size_t fValueSize = 0
 Cached copy of fField->GetValueSize()
 

Friends

class RFieldBase
 

#include <ROOT/RField.hxx>

Constructor & Destructor Documentation

◆ RBulk() [1/3]

ROOT::Experimental::RFieldBase::RBulk::RBulk ( RFieldBase field)
inlineexplicitprivate

Definition at line 270 of file RField.hxx.

◆ ~RBulk()

ROOT::Experimental::RFieldBase::RBulk::~RBulk ( )

Definition at line 450 of file RField.cxx.

◆ RBulk() [2/3]

ROOT::Experimental::RFieldBase::RBulk::RBulk ( const RBulk )
delete

◆ RBulk() [3/3]

ROOT::Experimental::RFieldBase::RBulk::RBulk ( RBulk &&  other)

Definition at line 421 of file RField.cxx.

Member Function Documentation

◆ AdoptBuffer()

void ROOT::Experimental::RFieldBase::RBulk::AdoptBuffer ( void *  buf,
std::size_t  capacity 
)

Definition at line 505 of file RField.cxx.

◆ ContainsRange()

bool ROOT::Experimental::RFieldBase::RBulk::ContainsRange ( RClusterIndex  firstIndex,
std::size_t  size 
) const
inlineprivate

Definition at line 257 of file RField.hxx.

◆ CountValidValues()

void ROOT::Experimental::RFieldBase::RBulk::CountValidValues ( )
private

Definition at line 498 of file RField.cxx.

◆ GetValuePtrAt()

void * ROOT::Experimental::RFieldBase::RBulk::GetValuePtrAt ( std::size_t  idx) const
inlineprivate

Definition at line 265 of file RField.hxx.

◆ operator=() [1/2]

RBulk & ROOT::Experimental::RFieldBase::RBulk::operator= ( const RBulk )
delete

◆ operator=() [2/2]

ROOT::Experimental::RFieldBase::RBulk & ROOT::Experimental::RFieldBase::RBulk::operator= ( RBulk &&  other)

Definition at line 435 of file RField.cxx.

◆ ReadBulk()

void * ROOT::Experimental::RFieldBase::RBulk::ReadBulk ( RClusterIndex  firstIndex,
const bool maskReq,
std::size_t  size 
)
inline

Reads 'size' values from the associated field, starting from 'firstIndex'.

Note that the index is given relative to a certain cluster. The return value points to the array of read objects. The 'maskReq' parameter is a bool array of at least 'size' elements. Only objects for which the mask is true are guaranteed to be read in the returned value array.

Definition at line 290 of file RField.hxx.

◆ ReleaseValues()

void ROOT::Experimental::RFieldBase::RBulk::ReleaseValues ( )
private

Definition at line 456 of file RField.cxx.

◆ Reset()

void ROOT::Experimental::RFieldBase::RBulk::Reset ( RClusterIndex  firstIndex,
std::size_t  size 
)
private

Sets a new range for the bulk.

If there is enough capacity, the fValues array will be reused. Otherwise a new array is allocated. After reset, fMaskAvail is false for all values.

Definition at line 472 of file RField.cxx.

Friends And Related Symbol Documentation

◆ RFieldBase

friend class RFieldBase
friend

Definition at line 234 of file RField.hxx.

Member Data Documentation

◆ fAuxData

std::vector<unsigned char> ROOT::Experimental::RFieldBase::RBulk::fAuxData
private

Reading arrays of complex values may require additional memory, for instance for the elements of arrays of vectors.

A pointer to the fAuxData array is passed to the field's BulkRead method. The RBulk class does not modify the array in-between calls to the field's BulkRead method.

Definition at line 249 of file RField.hxx.

◆ fCapacity

std::size_t ROOT::Experimental::RFieldBase::RBulk::fCapacity = 0
private

The size of the array memory block in number of values.

Definition at line 240 of file RField.hxx.

◆ fDeleter

std::unique_ptr<RFieldBase::RDeleter> ROOT::Experimental::RFieldBase::RBulk::fDeleter
private

Definition at line 237 of file RField.hxx.

◆ fField

RFieldBase* ROOT::Experimental::RFieldBase::RBulk::fField = nullptr
private

The field that created the array of values.

Definition at line 236 of file RField.hxx.

◆ fFirstIndex

RClusterIndex ROOT::Experimental::RFieldBase::RBulk::fFirstIndex
private

Index of the first value of the array.

Definition at line 245 of file RField.hxx.

◆ fIsAdopted

bool ROOT::Experimental::RFieldBase::RBulk::fIsAdopted = false
private

True if the user provides the memory buffer for fValues.

Definition at line 242 of file RField.hxx.

◆ fMaskAvail

std::unique_ptr<bool[]> ROOT::Experimental::RFieldBase::RBulk::fMaskAvail
private

Masks invalid values in the array.

Definition at line 243 of file RField.hxx.

◆ fNValidValues

std::size_t ROOT::Experimental::RFieldBase::RBulk::fNValidValues = 0
private

The sum of non-zero elements in the fMask.

Definition at line 244 of file RField.hxx.

◆ fSize

std::size_t ROOT::Experimental::RFieldBase::RBulk::fSize = 0
private

The number of available values in the array (provided their mask is set)

Definition at line 241 of file RField.hxx.

◆ fValues

void* ROOT::Experimental::RFieldBase::RBulk::fValues = nullptr
private

Cached deleter of fField.

Pointer to the start of the array

Definition at line 238 of file RField.hxx.

◆ fValueSize

std::size_t ROOT::Experimental::RFieldBase::RBulk::fValueSize = 0
private

Cached copy of fField->GetValueSize()

Definition at line 239 of file RField.hxx.

Libraries for ROOT::Experimental::RFieldBase::RBulk:

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