Points to an array of objects with RNTuple I/O support, used for bulk reading.

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 RBulkValues class.

Definition at line 872 of file RFieldBase.hxx.

Public Member Functions
	RBulkValues (const RBulkValues &)=delete
	RBulkValues (RBulkValues &&other)
	~RBulkValues ()
void	AdoptBuffer (void *buf, std::size_t capacity)
RBulkValues &	operator= (const RBulkValues &)=delete
RBulkValues &	operator= (RBulkValues &&other)
void *	ReadBulk (RNTupleLocalIndex firstIndex, const bool *maskReq, std::size_t size)
	Reads size values from the associated field, starting from firstIndex.
void *	ReadBulk (ROOT::RNTupleLocalRange range)
	Overload to read all elements in the given cluster range.

Private Member Functions
	RBulkValues (RFieldBase *field)
bool	ContainsRange (RNTupleLocalIndex firstIndex, std::size_t size) const
void *	GetValuePtrAt (std::size_t idx) const
void	ReleaseValues ()
void	Reset (RNTupleLocalIndex 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::RDeleter >	fDeleter
RFieldBase *	fField = nullptr
	The field that created the array of values.
RNTupleLocalIndex	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 RFieldBase::GetValueSize().

Friends
class	RFieldBase

#include <ROOT/RFieldBase.hxx>

Constructor & Destructor Documentation

◆ RBulkValues() [1/3]

ROOT::RFieldBase::RBulkValues::RBulkValues ( RFieldBase * field )

inlineexplicitprivate

Definition at line 906 of file RFieldBase.hxx.

◆ ~RBulkValues()

ROOT::RFieldBase::RBulkValues::~RBulkValues ( )

Definition at line 153 of file RFieldBase.cxx.

◆ RBulkValues() [2/3]

ROOT::RFieldBase::RBulkValues::RBulkValues ( const RBulkValues & )

delete

◆ RBulkValues() [3/3]

ROOT::RFieldBase::RBulkValues::RBulkValues ( RBulkValues && other )

Definition at line 124 of file RFieldBase.cxx.

Member Function Documentation

◆ AdoptBuffer()

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

Definition at line 199 of file RFieldBase.cxx.

◆ ContainsRange()

bool ROOT::RFieldBase::RBulkValues::ContainsRange	(	RNTupleLocalIndex	firstIndex,
		std::size_t	size ) const

inlineprivate

Definition at line 896 of file RFieldBase.hxx.

◆ GetValuePtrAt()

void * ROOT::RFieldBase::RBulkValues::GetValuePtrAt ( std::size_t idx ) const

inlineprivate

Definition at line 904 of file RFieldBase.hxx.

◆ operator=() [1/2]

RBulkValues & ROOT::RFieldBase::RBulkValues::operator= ( const RBulkValues & )

delete

◆ operator=() [2/2]

ROOT::RFieldBase::RBulkValues & ROOT::RFieldBase::RBulkValues::operator= ( RBulkValues && other )

Definition at line 138 of file RFieldBase.cxx.

◆ ReadBulk() [1/2]

void * ROOT::RFieldBase::RBulkValues::ReadBulk	(	RNTupleLocalIndex	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. A nullptr means to read all elements.

Definition at line 926 of file RFieldBase.hxx.

◆ ReadBulk() [2/2]

void * ROOT::RFieldBase::RBulkValues::ReadBulk ( ROOT::RNTupleLocalRange range )

inline

Overload to read all elements in the given cluster range.

Definition at line 961 of file RFieldBase.hxx.

◆ ReleaseValues()

void ROOT::RFieldBase::RBulkValues::ReleaseValues ( )

private

Definition at line 159 of file RFieldBase.cxx.

◆ Reset()

void ROOT::RFieldBase::RBulkValues::Reset	(	RNTupleLocalIndex	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 173 of file RFieldBase.cxx.

◆ RFieldBase

friend class RFieldBase

friend

Definition at line 874 of file RFieldBase.hxx.

Member Data Documentation

◆ fAuxData

std::vector<unsigned char> ROOT::RFieldBase::RBulkValues::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 RBulkValues class does not modify the array in-between calls to the field's BulkRead method.

Definition at line 889 of file RFieldBase.hxx.

◆ fCapacity

std::size_t ROOT::RFieldBase::RBulkValues::fCapacity = 0

private

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

Definition at line 880 of file RFieldBase.hxx.

◆ fDeleter

std::unique_ptr<RFieldBase::RDeleter> ROOT::RFieldBase::RBulkValues::fDeleter

private

Definition at line 877 of file RFieldBase.hxx.

◆ fField

RFieldBase* ROOT::RFieldBase::RBulkValues::fField = nullptr

private

The field that created the array of values.

Definition at line 876 of file RFieldBase.hxx.

◆ fFirstIndex

RNTupleLocalIndex ROOT::RFieldBase::RBulkValues::fFirstIndex

private

Index of the first value of the array.

Definition at line 885 of file RFieldBase.hxx.

◆ fIsAdopted

bool ROOT::RFieldBase::RBulkValues::fIsAdopted = false

private

True if the user provides the memory buffer for fValues.

Definition at line 882 of file RFieldBase.hxx.

◆ fMaskAvail

std::unique_ptr<bool[]> ROOT::RFieldBase::RBulkValues::fMaskAvail

private

Masks invalid values in the array.

Definition at line 883 of file RFieldBase.hxx.

◆ fNValidValues

std::size_t ROOT::RFieldBase::RBulkValues::fNValidValues = 0

private

The sum of non-zero elements in the fMask.

Definition at line 884 of file RFieldBase.hxx.

◆ fSize

std::size_t ROOT::RFieldBase::RBulkValues::fSize = 0

private

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

Definition at line 881 of file RFieldBase.hxx.

◆ fValues

void* ROOT::RFieldBase::RBulkValues::fValues = nullptr

private

Cached deleter of fField.

Pointer to the start of the array

Definition at line 878 of file RFieldBase.hxx.

◆ fValueSize

std::size_t ROOT::RFieldBase::RBulkValues::fValueSize = 0

private

Cached copy of RFieldBase::GetValueSize().

Definition at line 879 of file RFieldBase.hxx.

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

tree/ntuple/inc/ROOT/RFieldBase.hxx
tree/ntuple/src/RFieldBase.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ RBulkValues() [1/3]

◆ ~RBulkValues()

◆ RBulkValues() [2/3]

◆ RBulkValues() [3/3]

Member Function Documentation

◆ AdoptBuffer()

◆ ContainsRange()

◆ GetValuePtrAt()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadBulk() [1/2]

◆ ReadBulk() [2/2]

◆ ReleaseValues()

◆ Reset()

Friends And Related Symbol Documentation

◆ RFieldBase

Member Data Documentation

◆ fAuxData

◆ fCapacity

◆ fDeleter

◆ fField

◆ fFirstIndex

◆ fIsAdopted

◆ fMaskAvail

◆ fNValidValues

◆ fSize

◆ fValues

◆ fValueSize