Skip to content
Snippets Groups Projects
Commit b1c78245 authored by Xavier Valls Pla's avatar Xavier Valls Pla
Browse files

Fix TTreeProcessors docs :books:

parent e29a32cf
No related branches found
No related tags found
No related merge requests found
......@@ -16,11 +16,11 @@
//////////////////////////////////////////////////////////////////////////
///
/// \class TTreeProcessorMP
/// \class ROOT::TTreeProcessorMP
/// \brief This class provides an interface to process a TTree dataset
/// in parallel with multi-process technology
///
/// ###TTreeProcessorMP::Process
/// ###ROOT::TTreeProcessorMP::Process
/// The possible usages of the Process method are the following:\n
/// * Process(<dataset>, F func, const std::string& treeName, ULong64_t nToProcess):
/// func is executed nToProcess times with argument a TTreeReader&, initialized for
......@@ -42,9 +42,9 @@
/// or set via SetNWorkers. It defaults to the number of cores.\n
/// A collection containing the result of each execution is returned.\n
/// **Note:** the user is responsible for the deletion of any object that might
/// be created upon execution of func, returned objects included: TTreeProcessorMP never
/// be created upon execution of func, returned objects included: ROOT::TTreeProcessorMP never
/// deletes what it returns, it simply forgets it.\n
/// **Note:** that the usage of TTreeProcessorMP::Process is indicated only when the task to be
/// **Note:** that the usage of ROOT::TTreeProcessorMP::Process is indicated only when the task to be
/// executed takes more than a few seconds, otherwise the overhead introduced
/// by Process will outrun the benefits of parallel execution on most machines.
///
......@@ -59,7 +59,7 @@
/// a standard container (vector, list, deque), an initializer list
/// or a pointer to a TCollection (TList*, TObjArray*, ...).
/// \endparblock
/// **Note:** the version of TTreeProcessorMP::Process that takes a TFileCollection* as argument incurs
/// **Note:** the version of ROOT::TTreeProcessorMP::Process that takes a TFileCollection* as argument incurs
/// in the overhead of copying data from the TCollection to an STL container. Only
/// use it when absolutely necessary.\n
/// **Note:** in cases where the function to be executed takes more than
......
......@@ -9,15 +9,15 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
/** \class TTreeProcessorMT
/** \class ROOT::TTreeProcessorMT
\brief A class to process the entries of a TTree in parallel.
By means of its Process method, TTreeProcessorMT provides a way to process the
By means of its Process method, ROOT::TTreeProcessorMT provides a way to process the
entries of a TTree in parallel. When invoking TTreeProcessor::Process, the user
passes a function whose only parameter is a TTreeReader. The function iterates
on a subrange of entries by using that TTreeReader.
The implementation of TTreeProcessorMT parallelizes the processing of the subranges,
The implementation of ROOT::TTreeProcessorMT parallelizes the processing of the subranges,
each corresponding to a cluster in the TTree. This is possible thanks to the use
of a ROOT::TThreadedObject, so that each thread works with its own TFile and TTree
objects.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment