Project
Loading...
Searching...
No Matches
ROOT::RDF::RCombinedDSColumnJoinIndex< INDEX_TYPE > Class Template Reference

#include <RCombinedDS.h>

Inherits ROOT::RDF::RCombinedDSIndex.

Public Member Functions

 RCombinedDSColumnJoinIndex (std::string const &indexColumnName)
 
std::pair< ULong64_t, ULong64_t > GetAssociatedEntries (ULong64_t entry) final
 
std::vector< std::pair< ULong64_t, ULong64_t > > BuildIndex (std::unique_ptr< RDataFrame > &left, std::unique_ptr< RDataFrame > &right) final
 
- Public Member Functions inherited from ROOT::RDF::RCombinedDSIndex
virtual ~RCombinedDSIndex ()=default
 

Detailed Description

template<typename INDEX_TYPE = int>
class ROOT::RDF::RCombinedDSColumnJoinIndex< INDEX_TYPE >

An index which allows doing a join using a column on the right. FIXME: the need for templation is due to the fact RDataFrame::GetColumnType was introduced only in ROOT 6.16.x. We can remove it once we have a proper build of ROOT.

Definition at line 87 of file RCombinedDS.h.

Constructor & Destructor Documentation

◆ RCombinedDSColumnJoinIndex()

template<typename INDEX_TYPE = int>
ROOT::RDF::RCombinedDSColumnJoinIndex< INDEX_TYPE >::RCombinedDSColumnJoinIndex ( std::string const &  indexColumnName)
inline

Definition at line 90 of file RCombinedDS.h.

Member Function Documentation

◆ BuildIndex()

template<typename INDEX_TYPE = int>
std::vector< std::pair< ULong64_t, ULong64_t > > ROOT::RDF::RCombinedDSColumnJoinIndex< INDEX_TYPE >::BuildIndex ( std::unique_ptr< RDataFrame > &  left,
std::unique_ptr< RDataFrame > &  right 
)
inlinefinalvirtual

This is invoked on every Inititialise of the RCombinedDS to allow constructing the index associated to it.

Parameters
[in]

is the dataframe constructed on top of the left input.

Parameters
[in]

is the dataframe constructed on top of the right input.

Returns
the vector with the ranges of the combined dataset.

Implements ROOT::RDF::RCombinedDSIndex.

Definition at line 102 of file RCombinedDS.h.

◆ GetAssociatedEntries()

template<typename INDEX_TYPE = int>
std::pair< ULong64_t, ULong64_t > ROOT::RDF::RCombinedDSColumnJoinIndex< INDEX_TYPE >::GetAssociatedEntries ( ULong64_t  entry)
inlinefinalvirtual

This is invoked on every GetEntry() of the RCombinedDS and it's used to effectively enumerate all the pairs of the combination.

Parameters
[in]

is the entry in the combined table

Returns
a pair where first is the entry in the associated left table, while right is an entry in the associated right table.

Implements ROOT::RDF::RCombinedDSIndex.

Definition at line 95 of file RCombinedDS.h.


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