template<typename T>
class ROOT::RDF::RResultPtr< T >
Smart pointer for the return type of actions.
A wrapper around the result of RDataFrame actions able to trigger calculations lazily.
- Template Parameters
-
| T | Type of the action result |
A smart pointer which allows to access the result of a RDataFrame action. The methods of the encapsulated object can be accessed via the arrow operator. Upon invocation of the arrow operator or dereferencing (operator*), the loop on the events and calculations of all scheduled actions are executed if needed. It is possible to iterate on the result proxy if the proxied object is a collection.
for (auto& myItem : myResultProxy) { ... };
If iteration is not supported by the type of the proxied object, a compilation error is thrown.
Definition at line 103 of file RResultPtr.hxx.
|
| template<typename T1 > |
| class | RResultPtr |
| |
| template<class T1 , class T2 > |
| bool | operator!= (const RResultPtr< T1 > &lhs, const RResultPtr< T2 > &rhs) |
| |
| template<class T1 > |
| bool | operator!= (const RResultPtr< T1 > &lhs, std::nullptr_t rhs) |
| |
| template<class T1 > |
| bool | operator!= (std::nullptr_t lhs, const RResultPtr< T1 > &rhs) |
| |
| template<class T1 , class T2 > |
| bool | operator== (const RResultPtr< T1 > &lhs, const RResultPtr< T2 > &rhs) |
| |
| template<class T1 > |
| bool | operator== (const RResultPtr< T1 > &lhs, std::nullptr_t rhs) |
| |
| template<class T1 > |
| bool | operator== (std::nullptr_t lhs, const RResultPtr< T1 > &rhs) |
| |
| std::unique_ptr< RDFDetail::RMergeableValue< T > > | RDFDetail::GetMergeableValue (RResultPtr< T > &rptr) |
| |
| template<typename T1 > |
| RResultPtr< T1 > | RDFDetail::MakeResultPtr (const std::shared_ptr< T1 > &, ::ROOT::Detail::RDF::RLoopManager &, std::shared_ptr< RDFInternal::RActionBase >) |
| |
| class | ROOT::Internal::RDF::GraphDrawing::GraphCreatorHelper |
| |
| template<typename T1 > |
| ROOT::RDF::Experimental::RResultMap< T1 > | ROOT::RDF::Experimental::VariationsFor (RResultPtr< T1 > resPtr) |
| |
| class | RResultHandle |
| |
Register a callback that RDataFrame will execute "everyNEvents" on a partial result.
- Parameters
-
| [in] | everyNEvents | Frequency at which the callback will be called, as a number of events processed |
| [in] | callback | a callable with signature void(Value_t&) where Value_t is the type of the value contained in this RResultPtr |
- Returns
- this RResultPtr, to allow chaining of OnPartialResultSlot with other calls
The callback must be a callable (lambda, function, functor class...) that takes a reference to the result type as argument and returns nothing. RDataFrame will invoke registered callbacks passing partial action results as arguments to them (e.g. a histogram filled with a part of the selected events, a counter incremented only up to a certain point, a mean over a subset of the events and so forth).
Callbacks can be used e.g. to inspect partial results of the analysis while the event loop is running. For example one can draw an up-to-date version of a result histogram every 100 entries like this:
auto h = tdf.Histo1D(
"x");
h.OnPartialResult(100, [&
c](
TH1D &h_) {
c.cd(); h_.
Draw();
c.Update(); });
1-D histogram with a double per channel (see TH1 documentation)}
virtual void Draw(Option_t *option="")
Draw this histogram with options.
A value of 0 for everyNEvents indicates the callback must be executed only once, before running the event loop. A conveniece definition kOnce is provided to make this fact more expressive in user code (see snippet below). Multiple callbacks can be registered with the same RResultPtr (i.e. results of RDataFrame actions) and will be executed sequentially. Callbacks are executed in the order they were registered. The type of the value contained in a RResultPtr is also available as RResultPtr<T>::Value_t, e.g.
auto h = tdf.Histo1D(
"x");
When implicit multi-threading is enabled, the callback:
- will never be executed by multiple threads concurrently: it needs not be thread-safe. For example the snippet above that draws the partial histogram on a canvas works seamlessly in multi-thread event loops.
- will always be executed "everyNEvents": partial results will "contain" that number of events more from one call to the next
- might be executed by a different worker thread at different times: the value of
std::this_thread::get_id() might change between calls
To register a callback that is called by each worker thread (concurrently) every N events one can use OnPartialResultSlot().
Definition at line 304 of file RResultPtr.hxx.
Register a callback that RDataFrame will execute in each worker thread concurrently on that thread's partial result.
- Parameters
-
| [in] | everyNEvents | Frequency at which the callback will be called by each thread, as a number of events processed |
| [in] | callback | A callable with signature void(unsigned int, Value_t&) where Value_t is the type of the value contained in this RResultPtr |
- Returns
- this RResultPtr, to allow chaining of OnPartialResultSlot with other calls
See OnPartialResult for a generic explanation of the callback mechanism. Compared to OnPartialResult, this method has two major differences:
- all worker threads invoke the callback once every specified number of events. The event count is per-thread, and callback invocation might happen concurrently (i.e. the callback must be thread-safe)
- the callable must take an extra
unsigned int parameter corresponding to a multi-thread "processing slot": this is a "helper value" to simplify writing thread-safe callbacks: different worker threads might invoke the callback concurrently but always with different slot numbers.
- a value of 0 for everyNEvents indicates the callback must be executed once per slot.
For example, the following snippet prints out a thread-safe progress bar of the events processed by RDataFrame
std::string progress;
std::mutex bar_mutex;
c.OnPartialResultSlot(nEvents / 100, [&progress, &bar_mutex](
unsigned int,
ULong64_t &) {
std::lock_guard<std::mutex> lg(bar_mutex);
progress.push_back('#');
std::cout << "\r[" << std::left << std::setw(100) << progress << ']' << std::flush;
});
std::cout << "Analysis running..." << std::endl;
std::cout << "\nDone!" << std::endl;
unsigned long long ULong64_t
Definition at line 350 of file RResultPtr.hxx.
