Skip to content

Commit

Permalink
[NFC][ntuple] add comments to read options
Browse files Browse the repository at this point in the history
  • Loading branch information
jblomer committed Jan 30, 2025
1 parent 98150c8 commit bba0f50
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion tree/ntuple/v7/inc/ROOT/RNTupleReadOptions.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,24 @@ class RNTupleReadOptions {
friend class Internal::RNTupleReadOptionsManip;

public:
/// Controls if the prefetcher (including the prefetcher thread) is used
enum class EClusterCache {
kOff,
kOn,
kDefault = kOn,
};

/// Allows to disable parallel page compression and decompression even if ROOT uses implicit MT.
/// This is useful, e.g., in the context of RDataFrame where the threads are fully managed by RDataFrame.
enum class EImplicitMT {
kOff,
kDefault,
};

private:
EClusterCache fClusterCache = EClusterCache::kDefault;
/// The number of cluster to be prefetched in a single batch; this option is transitional and will be replaced
/// by an option that allows to control the amount of memory that the prefetcher uses.
unsigned int fClusterBunchSize = 1;
EImplicitMT fUseImplicitMT = EImplicitMT::kDefault;
/// If true, the RNTupleReader will track metrics straight from its construction, as
Expand All @@ -71,7 +77,7 @@ public:

bool HasMetricsEnabled() const { return fEnableMetrics; }
void SetMetricsEnabled(bool enable) { fEnableMetrics = enable; }
};
}; // class RNTupleReadOptions

namespace Internal {

Expand Down

0 comments on commit bba0f50

Please sign in to comment.