Processor specialization for horizontally combined (joined) RNTupleProcessors.

Definition at line 747 of file RNTupleProcessor.hxx.

Public Member Functions
	RNTupleJoinProcessor (const RNTupleJoinProcessor &)=delete

	RNTupleJoinProcessor (RNTupleJoinProcessor &&)=delete

	~RNTupleJoinProcessor () override=default

RIterator	begin ()

RIterator	end ()

ROOT::NTupleSize_t	GetCurrentEntryNumber () const
	Get the entry number that is currently being processed.

std::size_t	GetCurrentProcessorNumber () const
	Get the number of the inner processor currently being read.

ROOT::NTupleSize_t	GetNEntriesProcessed () const
	Get the total number of entries processed so far.

const std::string &	GetProcessorName () const
	Get the name of the processor.

RNTupleJoinProcessor	operator= (const RNTupleJoinProcessor &)=delete

RNTupleJoinProcessor	operator= (RNTupleJoinProcessor &&)=delete

void	PrintStructure (std::ostream &output=std::cout)
	Print a graphical representation of the processor composition.

template<typename T >
RNTupleProcessorOptionalPtr< T >	RequestField (const std::string &fieldName, void *valuePtr=nullptr)
	Request access to a field for reading during processing.

Static Public Member Functions
static std::unique_ptr< RNTupleProcessor >	Create (RNTupleOpenSpec ntuple, std::string_view processorName="")
	Create an RNTupleProcessor for a single RNTuple.

static std::unique_ptr< RNTupleProcessor >	CreateChain (std::vector< RNTupleOpenSpec > ntuples, std::string_view processorName="")
	Create an RNTupleProcessor for a chain (i.e., a vertical combination) of RNTuples.

static std::unique_ptr< RNTupleProcessor >	CreateChain (std::vector< std::unique_ptr< RNTupleProcessor > > innerProcessors, std::string_view processorName="")
	Create an RNTupleProcessor for a chain (i.e., a vertical combination) of other RNTupleProcessors.

static std::unique_ptr< RNTupleProcessor >	CreateJoin (RNTupleOpenSpec primaryNTuple, RNTupleOpenSpec auxNTuple, const std::vector< std::string > &joinFields, std::string_view processorName="")
	Create an RNTupleProcessor for a join (i.e., a horizontal combination) of RNTuples.

static std::unique_ptr< RNTupleProcessor >	CreateJoin (std::unique_ptr< RNTupleProcessor > primaryProcessor, std::unique_ptr< RNTupleProcessor > auxProcessor, const std::vector< std::string > &joinFields, std::string_view processorName="")
	Create an RNTupleProcessor for a join (i.e., a horizontal combination) of RNTuples.

Protected Member Functions
bool	IsInitialized () const
	Check if the processor already has been initialized.

Protected Attributes
ROOT::NTupleSize_t	fCurrentEntryNumber = 0

std::size_t	fCurrentProcessorNumber = 0

std::shared_ptr< Internal::RNTupleProcessorEntry >	fEntry = nullptr

std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t >	fFieldIdxs

ROOT::NTupleSize_t	fNEntries = kInvalidNTupleIndex
	Total number of entries.

ROOT::NTupleSize_t	fNEntriesProcessed = 0

std::string	fProcessorName

Private Member Functions
	RNTupleJoinProcessor (std::unique_ptr< RNTupleProcessor > primaryProcessor, std::unique_ptr< RNTupleProcessor > auxProcessor, const std::vector< std::string > &joinFields, std::string_view processorName)
	Construct a new RNTupleJoinProcessor.

void	AddEntriesToJoinTable (Internal::RNTupleJoinTable &joinTable, ROOT::NTupleSize_t entryOffset=0) final
	Add the entry mappings for this processor to the provided join table.

Internal::RNTupleProcessorEntry::FieldIndex_t	AddFieldToEntry (const std::string &fieldName, const std::string &typeName, void *valuePtr=nullptr, const Internal::RNTupleProcessorProvenance &provenance=Internal::RNTupleProcessorProvenance()) final
	Add a field to the entry.

bool	CanReadFieldFromDisk (std::string_view fieldName) final
	Check if a field exists on-disk and can be read by the processor.

void	Connect (const std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t > &fieldIdxs, const Internal::RNTupleProcessorProvenance &provenance=Internal::RNTupleProcessorProvenance(), bool updateFields=false) final
	Connect the provided fields indices in the entry to their on-disk fields.

ROOT::NTupleSize_t	GetNEntries () final
	Get the total number of entries in this processor.

void	Initialize (std::shared_ptr< Internal::RNTupleProcessorEntry > entry=nullptr) final
	Initialize the processor by creating an (initially empty) `fEntry`, or setting an existing one.

ROOT::NTupleSize_t	LoadEntry (ROOT::NTupleSize_t entryNumber) final
	Load the entry identified by the provided entry number of the primary processor.

void	PrintStructureImpl (std::ostream &output) const final
	Processor-specific implementation for printing its structure, called by PrintStructure().

void	SetAuxiliaryFieldValidity (bool validity)
	Set the validity for all fields in the auxiliary processor at once.

Private Attributes
std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t >	fAuxiliaryFieldIdxs

std::unique_ptr< RNTupleProcessor >	fAuxiliaryProcessor

std::set< Internal::RNTupleProcessorEntry::FieldIndex_t >	fJoinFieldIdxs

std::vector< std::string >	fJoinFieldNames

std::unique_ptr< Internal::RNTupleJoinTable >	fJoinTable

bool	fJoinTableIsBuilt = false

std::unique_ptr< RNTupleProcessor >	fPrimaryProcessor

Friends
class	RNTupleProcessor

#include <ROOT/RNTupleProcessor.hxx>

Inheritance diagram for ROOT::Experimental::RNTupleJoinProcessor:

Constructor & Destructor Documentation

◆ RNTupleJoinProcessor() [1/3]

ROOT::Experimental::RNTupleJoinProcessor::RNTupleJoinProcessor	(	std::unique_ptr< RNTupleProcessor >	primaryProcessor,
		std::unique_ptr< RNTupleProcessor >	auxProcessor,
		const std::vector< std::string > &	joinFields,
		std::string_view	processorName )

private

Construct a new RNTupleJoinProcessor.

Parameters

[in]	primaryProcessor	The primary processor. Its entries are processed in sequential order.
[in]	auxProcessor	The processor to join the primary processor with. The order in which its entries are processed is determined by the primary processor and doesn't necessarily have to be sequential.
[in]	joinFields	The names of the fields on which to join, in case the specified processors are unaligned. The join is made based on the combined join field values, and therefore each field has to be present in each specified processor. If an empty list is provided, it is assumed that the processors are fully aligned.
[in]	processorName	Name of the processor. Unless specified otherwise in RNTupleProcessor::CreateJoin, this is the name of the primary processor.

Definition at line 419 of file RNTupleProcessor.cxx.

◆ RNTupleJoinProcessor() [2/3]

ROOT::Experimental::RNTupleJoinProcessor::RNTupleJoinProcessor ( const RNTupleJoinProcessor & )

delete

◆ RNTupleJoinProcessor() [3/3]

ROOT::Experimental::RNTupleJoinProcessor::RNTupleJoinProcessor ( RNTupleJoinProcessor && )

delete

◆ ~RNTupleJoinProcessor()

ROOT::Experimental::RNTupleJoinProcessor::~RNTupleJoinProcessor ( )

overridedefault

Member Function Documentation

◆ AddEntriesToJoinTable()

void ROOT::Experimental::RNTupleJoinProcessor::AddEntriesToJoinTable	(	Internal::RNTupleJoinTable &	joinTable,
		ROOT::NTupleSize_t	entryOffset = 0 )

finalprivatevirtual

Add the entry mappings for this processor to the provided join table.

See also: ROOT::Experimental::RNTupleProcessor::AddEntriesToJoinTable

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 581 of file RNTupleProcessor.cxx.

◆ AddFieldToEntry()

ROOT::Experimental::Internal::RNTupleProcessorEntry::FieldIndex_t ROOT::Experimental::RNTupleJoinProcessor::AddFieldToEntry	(	const std::string &	fieldName,
		const std::string &	typeName,
		void *	valuePtr = nullptr,
		const Internal::RNTupleProcessorProvenance &	provenance = Internal::RNTupleProcessorProvenance() )

finalprivatevirtual

Add a field to the entry.

See also: RNTupleProcessor::AddFieldToEntry()

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 489 of file RNTupleProcessor.cxx.

◆ begin()

RIterator ROOT::Experimental::RNTupleProcessor::begin ( )

inlineinherited

Definition at line 479 of file RNTupleProcessor.hxx.

◆ CanReadFieldFromDisk()

bool ROOT::Experimental::RNTupleJoinProcessor::CanReadFieldFromDisk ( std::string_view fieldName )

inlinefinalprivatevirtual

Check if a field exists on-disk and can be read by the processor.

See also: RNTupleProcessor::CanReadFieldFromDisk()

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 791 of file RNTupleProcessor.hxx.

◆ Connect()

void ROOT::Experimental::RNTupleJoinProcessor::Connect	(	const std::unordered_set< Internal::RNTupleProcessorEntry::FieldIndex_t > &	fieldIdxs,
		const Internal::RNTupleProcessorProvenance &	provenance = Internal::RNTupleProcessorProvenance(),
		bool	updateFields = false )

finalprivatevirtual

Connect the provided fields indices in the entry to their on-disk fields.

See also: RNTupleProcessor::Connect()

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 469 of file RNTupleProcessor.cxx.

◆ Create()

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::Create	(	RNTupleOpenSpec	ntuple,
		std::string_view	processorName = "" )

staticinherited

Create an RNTupleProcessor for a single RNTuple.

Parameters

[in]	ntuple	The name and storage location of the RNTuple to process.
[in]	processorName	The name to give to the processor. If empty, the name of the input RNTuple is used.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 37 of file RNTupleProcessor.cxx.

◆ CreateChain() [1/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::CreateChain	(	std::vector< RNTupleOpenSpec >	ntuples,
		std::string_view	processorName = "" )

staticinherited

Create an RNTupleProcessor for a chain (i.e., a vertical combination) of RNTuples.

Parameters

[in]	ntuples	A list specifying the names and locations of the RNTuples to process.
[in]	processorName	The name to give to the processor. If empty, the name of the first RNTuple is used.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 43 of file RNTupleProcessor.cxx.

◆ CreateChain() [2/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::CreateChain	(	std::vector< std::unique_ptr< RNTupleProcessor > >	innerProcessors,
		std::string_view	processorName = "" )

staticinherited

Create an RNTupleProcessor for a chain (i.e., a vertical combination) of other RNTupleProcessors.

Parameters

[in]	innerProcessors	A list with the processors to chain.
[in]	processorName	The name to give to the processor. If empty, the name of the first inner processor is used.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 59 of file RNTupleProcessor.cxx.

◆ CreateJoin() [1/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::CreateJoin	(	RNTupleOpenSpec	primaryNTuple,
		RNTupleOpenSpec	auxNTuple,
		const std::vector< std::string > &	joinFields,
		std::string_view	processorName = "" )

staticinherited

Create an RNTupleProcessor for a join (i.e., a horizontal combination) of RNTuples.

Parameters

[in]	primaryNTuple	The name and location of the primary RNTuple. Its entries are processed in sequential order.
[in]	auxNTuple	The name and location of the RNTuple to join the primary RNTuple with. The order in which its entries are processed is determined by the primary RNTuple and doesn't necessarily have to be sequential.
[in]	joinFields	The names of the fields on which to join, in case the specified RNTuples are unaligned. The join is made based on the combined join field values, and therefore each field has to be present in each specified RNTuple. If an empty list is provided, it is assumed that the specified ntuple are fully aligned.
[in]	processorName	The name to give to the processor. If empty, the name of the primary RNTuple is used.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 69 of file RNTupleProcessor.cxx.

◆ CreateJoin() [2/2]

std::unique_ptr< ROOT::Experimental::RNTupleProcessor > ROOT::Experimental::RNTupleProcessor::CreateJoin	(	std::unique_ptr< RNTupleProcessor >	primaryProcessor,
		std::unique_ptr< RNTupleProcessor >	auxProcessor,
		const std::vector< std::string > &	joinFields,
		std::string_view	processorName = "" )

staticinherited

Create an RNTupleProcessor for a join (i.e., a horizontal combination) of RNTuples.

Parameters

[in]	primaryProcessor	The primary processor. Its entries are processed in sequential order.
[in]	auxProcessor	The processor to join the primary processor with. The order in which its entries are processed is determined by the primary processor and doesn't necessarily have to be sequential.
[in]	joinFields	The names of the fields on which to join, in case the specified processors are unaligned. The join is made based on the combined join field values, and therefore each field has to be present in each specified processors. If an empty list is provided, it is assumed that the specified processors are fully aligned.
[in]	processorName	The name to give to the processor. If empty, the name of the primary processor is used.

Returns: A pointer to the newly created RNTupleProcessor.

Definition at line 89 of file RNTupleProcessor.cxx.

◆ end()

RIterator ROOT::Experimental::RNTupleProcessor::end ( )

inlineinherited

Definition at line 480 of file RNTupleProcessor.hxx.

◆ GetCurrentEntryNumber()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleProcessor::GetCurrentEntryNumber ( ) const

inlineinherited

Get the entry number that is currently being processed.

Definition at line 355 of file RNTupleProcessor.hxx.

◆ GetCurrentProcessorNumber()

std::size_t ROOT::Experimental::RNTupleProcessor::GetCurrentProcessorNumber ( ) const

inlineinherited

Get the number of the inner processor currently being read.

This method is only relevant for the RNTupleChainProcessor. For the other processors, 0 is always returned.

Definition at line 361 of file RNTupleProcessor.hxx.

◆ GetNEntries()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleJoinProcessor::GetNEntries ( )

finalprivatevirtual

Get the total number of entries in this processor.

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 574 of file RNTupleProcessor.cxx.

◆ GetNEntriesProcessed()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleProcessor::GetNEntriesProcessed ( ) const

inlineinherited

Get the total number of entries processed so far.

Definition at line 351 of file RNTupleProcessor.hxx.

◆ GetProcessorName()

const std::string & ROOT::Experimental::RNTupleProcessor::GetProcessorName ( ) const

inlineinherited

Get the name of the processor.

Unless this name was explicitly specified during creation of the processor, this is the name of the underlying RNTuple for RNTupleSingleProcessor, the name of the first processor for RNTupleChainProcessor, or the name of the primary processor for RNTupleJoinProcessor.

Definition at line 369 of file RNTupleProcessor.hxx.

◆ Initialize()

void ROOT::Experimental::RNTupleJoinProcessor::Initialize ( std::shared_ptr< Internal::RNTupleProcessorEntry > entry = nullptr )

finalprivatevirtual

Initialize the processor by creating an (initially empty) fEntry, or setting an existing one.

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 433 of file RNTupleProcessor.cxx.

◆ IsInitialized()

bool ROOT::Experimental::RNTupleProcessor::IsInitialized ( ) const

inlineprotectedinherited

Check if the processor already has been initialized.

Definition at line 273 of file RNTupleProcessor.hxx.

◆ LoadEntry()

ROOT::NTupleSize_t ROOT::Experimental::RNTupleJoinProcessor::LoadEntry ( ROOT::NTupleSize_t entryNumber )

finalprivatevirtual

Load the entry identified by the provided entry number of the primary processor.

See also: ROOT::Experimental::RNTupleProcessor::LoadEntry

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 526 of file RNTupleProcessor.cxx.

◆ operator=() [1/2]

RNTupleJoinProcessor ROOT::Experimental::RNTupleJoinProcessor::operator= ( const RNTupleJoinProcessor & )

delete

◆ operator=() [2/2]

RNTupleJoinProcessor ROOT::Experimental::RNTupleJoinProcessor::operator= ( RNTupleJoinProcessor && )

delete

◆ PrintStructure()

void ROOT::Experimental::RNTupleProcessor::PrintStructure ( std::ostream & output = std::cout )

inlineinherited

Print a graphical representation of the processor composition.

Parameters

[in,out] output Stream to print to (default is stdout).

Example:

The structure of a processor representing a join between a single primary RNTuple and a chain of two auxiliary RNTuples will be printed as follows:

+-----------------------------+ +-----------------------------+
| ntuple                      | | ntuple_aux                  |
| ntuple.root                 | | ntuple_aux1.root            |
+-----------------------------+ +-----------------------------+
                                +-----------------------------+
                                | ntuple_aux                  |
                                | ntuple_aux2.root            |
                                +-----------------------------+

Definition at line 417 of file RNTupleProcessor.hxx.

◆ PrintStructureImpl()

void ROOT::Experimental::RNTupleJoinProcessor::PrintStructureImpl ( std::ostream & output ) const

finalprivatevirtual

Processor-specific implementation for printing its structure, called by PrintStructure().

See also: ROOT::Experimental::RNTupleProcessor::PrintStructureImpl

Implements ROOT::Experimental::RNTupleProcessor.

Definition at line 587 of file RNTupleProcessor.cxx.

◆ RequestField()

template<typename T >

RNTupleProcessorOptionalPtr< T > ROOT::Experimental::RNTupleProcessor::RequestField	(	const std::string &	fieldName,
		void *	valuePtr = nullptr )

inlineinherited

Request access to a field for reading during processing.

Template Parameters

T	Type of the requested field.

Parameters

[in]	fieldName	Name of the requested field.
[in]	valuePtr	Pointer to bind to the field's value in the entry. If this is a `nullptr`, a pointer will be created.

Returns: An RNTupleProcessorOptionalPtr, which provides access to the field's value.

Warning: Provide a valuePtr with care! Values may not always be valid for every entry during processing, for example when a field is not present in one of the chained processors or when during a join operation, no matching entry in the auxiliary processor can be found. Reading valuePtr as-is therefore comes with the risk of reading invalid data. After passing a pointer to RequestField, we strongly recommend only accessing its data through the interface of the returned RNTupleProcessorOptionalPtr, to ensure that only valid data can be read.

Definition at line 388 of file RNTupleProcessor.hxx.

◆ SetAuxiliaryFieldValidity()

void ROOT::Experimental::RNTupleJoinProcessor::SetAuxiliaryFieldValidity ( bool validity )

private

Set the validity for all fields in the auxiliary processor at once.

Definition at line 519 of file RNTupleProcessor.cxx.

Friends And Related Symbol Documentation

◆ RNTupleProcessor

friend class RNTupleProcessor

bool ROOT::Experimental::RNTupleJoinProcessor::fJoinTableIsBuilt = false

private

Definition at line 758 of file RNTupleProcessor.hxx.

◆ fNEntries

ROOT::NTupleSize_t ROOT::Experimental::RNTupleProcessor::fNEntries = kInvalidNTupleIndex

protectedinherited

Total number of entries.

Only to be used internally by the processor, not meant to be exposed in the public interface.

Definition at line 261 of file RNTupleProcessor.hxx.

◆ fNEntriesProcessed

ROOT::NTupleSize_t ROOT::Experimental::RNTupleProcessor::fNEntriesProcessed = 0

protectedinherited

Definition at line 263 of file RNTupleProcessor.hxx.

◆ fPrimaryProcessor

std::unique_ptr<RNTupleProcessor> ROOT::Experimental::RNTupleJoinProcessor::fPrimaryProcessor

private

Definition at line 751 of file RNTupleProcessor.hxx.

◆ fProcessorName

std::string ROOT::Experimental::RNTupleProcessor::fProcessorName

protectedinherited

Definition at line 255 of file RNTupleProcessor.hxx.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ RNTupleJoinProcessor() [1/3]

◆ RNTupleJoinProcessor() [2/3]

◆ RNTupleJoinProcessor() [3/3]

◆ ~RNTupleJoinProcessor()

Member Function Documentation

◆ AddEntriesToJoinTable()

◆ AddFieldToEntry()

◆ begin()

◆ CanReadFieldFromDisk()

◆ Connect()

◆ Create()

◆ CreateChain() [1/2]

◆ CreateChain() [2/2]

◆ CreateJoin() [1/2]

◆ CreateJoin() [2/2]

◆ end()

◆ GetCurrentEntryNumber()

◆ GetCurrentProcessorNumber()

◆ GetNEntries()

◆ GetNEntriesProcessed()

◆ GetProcessorName()

◆ Initialize()

◆ IsInitialized()

◆ LoadEntry()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PrintStructure()

Example:

◆ PrintStructureImpl()

◆ RequestField()

◆ SetAuxiliaryFieldValidity()

Friends And Related Symbol Documentation

◆ RNTupleProcessor

Member Data Documentation

◆ fAuxiliaryFieldIdxs

◆ fAuxiliaryProcessor

◆ fCurrentEntryNumber

◆ fCurrentProcessorNumber

◆ fEntry

◆ fFieldIdxs

◆ fJoinFieldIdxs

◆ fJoinFieldNames

◆ fJoinTable

◆ fJoinTableIsBuilt

◆ fNEntries

◆ fNEntriesProcessed

◆ fPrimaryProcessor

◆ fProcessorName