template<typename Helper, typename PrevNode>
class ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >

Definition at line 37 of file RActionSnapshot.hxx.

Public Member Functions
	RActionSnapshot (const RActionSnapshot &)=delete

	RActionSnapshot (Helper &&h, const std::vector< std::string > &columns, const std::vector< const std::type_info * > &colTypeIDs, std::shared_ptr< PrevNode > pd, const RColumnRegister &colRegister)

	RActionSnapshot (RActionSnapshot &&)=delete

	~RActionSnapshot () final

void	CallExec (unsigned int slot, Long64_t entry)

std::unique_ptr< RActionBase >	CloneAction (void *newResult) final
	Returns a new action with a cloned helper.

void	Finalize () final
	Clean-up and finalize the action result (e.g.

void	FinalizeSlot (unsigned int slot) final
	Clean-up operations to be performed at the end of a task.

RColumnRegister &	GetColRegister ()

const ColumnNames_t &	GetColumnNames () const

std::shared_ptr< GraphDrawing::GraphNode >	GetGraph (std::unordered_map< void *, std::shared_ptr< GraphDrawing::GraphNode > > &visitedMap) final

RLoopManager *	GetLoopManager ()

std::unique_ptr< ROOT::Detail::RDF::RMergeableValueBase >	GetMergeableValue () const final
	Retrieve a wrapper to the result of the action that knows how to merge with others of the same type.

unsigned int	GetNSlots () const

void *	GetValue (unsigned int slot, std::size_t readerIdx, Long64_t entry)

const std::vector< std::string > &	GetVariations () const

virtual bool	HasRun () const

void	Initialize () final

void	InitSlot (TTreeReader *r, unsigned int slot) final

std::unique_ptr< RActionBase >	MakeVariedAction (std::vector< void * > &&) final
	Will throw, since varied actions are unsupported. Instead, set a flag in RSnapshotOptions.

RActionSnapshot &	operator= (const RActionSnapshot &)=delete

RActionSnapshot &	operator= (RActionSnapshot &&)=delete

void *	PartialUpdate (unsigned int slot) final
	Forwards to the action helpers; will throw since PartialUpdate not supported for most snapshot helpers.

void	Run (unsigned int slot, Long64_t entry) final

virtual void	SetHasRun ()

void	TriggerChildrenCount () final

Protected Attributes
const ColumnNames_t	fColumnNames

RLoopManager *	fLoopManager
	A raw pointer to the RLoopManager at the root of this functional graph.

Private Types
using	PrevNodeCommon_t

Private Member Functions
void	AppendVariedPrevNodes ()

ROOT::RDF::SampleCallback_t	GetSampleCallback () final

Private Attributes
RColumnRegister	fColRegister

std::vector< const std::type_info * >	fColTypeIDs
	Types of the columns to Snapshot.

bool	fHasRun = false

Helper	fHelper

std::vector< bool >	fIsDefine
	The nth flag signals whether the nth input column is a custom column or not.

const unsigned int	fNSlots
	Number of thread slots used by this node.

std::vector< std::shared_ptr< PrevNodeCommon_t > >	fPrevNodes
	Previous nodes in the computation graph. First element is nominal, others are varied.

std::vector< std::vector< RColumnReaderBase * > >	fValues
	Column readers per slot and per input column.

std::vector< std::string >	fVariations
	List of systematic variations that affect the result of this action ("nominal" excluded).

#include <ROOT/RDF/RActionSnapshot.hxx>

Inheritance diagram for ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >:

Member Typedef Documentation

◆ PrevNodeCommon_t

template<typename Helper , typename PrevNode >

using ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::PrevNodeCommon_t

private

Initial value:

std::conditional_t<std::is_same_v<PrevNode, ROOT::Detail::RDF::RJittedFilter>,

ROOT::Detail::RDF::RFilterBase, PrevNode>

ROOT::Detail::RDF::RFilterBase

Definition RFilterBase.hxx:38

ROOT::Detail::TRangeCast

Definition TCollection.h:313

Definition at line 44 of file RActionSnapshot.hxx.

Constructor & Destructor Documentation

◆ RActionSnapshot() [1/3]

template<typename Helper , typename PrevNode >

ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::RActionSnapshot	(	Helper &&	h,
		const std::vector< std::string > &	columns,
		const std::vector< const std::type_info * > &	colTypeIDs,
		std::shared_ptr< PrevNode >	pd,
		const RColumnRegister &	colRegister )

inline

Definition at line 88 of file RActionSnapshot.hxx.

◆ RActionSnapshot() [2/3]

template<typename Helper , typename PrevNode >

ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::RActionSnapshot ( const RActionSnapshot< Helper, PrevNode > & )

delete

◆ RActionSnapshot() [3/3]

template<typename Helper , typename PrevNode >

ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::RActionSnapshot ( RActionSnapshot< Helper, PrevNode > && )

delete

◆ ~RActionSnapshot()

template<typename Helper , typename PrevNode >

ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::~RActionSnapshot ( )

inlinefinal

Definition at line 126 of file RActionSnapshot.hxx.

Member Function Documentation

◆ AppendVariedPrevNodes()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::AppendVariedPrevNodes ( )

inlineprivate

Definition at line 60 of file RActionSnapshot.hxx.

◆ CallExec()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::CallExec	(	unsigned int	slot,
		Long64_t	entry )

inline

Definition at line 183 of file RActionSnapshot.hxx.

◆ CloneAction()

template<typename Helper , typename PrevNode >

std::unique_ptr< RActionBase > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::CloneAction ( void * newResult )

inlinefinalvirtual

Returns a new action with a cloned helper.

Parameters

[in] newResult The result to be filled by the new action (needed to clone the helper).

Returns: A unique pointer to the new action.

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 277 of file RActionSnapshot.hxx.

◆ Finalize()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::Finalize ( )

inlinefinalvirtual

Clean-up and finalize the action result (e.g.

merging slot-local results). It invokes the helper's Finalize method.

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 236 of file RActionSnapshot.hxx.

◆ FinalizeSlot()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::FinalizeSlot ( unsigned int slot )

inlinefinalvirtual

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

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 228 of file RActionSnapshot.hxx.

◆ GetColRegister()

RColumnRegister & ROOT::Internal::RDF::RActionBase::GetColRegister ( )

inlineinherited

Definition at line 63 of file RActionBase.hxx.

◆ GetColumnNames()

const ColumnNames_t & ROOT::Internal::RDF::RActionBase::GetColumnNames ( ) const

inlineinherited

Definition at line 62 of file RActionBase.hxx.

◆ GetGraph()

template<typename Helper , typename PrevNode >

std::shared_ptr< GraphDrawing::GraphNode > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::GetGraph ( std::unordered_map< void *, std::shared_ptr< GraphDrawing::GraphNode > > & visitedMap )

inlinefinalvirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 243 of file RActionSnapshot.hxx.

◆ GetLoopManager()

RLoopManager * ROOT::Internal::RDF::RActionBase::GetLoopManager ( )

inlineinherited

Definition at line 64 of file RActionBase.hxx.

◆ GetMergeableValue()

template<typename Helper , typename PrevNode >

std::unique_ptr< ROOT::Detail::RDF::RMergeableValueBase > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::GetMergeableValue ( ) const

inlinefinalvirtual

Retrieve a wrapper to the result of the action that knows how to merge with others of the same type.

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 132 of file RActionSnapshot.hxx.

◆ GetNSlots()

unsigned int ROOT::Internal::RDF::RActionBase::GetNSlots ( ) const

inlineinherited

Definition at line 65 of file RActionBase.hxx.

◆ GetSampleCallback()

template<typename Helper , typename PrevNode >

ROOT::RDF::SampleCallback_t ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::GetSampleCallback ( )

inlinefinalprivatevirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 58 of file RActionSnapshot.hxx.

◆ GetValue()

template<typename Helper , typename PrevNode >

void * ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::GetValue	(	unsigned int	slot,
		std::size_t	readerIdx,
		Long64_t	entry )

inline

Definition at line 169 of file RActionSnapshot.hxx.

◆ GetVariations()

const std::vector< std::string > & ROOT::Internal::RDF::RActionBase::GetVariations ( ) const

inlineinherited

Definition at line 91 of file RActionBase.hxx.

◆ HasRun()

virtual bool ROOT::Internal::RDF::RActionBase::HasRun ( ) const

inlinevirtualinherited

Reimplemented in ROOT::Internal::RDF::RJittedAction.

Definition at line 77 of file RActionBase.hxx.

◆ Initialize()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::Initialize ( )

inlinefinalvirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 137 of file RActionSnapshot.hxx.

◆ InitSlot()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::InitSlot	(	TTreeReader *	r,
		unsigned int	slot )

inlinefinalvirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 139 of file RActionSnapshot.hxx.

◆ MakeVariedAction()

template<typename Helper , typename PrevNode >

std::unique_ptr< RActionBase > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::MakeVariedAction ( std::vector< void * > && )

inlinefinalvirtual

Will throw, since varied actions are unsupported. Instead, set a flag in RSnapshotOptions.

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 265 of file RActionSnapshot.hxx.

◆ operator=() [1/2]

template<typename Helper , typename PrevNode >

RActionSnapshot & ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::operator= ( const RActionSnapshot< Helper, PrevNode > & )

delete

◆ operator=() [2/2]

template<typename Helper , typename PrevNode >

RActionSnapshot & ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::operator= ( RActionSnapshot< Helper, PrevNode > && )

delete

◆ PartialUpdate()

template<typename Helper , typename PrevNode >

void * ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::PartialUpdate ( unsigned int slot )

inlinefinalvirtual

Forwards to the action helpers; will throw since PartialUpdate not supported for most snapshot helpers.

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 262 of file RActionSnapshot.hxx.

◆ Run()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::Run	(	unsigned int	slot,
		Long64_t	entry )

inlinefinalvirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 194 of file RActionSnapshot.hxx.

◆ SetHasRun()

virtual void ROOT::Internal::RDF::RActionBase::SetHasRun ( )

inlinevirtualinherited

Reimplemented in ROOT::Internal::RDF::RJittedAction.

Definition at line 78 of file RActionBase.hxx.

◆ TriggerChildrenCount()

template<typename Helper , typename PrevNode >

void ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::TriggerChildrenCount ( )

inlinefinalvirtual

Implements ROOT::Internal::RDF::RActionBase.

Definition at line 221 of file RActionSnapshot.hxx.

Member Data Documentation

◆ fColRegister

RColumnRegister ROOT::Internal::RDF::RActionBase::fColRegister

privateinherited

Definition at line 53 of file RActionBase.hxx.

◆ fColTypeIDs

template<typename Helper , typename PrevNode >

std::vector<const std::type_info *> ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::fColTypeIDs

private

Types of the columns to Snapshot.

Definition at line 56 of file RActionSnapshot.hxx.

◆ fColumnNames

const ColumnNames_t ROOT::Internal::RDF::RActionBase::fColumnNames

protectedinherited

Definition at line 45 of file RActionBase.hxx.

◆ fHasRun

bool ROOT::Internal::RDF::RActionBase::fHasRun = false

privateinherited

Definition at line 49 of file RActionBase.hxx.

◆ fHelper

template<typename Helper , typename PrevNode >

Helper ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::fHelper

private

Definition at line 40 of file RActionSnapshot.hxx.

◆ fIsDefine

template<typename Helper , typename PrevNode >

std::vector<bool> ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::fIsDefine

private

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

Definition at line 53 of file RActionSnapshot.hxx.

◆ fLoopManager

RLoopManager* ROOT::Internal::RDF::RActionBase::fLoopManager

protectedinherited

A raw pointer to the RLoopManager at the root of this functional graph.

Never null: children nodes have shared ownership of parent nodes in the graph.

Definition at line 44 of file RActionBase.hxx.

◆ fNSlots

const unsigned int ROOT::Internal::RDF::RActionBase::fNSlots

privateinherited

Number of thread slots used by this node.

Definition at line 48 of file RActionBase.hxx.

◆ fPrevNodes

template<typename Helper , typename PrevNode >

std::vector<std::shared_ptr<PrevNodeCommon_t> > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::fPrevNodes

private

Previous nodes in the computation graph. First element is nominal, others are varied.

Definition at line 47 of file RActionSnapshot.hxx.

◆ fValues

template<typename Helper , typename PrevNode >

std::vector<std::vector<RColumnReaderBase *> > ROOT::Internal::RDF::RActionSnapshot< Helper, PrevNode >::fValues

private

Column readers per slot and per input column.

Definition at line 50 of file RActionSnapshot.hxx.

◆ fVariations

std::vector<std::string> ROOT::Internal::RDF::RActionBase::fVariations

privateinherited

List of systematic variations that affect the result of this action ("nominal" excluded).

Definition at line 51 of file RActionBase.hxx.

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

tree/dataframe/inc/ROOT/RDF/RActionSnapshot.hxx

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ PrevNodeCommon_t

Constructor & Destructor Documentation

◆ RActionSnapshot() [1/3]

◆ RActionSnapshot() [2/3]

◆ RActionSnapshot() [3/3]

◆ ~RActionSnapshot()

Member Function Documentation

◆ AppendVariedPrevNodes()

◆ CallExec()

◆ CloneAction()

◆ Finalize()

◆ FinalizeSlot()

◆ GetColRegister()

◆ GetColumnNames()

◆ GetGraph()

◆ GetLoopManager()

◆ GetMergeableValue()

◆ GetNSlots()

◆ GetSampleCallback()

◆ GetValue()

◆ GetVariations()

◆ HasRun()

◆ Initialize()

◆ InitSlot()

◆ MakeVariedAction()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PartialUpdate()

◆ Run()

◆ SetHasRun()

◆ TriggerChildrenCount()

Member Data Documentation

◆ fColRegister

◆ fColTypeIDs

◆ fColumnNames

◆ fHasRun

◆ fHelper

◆ fIsDefine

◆ fLoopManager

◆ fNSlots

◆ fPrevNodes

◆ fValues

◆ fVariations