@@ -37,21 +37,56 @@ public:
3737\brief Common user-tunable settings for reading ntuples
3838
3939All page source classes need to support the common options.
40+
41+ <table>
42+ <tr>
43+ <th>Option name</th>
44+ <th>Type</th>
45+ <th>Default</th>
46+ <th>Description</th>
47+ </tr>
48+
49+ <tr>
50+ <td>`ClusterCache`</td>
51+ <td>EClusterCache</td>
52+ <td>EClusterCache::kDefault</td>
53+ <td>
54+ Controls if the prefetcher (including the prefetcher thread) is used
55+ </td>
56+ </tr>
57+
58+ <tr>
59+ <td>`UseImplicitMT`</td>
60+ <td>EImplicitMT</td>
61+ <td>EImplicitMT::kDefault</td>
62+ <td>
63+ Allows to disable parallel page compression and decompression even if ROOT uses implicit MT.
64+ This is useful, e.g., in the context of RDataFrame where the threads are fully managed by RDataFrame.
65+ </td>
66+ </tr>
67+
68+ <tr>
69+ <td>`EnableMetrics`</td>
70+ <td>`bool`</td>
71+ <td>`false`</td>
72+ <td>
73+ If `true`, the RNTupleReader will track metrics straight from its construction, as
74+ if calling RNTupleReader::EnableMetrics() before having created the object.
75+ </td>
76+ </tr>
77+ </table>
4078*/
4179// clang-format on
4280class RNTupleReadOptions {
4381 friend class Internal ::RNTupleReadOptionsManip;
4482
4583public:
46- // / Controls if the prefetcher (including the prefetcher thread) is used
4784 enum class EClusterCache {
4885 kOff ,
4986 kOn ,
5087 kDefault = kOn ,
5188 };
5289
53- // / Allows to disable parallel page compression and decompression even if ROOT uses implicit MT.
54- // / This is useful, e.g., in the context of RDataFrame where the threads are fully managed by RDataFrame.
5590 enum class EImplicitMT {
5691 kOff ,
5792 kDefault ,
@@ -63,8 +98,6 @@ private:
6398 // / by an option that allows to control the amount of memory that the prefetcher uses.
6499 unsigned int fClusterBunchSize = 1 ;
65100 EImplicitMT fUseImplicitMT = EImplicitMT::kDefault ;
66- // / If true, the RNTupleReader will track metrics straight from its construction, as
67- // / if calling `RNTupleReader::EnableMetrics()` before having created the object.
68101 bool fEnableMetrics = false ;
69102
70103public:
0 commit comments