Logo ROOT  
Reference Guide
ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw > Class Template Referencefinal

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

Definition at line 58 of file RFilter.hxx.

Public Member Functions

 RFilter (const RFilter &)=delete
 
 RFilter (FilterF f, const ROOT::RDF::ColumnNames_t &columns, std::shared_ptr< PrevNode_t > pd, const RDFInternal::RColumnRegister &colRegister, std::string_view name="", const std::string &variationName="nominal")
 
 ~RFilter ()
 
void AddFilterName (std::vector< std::string > &filters) final
 
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
 
void FinalizeSlot (unsigned int slot) final
 Clean-up operations to be performed at the end of a task. More...
 
std::shared_ptr< RDFGraphDrawing::GraphNodeGetGraph (std::unordered_map< void *, std::shared_ptr< RDFGraphDrawing::GraphNode > > &visitedMap) final
 
std::shared_ptr< RNodeBaseGetVariedFilter (const std::string &variationName) final
 Return a clone of this Filter that works with values in the variationName "universe". More...
 
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::RColumnRegister &colRegister, const ColumnNames_t &columns, const std::vector< std::string > &prevVariations, const std::string &variation="nominal")
 
 ~RFilterBase () override
 
virtual void FillReport (ROOT::RDF::RCutFlowReport &) const
 
virtual void FinalizeSlot (unsigned int slot)=0
 Clean-up operations to be performed at the end of a task. More...
 
std::string GetName () const
 
bool HasName () const
 
virtual void InitNode ()
 
virtual void InitSlot (TTreeReader *r, unsigned int slot)=0
 
RFilterBaseoperator= (const RFilterBase &)=delete
 
virtual void ResetReportCount ()
 
virtual void TriggerChildrenCount ()=0
 
- Public Member Functions inherited from ROOT::Detail::RDF::RNodeBase
 RNodeBase (const std::vector< std::string > &variations={}, RLoopManager *lm=nullptr)
 
virtual ~RNodeBase ()
 
virtual void AddFilterName (std::vector< std::string > &filters)=0
 
virtual bool CheckFilters (unsigned int, Long64_t)=0
 
virtual std::shared_ptr< ROOT::Internal::RDF::GraphDrawing::GraphNodeGetGraph (std::unordered_map< void *, std::shared_ptr< ROOT::Internal::RDF::GraphDrawing::GraphNode > > &visitedMap)=0
 
virtual RLoopManagerGetLoopManagerUnchecked ()
 
const std::vector< std::string > & GetVariations () const
 
virtual std::shared_ptr< RNodeBaseGetVariedFilter (const std::string &)
 Return a clone of this node that acts as a Filter working with values in the variationName "universe". More...
 
virtual void IncrChildrenCount ()=0
 
virtual void PartialReport (ROOT::RDF::RCutFlowReport &) const =0
 
virtual void Report (ROOT::RDF::RCutFlowReport &) const =0
 
virtual void ResetChildrenCount ()
 
virtual void StopProcessing ()=0
 

Private Types

using ColumnTypes_t = typename CallableTraits< FilterF >::arg_types
 
using PrevNode_t = std::conditional_t< std::is_same< PrevNodeRaw, RJittedFilter >::value, RFilterBase, PrevNodeRaw >
 
using TypeInd_t = std::make_index_sequence< ColumnTypes_t::list_size >
 

Private Attributes

FilterF fFilter
 
PrevNode_tfPrevNode
 
const std::shared_ptr< PrevNode_tfPrevNodePtr
 
std::vector< std::array< RColumnReaderBase *, ColumnTypes_t::list_size > > fValues
 Column readers per slot and per input column. More...
 

Additional Inherited Members

- Protected Attributes inherited from ROOT::Detail::RDF::RFilterBase
std::vector< ULong64_tfAccepted = {0}
 
RDFInternal::RColumnRegister fColRegister
 
const ROOT::RDF::ColumnNames_t fColumnNames
 
ROOT::RVecB fIsDefine
 The nth flag signals whether the nth input column is a custom column or not. More...
 
std::vector< Long64_tfLastCheckedEntry
 
std::vector< intfLastResult = {true}
 
const std::string fName
 
std::vector< ULong64_tfRejected = {0}
 
std::string fVariation
 This indicates for what variation this filter evaluates values. More...
 
std::unordered_map< std::string, std::shared_ptr< RFilterBase > > fVariedFilters
 
- Protected Attributes inherited from ROOT::Detail::RDF::RNodeBase
RLoopManagerfLoopManager
 
unsigned int fNChildren {0}
 Number of nodes of the functional graph hanging from this object. More...
 
unsigned int fNStopsReceived {0}
 Number of times that a children node signaled to stop processing entries. More...
 
std::vector< std::string > fVariations
 List of systematic variations that affect this node. More...
 

#include <ROOT/RDF/RFilter.hxx>

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

Member Typedef Documentation

◆ ColumnTypes_t

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

Definition at line 59 of file RFilter.hxx.

◆ PrevNode_t

template<typename FilterF , typename PrevNodeRaw >
using ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::PrevNode_t = std::conditional_t<std::is_same<PrevNodeRaw, RJittedFilter>::value, RFilterBase, PrevNodeRaw>
private

Definition at line 64 of file RFilter.hxx.

◆ TypeInd_t

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

Definition at line 60 of file RFilter.hxx.

Constructor & Destructor Documentation

◆ RFilter() [1/2]

template<typename FilterF , typename PrevNodeRaw >
ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::RFilter ( FilterF  f,
const ROOT::RDF::ColumnNames_t columns,
std::shared_ptr< PrevNode_t pd,
const RDFInternal::RColumnRegister colRegister,
std::string_view  name = "",
const std::string &  variationName = "nominal" 
)
inline

Definition at line 73 of file RFilter.hxx.

◆ RFilter() [2/2]

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

◆ ~RFilter()

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

Definition at line 86 of file RFilter.hxx.

Member Function Documentation

◆ AddFilterName()

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

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

Definition at line 156 of file RFilter.hxx.

◆ CheckFilterHelper()

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

Definition at line 111 of file RFilter.hxx.

◆ CheckFilters()

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

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

Definition at line 92 of file RFilter.hxx.

◆ FinalizeSlot()

template<typename FilterF , typename PrevNodeRaw >
void ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::FinalizeSlot ( unsigned int  slot)
inlinefinalvirtual

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

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

Definition at line 164 of file RFilter.hxx.

◆ GetGraph()

template<typename FilterF , typename PrevNodeRaw >
std::shared_ptr< RDFGraphDrawing::GraphNode > ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::GetGraph ( std::unordered_map< void *, std::shared_ptr< RDFGraphDrawing::GraphNode > > &  visitedMap)
inlinefinalvirtual

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

Definition at line 167 of file RFilter.hxx.

◆ GetVariedFilter()

template<typename FilterF , typename PrevNodeRaw >
std::shared_ptr< RNodeBase > ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::GetVariedFilter ( const std::string &  variationName)
inlinefinalvirtual

Return a clone of this Filter that works with values in the variationName "universe".

Reimplemented from ROOT::Detail::RDF::RNodeBase.

Definition at line 192 of file RFilter.hxx.

◆ IncrChildrenCount()

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

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

Definition at line 142 of file RFilter.hxx.

◆ InitSlot()

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

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

Definition at line 119 of file RFilter.hxx.

◆ operator=()

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

◆ PartialReport()

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

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

Definition at line 129 of file RFilter.hxx.

◆ Report()

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

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

Definition at line 127 of file RFilter.hxx.

◆ StopProcessing()

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

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

Definition at line 135 of file RFilter.hxx.

◆ TriggerChildrenCount()

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

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

Definition at line 150 of file RFilter.hxx.

Member Data Documentation

◆ fFilter

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

Definition at line 66 of file RFilter.hxx.

◆ fPrevNode

template<typename FilterF , typename PrevNodeRaw >
PrevNode_t& ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::fPrevNode
private

Definition at line 70 of file RFilter.hxx.

◆ fPrevNodePtr

template<typename FilterF , typename PrevNodeRaw >
const std::shared_ptr<PrevNode_t> ROOT::Detail::RDF::RFilter< FilterF, PrevNodeRaw >::fPrevNodePtr
private

Definition at line 69 of file RFilter.hxx.

◆ fValues

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

Column readers per slot and per input column.

Definition at line 68 of file RFilter.hxx.


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