Logo ROOT   6.12/07
Reference Guide
List of all members | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Experimental::TDF::TTrivialDS Class Referencefinal

Definition at line 11 of file TTrivialDS.hxx.

Public Member Functions

 TTrivialDS (ULong64_t size)
 
 ~TTrivialDS ()
 
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) 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 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...
 
virtual void InitSlot (unsigned int, ULong64_t)
 Convenience method called at the start of the data processing associated to a slot. More...
 

Private Member Functions

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

Private Attributes

std::vector< std::string > fColNames {"col0"}
 
std::vector< ULong64_tfCounter
 
std::vector< ULong64_t * > fCounterAddr
 
std::vector< std::pair< ULong64_t, ULong64_t > > fEntryRanges
 
unsigned int fNSlots = 0U
 
ULong64_t fSize = 0ULL
 

Additional Inherited Members

#include <ROOT/TTrivialDS.hxx>

Inheritance diagram for ROOT::Experimental::TDF::TTrivialDS:
[legend]

Constructor & Destructor Documentation

◆ TTrivialDS()

ROOT::Experimental::TDF::TTrivialDS::TTrivialDS ( ULong64_t  size)

Definition at line 24 of file TTrivialDS.cxx.

◆ ~TTrivialDS()

ROOT::Experimental::TDF::TTrivialDS::~TTrivialDS ( )

Definition at line 28 of file TTrivialDS.cxx.

Member Function Documentation

◆ GetColumnNames()

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

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

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

Definition at line 32 of file TTrivialDS.cxx.

◆ GetColumnReadersImpl()

std::vector< void * > ROOT::Experimental::TDF::TTrivialDS::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 10 of file TTrivialDS.cxx.

◆ GetEntryRanges()

std::vector< std::pair< ULong64_t, ULong64_t > > ROOT::Experimental::TDF::TTrivialDS::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 47 of file TTrivialDS.cxx.

◆ GetTypeName()

std::string ROOT::Experimental::TDF::TTrivialDS::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]columnNameThe name of the column

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

Definition at line 42 of file TTrivialDS.cxx.

◆ HasColumn()

bool ROOT::Experimental::TDF::TTrivialDS::HasColumn ( std::string_view  ) const
virtual

Checks if the dataset has a certain column.

Parameters
[in]columnNameThe name of the column

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

Definition at line 37 of file TTrivialDS.cxx.

◆ Initialise()

void ROOT::Experimental::TDF::TTrivialDS::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 67 of file TTrivialDS.cxx.

◆ SetEntry()

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

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

Parameters
[in]slotThe data processing slot that needs to be considered
[in]entryThe 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 53 of file TTrivialDS.cxx.

◆ SetNSlots()

void ROOT::Experimental::TDF::TTrivialDS::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 58 of file TTrivialDS.cxx.

Member Data Documentation

◆ fColNames

std::vector<std::string> ROOT::Experimental::TDF::TTrivialDS::fColNames {"col0"}
private

Definition at line 16 of file TTrivialDS.hxx.

◆ fCounter

std::vector<ULong64_t> ROOT::Experimental::TDF::TTrivialDS::fCounter
private

Definition at line 17 of file TTrivialDS.hxx.

◆ fCounterAddr

std::vector<ULong64_t *> ROOT::Experimental::TDF::TTrivialDS::fCounterAddr
private

Definition at line 18 of file TTrivialDS.hxx.

◆ fEntryRanges

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

Definition at line 15 of file TTrivialDS.hxx.

◆ fNSlots

unsigned int ROOT::Experimental::TDF::TTrivialDS::fNSlots = 0U
private

Definition at line 13 of file TTrivialDS.hxx.

◆ fSize

ULong64_t ROOT::Experimental::TDF::TTrivialDS::fSize = 0ULL
private

Definition at line 14 of file TTrivialDS.hxx.

Libraries for ROOT::Experimental::TDF::TTrivialDS:
[legend]

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