Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame > Class Template Referencefinal

template<typename FilterF, typename PrevDataFrame>
class ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >

Definition at line 53 of file RFilter.hxx.

Public Member Functions

 RFilter (const RFilter &)=delete
 
 RFilter (FilterF f, const ColumnNames_t &columns, std::shared_ptr< PrevDataFrame > pd, const RDFInternal::RBookedDefines &defines, std::string_view name="")
 
 ~RFilter ()
 
void AddFilterName (std::vector< std::string > &filters)
 
template<typename... ColTypes, std::size_t... S>
bool CheckFilterHelper (unsigned int slot, Long64_t entry, TypeList< ColTypes... >, std::index_sequence< S... >)
 
bool CheckFilters (unsigned int slot, Long64_t entry) final
 
virtual void FinaliseSlot (unsigned int slot) final
 Clean-up operations to be performed at the end of a task.
 
std::shared_ptr< RDFGraphDrawing::GraphNodeGetGraph ()
 
void IncrChildrenCount () final
 
void InitSlot (TTreeReader *r, unsigned int slot) final
 
RFilteroperator= (const RFilter &)=delete
 
void PartialReport (ROOT::RDF::RCutFlowReport &rep) const final
 
void Report (ROOT::RDF::RCutFlowReport &rep) const final
 
void StopProcessing () final
 
void TriggerChildrenCount () final
 
- Public Member Functions inherited from ROOT::Detail::RDF::RFilterBase
 RFilterBase (RLoopManager *df, std::string_view name, const unsigned int nSlots, const RDFInternal::RBookedDefines &defines)
 
virtual ~RFilterBase ()
 
virtual void FillReport (ROOT::RDF::RCutFlowReport &) const
 
std::string GetName () const
 
bool HasName () const
 
virtual void InitNode ()
 
RFilterBaseoperator= (const RFilterBase &)=delete
 
virtual void ResetReportCount ()
 
- Public Member Functions inherited from ROOT::Detail::RDF::RNodeBase
 RNodeBase (RLoopManager *lm=nullptr)
 
virtual ~RNodeBase ()
 
virtual RLoopManagerGetLoopManagerUnchecked ()
 
virtual void ResetChildrenCount ()
 

Private Types

using ColumnTypes_t = typename CallableTraits< FilterF >::arg_types
 
using TypeInd_t = std::make_index_sequence< ColumnTypes_t::list_size >
 

Private Attributes

const ColumnNames_t fColumnNames
 
FilterF fFilter
 
std::array< bool, ColumnTypes_t::list_size > fIsDefine
 The nth flag signals whether the nth input column is a custom column or not.
 
PrevDataFrame & fPrevData
 
const std::shared_ptr< PrevDataFrame > fPrevDataPtr
 
std::vector< std::array< std::unique_ptr< RColumnReaderBase >, ColumnTypes_t::list_size > > fValues
 Column readers per slot and per input column.
 

Additional Inherited Members

- Protected Attributes inherited from ROOT::Detail::RDF::RFilterBase
std::vector< ULong64_tfAccepted = {0}
 
RDFInternal::RBookedDefines fDefines
 
std::vector< Long64_tfLastCheckedEntry
 
std::vector< intfLastResult = {true}
 
const std::string fName
 
const unsigned int fNSlots
 Number of thread slots used by this node, inherited from parent node.
 
std::vector< ULong64_tfRejected = {0}
 
- Protected Attributes inherited from ROOT::Detail::RDF::RNodeBase
RLoopManagerfLoopManager
 
unsigned int fNChildren {0}
 Number of nodes of the functional graph hanging from this object.
 
unsigned int fNStopsReceived {0}
 Number of times that a children node signaled to stop processing entries.
 

#include <ROOT/RDF/RFilter.hxx>

Inheritance diagram for ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >:
[legend]

Member Typedef Documentation

◆ ColumnTypes_t

template<typename FilterF , typename PrevDataFrame >
using ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::ColumnTypes_t = typename CallableTraits<FilterF>::arg_types
private

Definition at line 54 of file RFilter.hxx.

◆ TypeInd_t

template<typename FilterF , typename PrevDataFrame >
using ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::TypeInd_t = std::make_index_sequence<ColumnTypes_t::list_size>
private

Definition at line 55 of file RFilter.hxx.

Constructor & Destructor Documentation

◆ RFilter() [1/2]

template<typename FilterF , typename PrevDataFrame >
ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::RFilter ( FilterF  f,
const ColumnNames_t columns,
std::shared_ptr< PrevDataFrame >  pd,
const RDFInternal::RBookedDefines defines,
std::string_view  name = "" 
)
inline

Definition at line 67 of file RFilter.hxx.

◆ RFilter() [2/2]

template<typename FilterF , typename PrevDataFrame >
ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::RFilter ( const RFilter< FilterF, PrevDataFrame > &  )
delete

◆ ~RFilter()

template<typename FilterF , typename PrevDataFrame >
ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::~RFilter ( )
inline

Definition at line 82 of file RFilter.hxx.

Member Function Documentation

◆ AddFilterName()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::AddFilterName ( std::vector< std::string > &  filters)
inlinevirtual

Implements ROOT::Detail::RDF::RFilterBase.

Definition at line 150 of file RFilter.hxx.

◆ CheckFilterHelper()

template<typename FilterF , typename PrevDataFrame >
template<typename... ColTypes, std::size_t... S>
bool ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::CheckFilterHelper ( unsigned int  slot,
Long64_t  entry,
TypeList< ColTypes... >  ,
std::index_sequence< S... >   
)
inline

Definition at line 103 of file RFilter.hxx.

◆ CheckFilters()

template<typename FilterF , typename PrevDataFrame >
bool ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::CheckFilters ( unsigned int  slot,
Long64_t  entry 
)
inlinefinalvirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 84 of file RFilter.hxx.

◆ FinaliseSlot()

template<typename FilterF , typename PrevDataFrame >
virtual void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::FinaliseSlot ( unsigned int  slot)
inlinefinalvirtual

Clean-up operations to be performed at the end of a task.

Implements ROOT::Detail::RDF::RFilterBase.

Definition at line 158 of file RFilter.hxx.

◆ GetGraph()

template<typename FilterF , typename PrevDataFrame >
std::shared_ptr< RDFGraphDrawing::GraphNode > ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::GetGraph ( )
inlinevirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 167 of file RFilter.hxx.

◆ IncrChildrenCount()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::IncrChildrenCount ( )
inlinefinalvirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 136 of file RFilter.hxx.

◆ InitSlot()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::InitSlot ( TTreeReader r,
unsigned int  slot 
)
inlinefinalvirtual

Implements ROOT::Detail::RDF::RFilterBase.

Definition at line 111 of file RFilter.hxx.

◆ operator=()

template<typename FilterF , typename PrevDataFrame >
RFilter & ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::operator= ( const RFilter< FilterF, PrevDataFrame > &  )
delete

◆ PartialReport()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::PartialReport ( ROOT::RDF::RCutFlowReport rep) const
inlinefinalvirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 123 of file RFilter.hxx.

◆ Report()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::Report ( ROOT::RDF::RCutFlowReport rep) const
inlinefinalvirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 121 of file RFilter.hxx.

◆ StopProcessing()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::StopProcessing ( )
inlinefinalvirtual

Implements ROOT::Detail::RDF::RNodeBase.

Definition at line 129 of file RFilter.hxx.

◆ TriggerChildrenCount()

template<typename FilterF , typename PrevDataFrame >
void ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::TriggerChildrenCount ( )
inlinefinalvirtual

Implements ROOT::Detail::RDF::RFilterBase.

Definition at line 144 of file RFilter.hxx.

Member Data Documentation

◆ fColumnNames

template<typename FilterF , typename PrevDataFrame >
const ColumnNames_t ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fColumnNames
private

Definition at line 58 of file RFilter.hxx.

◆ fFilter

template<typename FilterF , typename PrevDataFrame >
FilterF ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fFilter
private

Definition at line 57 of file RFilter.hxx.

◆ fIsDefine

template<typename FilterF , typename PrevDataFrame >
std::array<bool, ColumnTypes_t::list_size> ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fIsDefine
private

The nth flag signals whether the nth input column is a custom column or not.

Definition at line 64 of file RFilter.hxx.

◆ fPrevData

template<typename FilterF , typename PrevDataFrame >
PrevDataFrame& ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fPrevData
private

Definition at line 60 of file RFilter.hxx.

◆ fPrevDataPtr

template<typename FilterF , typename PrevDataFrame >
const std::shared_ptr<PrevDataFrame> ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fPrevDataPtr
private

Definition at line 59 of file RFilter.hxx.

◆ fValues

template<typename FilterF , typename PrevDataFrame >
std::vector<std::array<std::unique_ptr<RColumnReaderBase>, ColumnTypes_t::list_size> > ROOT::Detail::RDF::RFilter< FilterF, PrevDataFrame >::fValues
private

Column readers per slot and per input column.

Definition at line 62 of file RFilter.hxx.

  • tree/dataframe/inc/ROOT/RDF/RFilter.hxx