Definition at line 14 of file TRootDS.hxx.

Public Member Functions
	TRootDS (std::string_view treeName, std::string_view fileNameGlob)

	~TRootDS ()

const std::vector< std::string > &	GetColumnNames () const
	Returns a reference to the collection of the dataset's column names. More...

std::vector< std::pair< ULong64_t, ULong64_t > >	GetEntryRanges ()
	Return ranges of entries to distribute to tasks. More...

std::string	GetTypeName (std::string_view colName) const
	Type of a column as a string, e.g. More...

bool	HasColumn (std::string_view colName) const
	Checks if the dataset has a certain column. More...

void	Initialise ()
	Convenience method called before starting an event-loop. More...

void	InitSlot (unsigned int slot, ULong64_t firstEntry)
	Convenience method called at the start of the data processing associated to a slot. More...

void	SetEntry (unsigned int slot, ULong64_t entry)
	Advance the "cursors" returned by GetColumnReaders to the selected entry for a particular slot. More...

void	SetNSlots (unsigned int nSlots)
	Inform TDataSource of the number of processing slots (i.e. More...

Public Member Functions inherited from ROOT::Experimental::TDF::TDataSource
virtual	~TDataSource ()=default

virtual void	Finalise ()
	Convenience method called after concluding an event-loop. More...

virtual void	FinaliseSlot (unsigned int)
	Convenience method called at the end of the data processing associated to a slot. More...

template<typename T >
std::vector< T ** >	GetColumnReaders (std::string_view columnName)
	Called at most once per column by TDF. More...

Private Member Functions
std::vector< void * >	GetColumnReadersImpl (std::string_view, const std::type_info &)
	type-erased vector of pointers to pointers to column values - one per slot More...

Private Attributes
std::vector< double * >	fAddressesToFree

std::vector< std::vector< void * > >	fBranchAddresses

std::vector< std::unique_ptr< TChain > >	fChains

std::vector< std::pair< ULong64_t, ULong64_t > >	fEntryRanges

std::string	fFileNameGlob

std::vector< std::string >	fListOfBranches

TChain	fModelChain

unsigned int	fNSlots = 0U

std::string	fTreeName

Additional Inherited Members

#include <ROOT/TRootDS.hxx>

Inheritance diagram for ROOT::Experimental::TDF::TRootDS:

[legend]

Constructor & Destructor Documentation

◆ TRootDS()

ROOT::Experimental::TDF::TRootDS::TRootDS	(	std::string_view	treeName,
		std::string_view	fileNameGlob
	)

Definition at line 38 of file TRootDS.cxx.

◆ ~TRootDS()

ROOT::Experimental::TDF::TRootDS::~TRootDS ( )

Definition at line 48 of file TRootDS.cxx.

Member Function Documentation

◆ GetColumnNames()

const std::vector< std::string > & ROOT::Experimental::TDF::TRootDS::GetColumnNames ( ) const

virtual

Returns a reference to the collection of the dataset's column names.

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 72 of file TRootDS.cxx.

◆ GetColumnReadersImpl()

std::vector< void * > ROOT::Experimental::TDF::TRootDS::GetColumnReadersImpl	(	std::string_view	name,
		const std::type_info &
	)

privatevirtual

type-erased vector of pointers to pointers to column values - one per slot

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 16 of file TRootDS.cxx.

◆ GetEntryRanges()

std::vector< std::pair< ULong64_t, ULong64_t > > ROOT::Experimental::TDF::TRootDS::GetEntryRanges ( )

virtual

Return ranges of entries to distribute to tasks.

They are required to be contiguous intervals with no entries skipped. Supposing a dataset with nEntries, the intervals must start at 0 and end at nEntries, e.g. [0-5],[5-10] for 10 entries.

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 113 of file TRootDS.cxx.

◆ GetTypeName()

std::string ROOT::Experimental::TDF::TRootDS::GetTypeName ( std::string_view ) const

virtual

Type of a column as a string, e.g.

GetTypeName("x") == "double". Required for jitting e.g. df.Filter("x>0").

Parameters

[in] columnName The name of the column

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 55 of file TRootDS.cxx.

◆ HasColumn()

bool ROOT::Experimental::TDF::TRootDS::HasColumn ( std::string_view ) const

virtual

Checks if the dataset has a certain column.

Parameters

[in] columnName The name of the column

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 77 of file TRootDS.cxx.

◆ Initialise()

void ROOT::Experimental::TDF::TRootDS::Initialise ( )

virtual

Convenience method called before starting an event-loop.

This method might be called multiple times over the lifetime of a TDataSource, since users can run multiple event-loops with the same TDataFrame. Ideally, Initialise should set the state of the TDataSource so that multiple identical event-loops will produce identical results.

Reimplemented from ROOT::Experimental::TDF::TDataSource.

Definition at line 137 of file TRootDS.cxx.

◆ InitSlot()

void ROOT::Experimental::TDF::TRootDS::InitSlot	(	unsigned int	,
		ULong64_t
	)

virtual

Convenience method called at the start of the data processing associated to a slot.

Parameters

[in]	slot	The data processing slot wihch needs to be initialised
[in]	firstEntry	The first entry of the range that the task will process. This method might be called multiple times per thread per event-loop.

Reimplemented from ROOT::Experimental::TDF::TDataSource.

Definition at line 84 of file TRootDS.cxx.

◆ SetEntry()

void ROOT::Experimental::TDF::TRootDS::SetEntry	(	unsigned int	slot,
		ULong64_t	entry
	)

virtual

Advance the "cursors" returned by GetColumnReaders to the selected entry for a particular slot.

Parameters

[in]	slot	The data processing slot that needs to be considered
[in]	entry	The entry which needs to be pointed to by the reader pointers Slots are adopted to accommodate parallel data processing. Different workers will loop over different ranges and will be labelled by different "slot" values.

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 119 of file TRootDS.cxx.

◆ SetNSlots()

void ROOT::Experimental::TDF::TRootDS::SetNSlots ( unsigned int nSlots )

virtual

Inform TDataSource of the number of processing slots (i.e.

worker threads) used by the associated TDataFrame. Slots numbers are used to simplify parallel execution: TDataFrame guarantees that different threads will always pass different slot values when calling methods concurrently.

Implements ROOT::Experimental::TDF::TDataSource.

Definition at line 124 of file TRootDS.cxx.

Member Data Documentation

◆ fAddressesToFree

std::vector<double *> ROOT::Experimental::TDF::TRootDS::fAddressesToFree

private

Definition at line 20 of file TRootDS.hxx.

◆ fBranchAddresses

std::vector<std::vector<void *> > ROOT::Experimental::TDF::TRootDS::fBranchAddresses

private

Definition at line 23 of file TRootDS.hxx.

◆ fChains

std::vector<std::unique_ptr<TChain> > ROOT::Experimental::TDF::TRootDS::fChains

private

Definition at line 24 of file TRootDS.hxx.

◆ fEntryRanges

std::vector<std::pair<ULong64_t, ULong64_t> > ROOT::Experimental::TDF::TRootDS::fEntryRanges

private

Definition at line 22 of file TRootDS.hxx.

◆ fFileNameGlob

std::string ROOT::Experimental::TDF::TRootDS::fFileNameGlob

private

Definition at line 18 of file TRootDS.hxx.

◆ fListOfBranches

std::vector<std::string> ROOT::Experimental::TDF::TRootDS::fListOfBranches

private

Definition at line 21 of file TRootDS.hxx.

◆ fModelChain

TChain ROOT::Experimental::TDF::TRootDS::fModelChain

mutableprivate

Definition at line 19 of file TRootDS.hxx.

◆ fNSlots

unsigned int ROOT::Experimental::TDF::TRootDS::fNSlots = 0U

private

Definition at line 16 of file TRootDS.hxx.

◆ fTreeName

std::string ROOT::Experimental::TDF::TRootDS::fTreeName

private

Definition at line 17 of file TRootDS.hxx.

Libraries for ROOT::Experimental::TDF::TRootDS:

[legend]

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRootDS()

◆ ~TRootDS()

Member Function Documentation

◆ GetColumnNames()

◆ GetColumnReadersImpl()

◆ GetEntryRanges()

◆ GetTypeName()

◆ HasColumn()

◆ Initialise()

◆ InitSlot()

◆ SetEntry()

◆ SetNSlots()

Member Data Documentation

◆ fAddressesToFree

◆ fBranchAddresses

◆ fChains

◆ fEntryRanges

◆ fFileNameGlob

◆ fListOfBranches

◆ fModelChain

◆ fNSlots

◆ fTreeName