Logo ROOT  
Reference Guide
ROOT::Internal::RDF::RNumpyDS< ColumnTypes > Class Template Referencefinal

template<typename... ColumnTypes>
class ROOT::Internal::RDF::RNumpyDS< ColumnTypes >

A RDataSource implementation which takes a collection of RVecs, which are able to adopt data from Numpy arrays.

This component allows to create a data source on a set of columns with data coming from RVecs. The adoption of externally provided data, e.g., via Numpy arrays, with RVecs allows to read arbitrary data from memory. In addition, the data source has to keep a reference on the Python owned data so that the lifetime of the data is tied to the datasource.

Definition at line 46 of file RNumpyDS.hxx.

Public Member Functions

 RNumpyDS (PyObject *pyRVecs, std::pair< std::string, ROOT::RVec< ColumnTypes > * >... colsNameVals)
 
 ~RNumpyDS ()
 
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 GetLabel ()
 Return a string representation of the datasource type. 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...
 
bool 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 RDataSource of the number of processing slots (i.e. More...
 
- Public Member Functions inherited from ROOT::RDF::RDataSource
virtual ~RDataSource ()=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 RDF. More...
 
virtual std::unique_ptr< ROOT::Detail::RDF::RColumnReaderBaseGetColumnReaders (unsigned int, std::string_view, const std::type_info &)
 If the other GetColumnReaders overload returns an empty vector, this overload will be called instead. More...
 
virtual void InitSlot (unsigned int, ULong64_t)
 Convenience method called at the start of the data processing associated to a slot. More...
 

Protected Member Functions

std::string AsString ()
 

Private Types

using PointerHolderPtrs_t = std::vector< ROOT::Internal::TDS::TPointerHolder * >
 

Private Member Functions

template<std::size_t... S>
void ColLenghtChecker (std::index_sequence< S... >)
 
Record_t GetColumnReadersImpl (std::string_view colName, const std::type_info &id)
 type-erased vector of pointers to pointers to column values - one per slot More...
 
size_t GetEntriesNumber ()
 
template<std::size_t... S>
void SetEntryHelper (unsigned int slot, ULong64_t entry, std::index_sequence< S... >)
 

Private Attributes

const std::vector< std::string > fColNames
 
const std::map< std::string, std::string > fColTypesMap
 
std::tuple< ROOT::RVec< ColumnTypes > *... > fColumns
 
std::vector< std::pair< ULong64_t, ULong64_t > > fEntryRanges {}
 
unsigned int fNSlots {0}
 
std::vector< PointerHolderPtrs_tfPointerHolders
 
const PointerHolderPtrs_t fPointerHoldersModels
 
PyObjectfPyRVecs
 

Additional Inherited Members

- Protected Types inherited from ROOT::RDF::RDataSource
using Record_t = std::vector< void * >
 

#include <RNumpyDS.hxx>

Inheritance diagram for ROOT::Internal::RDF::RNumpyDS< ColumnTypes >:
[legend]

Member Typedef Documentation

◆ PointerHolderPtrs_t

template<typename... ColumnTypes>
using ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::PointerHolderPtrs_t = std::vector<ROOT::Internal::TDS::TPointerHolder *>
private

Definition at line 47 of file RNumpyDS.hxx.

Constructor & Destructor Documentation

◆ RNumpyDS()

template<typename... ColumnTypes>
ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::RNumpyDS ( PyObject pyRVecs,
std::pair< std::string, ROOT::RVec< ColumnTypes > * >...  colsNameVals 
)
inline

Definition at line 129 of file RNumpyDS.hxx.

◆ ~RNumpyDS()

template<typename... ColumnTypes>
ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::~RNumpyDS ( )
inline

Definition at line 141 of file RNumpyDS.hxx.

Member Function Documentation

◆ AsString()

template<typename... ColumnTypes>
std::string ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::AsString ( )
inlineprotectedvirtual

Reimplemented from ROOT::RDF::RDataSource.

Definition at line 126 of file RNumpyDS.hxx.

◆ ColLenghtChecker()

template<typename... ColumnTypes>
template<std::size_t... S>
void ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::ColLenghtChecker ( std::index_sequence< S... >  )
inlineprivate

Definition at line 105 of file RNumpyDS.hxx.

◆ GetColumnNames()

template<typename... ColumnTypes>
const std::vector<std::string>& ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetColumnNames ( ) const
inlinevirtual

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

Implements ROOT::RDF::RDataSource.

Definition at line 152 of file RNumpyDS.hxx.

◆ GetColumnReadersImpl()

template<typename... ColumnTypes>
Record_t ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetColumnReadersImpl ( std::string_view  name,
const std::type_info &   
)
inlineprivatevirtual

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

Implements ROOT::RDF::RDataSource.

Definition at line 65 of file RNumpyDS.hxx.

◆ GetEntriesNumber()

template<typename... ColumnTypes>
size_t ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetEntriesNumber ( )
inlineprivate

Definition at line 95 of file RNumpyDS.hxx.

◆ GetEntryRanges()

template<typename... ColumnTypes>
std::vector<std::pair<ULong64_t, ULong64_t> > ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetEntryRanges ( )
inlinevirtual

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. This function will be invoked repeatedly by RDataFrame as it needs additional entries to process. The same entry range should not be returned more than once. Returning an empty collection of ranges signals to RDataFrame that the processing can stop.

Implements ROOT::RDF::RDataSource.

Definition at line 154 of file RNumpyDS.hxx.

◆ GetLabel()

template<typename... ColumnTypes>
std::string ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetLabel ( )
inlinevirtual

Return a string representation of the datasource type.

The returned string will be used by ROOT::RDF::SaveGraph() to represent the datasource in the visualization of the computation graph. Concrete datasources can override the default implementation.

Reimplemented from ROOT::RDF::RDataSource.

Definition at line 218 of file RNumpyDS.hxx.

◆ GetTypeName()

template<typename... ColumnTypes>
std::string ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::GetTypeName ( std::string_view  colName) const
inlinevirtual

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

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

Parameters
[in]colNameThe name of the column

Implements ROOT::RDF::RDataSource.

Definition at line 160 of file RNumpyDS.hxx.

◆ HasColumn()

template<typename... ColumnTypes>
bool ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::HasColumn ( std::string_view  colName) const
inlinevirtual

Checks if the dataset has a certain column.

Parameters
[in]colNameThe name of the column

Implements ROOT::RDF::RDataSource.

Definition at line 166 of file RNumpyDS.hxx.

◆ Initialise()

template<typename... ColumnTypes>
void ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::Initialise ( )
inlinevirtual

Convenience method called before starting an event-loop.

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

Reimplemented from ROOT::RDF::RDataSource.

Definition at line 197 of file RNumpyDS.hxx.

◆ SetEntry()

template<typename... ColumnTypes>
bool ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::SetEntry ( unsigned int  slot,
ULong64_t  entry 
)
inlinevirtual

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. Returns true if the entry has to be processed, false otherwise.

Implements ROOT::RDF::RDataSource.

Definition at line 173 of file RNumpyDS.hxx.

◆ SetEntryHelper()

template<typename... ColumnTypes>
template<std::size_t... S>
void ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::SetEntryHelper ( unsigned int  slot,
ULong64_t  entry,
std::index_sequence< S... >   
)
inlineprivate

Definition at line 97 of file RNumpyDS.hxx.

◆ SetNSlots()

template<typename... ColumnTypes>
void ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::SetNSlots ( unsigned int  nSlots)
inlinevirtual

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

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

Implements ROOT::RDF::RDataSource.

Definition at line 179 of file RNumpyDS.hxx.

Member Data Documentation

◆ fColNames

template<typename... ColumnTypes>
const std::vector<std::string> ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fColNames
private

Definition at line 50 of file RNumpyDS.hxx.

◆ fColTypesMap

template<typename... ColumnTypes>
const std::map<std::string, std::string> ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fColTypesMap
private

Definition at line 51 of file RNumpyDS.hxx.

◆ fColumns

template<typename... ColumnTypes>
std::tuple<ROOT::RVec<ColumnTypes>*...> ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fColumns
private

Definition at line 49 of file RNumpyDS.hxx.

◆ fEntryRanges

template<typename... ColumnTypes>
std::vector<std::pair<ULong64_t, ULong64_t> > ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fEntryRanges {}
private

Definition at line 58 of file RNumpyDS.hxx.

◆ fNSlots

template<typename... ColumnTypes>
unsigned int ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fNSlots {0}
private

Definition at line 59 of file RNumpyDS.hxx.

◆ fPointerHolders

template<typename... ColumnTypes>
std::vector<PointerHolderPtrs_t> ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fPointerHolders
private

Definition at line 57 of file RNumpyDS.hxx.

◆ fPointerHoldersModels

template<typename... ColumnTypes>
const PointerHolderPtrs_t ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fPointerHoldersModels
private

Definition at line 56 of file RNumpyDS.hxx.

◆ fPyRVecs

template<typename... ColumnTypes>
PyObject* ROOT::Internal::RDF::RNumpyDS< ColumnTypes >::fPyRVecs
private

Definition at line 63 of file RNumpyDS.hxx.


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