[ntuple] Move RNTupleParallelWriter out of Experimental

Author: hahnjo

README/ReleaseNotes/v638/index.md

@@ -56,6 +56,10 @@ The following people have contributed to this new version:
 
 * Behaviour change: the behaviour of `TChain::SetBranchStatus` has been aligned to the one of `TTree::SetBranchStatus`. In particular, when `SetBranchStatus` is called to deactivate all branches, a subsequent call to `TChain::SetBranchAddress` would override the previous instruction and activate that single branch. Instead `TTree::SetBranchAddress` respects the rule imposed by `SetBranchStatus`. If a user needs to activate only one or more branches, they should call `SetBranchStatus("brName", true)` on each branch that needs to be active in the TChain, like it was already necessary for a TTree. See https://github.com/root-project/root/pull/19221 for more details.
 
+### RNTuple
+
+* The parallel writer is now part of the public, stable API. The `RNTupleParallelWriter` and the closely related `RNTupleFillContext` moved from the `ROOT::Experimental` to the `ROOT` namespace.
+
 ## Math
 
 ### Minuit2

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

@@ -30,12 +30,10 @@ class TBranch;
 class TFile;
 
 namespace ROOT {
-namespace Experimental {
-class RNTupleFillContext;
-class RNTupleParallelWriter;
-} // namespace Experimental
 class REntry;
 class RFieldToken;
+class RNTupleFillContext;
+class RNTupleParallelWriter;
 class TBufferMerger;
 class TBufferMergerFile;
 } // namespace ROOT
@@ -54,11 +52,11 @@ class R__CLING_PTRCHECK(off) UntypedSnapshotRNTupleHelper final : public RAction
    ROOT::Detail::RDF::RLoopManager *fOutputLoopManager;
    ColumnNames_t fInputFieldNames; // This contains the resolved aliases
    ColumnNames_t fOutputFieldNames;
-   std::unique_ptr<ROOT::Experimental::RNTupleParallelWriter> fWriter;
+   std::unique_ptr<ROOT::RNTupleParallelWriter> fWriter;
    std::vector<ROOT::RFieldToken> fFieldTokens;
 
    unsigned int fNSlots;
-   std::vector<std::shared_ptr<ROOT::Experimental::RNTupleFillContext>> fFillContexts;
+   std::vector<std::shared_ptr<ROOT::RNTupleFillContext>> fFillContexts;
    std::vector<std::unique_ptr<ROOT::REntry>> fEntries;
 
    std::vector<const std::type_info *> fInputColumnTypeIDs; // Types for the input columns

tree/dataframe/src/RDFSnapshotHelpers.cxx

@@ -871,7 +871,7 @@ void ROOT::Internal::RDF::UntypedSnapshotRNTupleHelper::Initialize()
 
    // The RNTupleParallelWriter has exclusive access to the underlying TFile, no further synchronization is needed for
    // calls to Fill() (in Exec) and FlushCluster() (in FinalizeTask).
-   fWriter = ROOT::Experimental::RNTupleParallelWriter::Append(std::move(model), fNTupleName, *outputDir, writeOptions);
+   fWriter = ROOT::RNTupleParallelWriter::Append(std::move(model), fNTupleName, *outputDir, writeOptions);
 }
 
 void ROOT::Internal::RDF::UntypedSnapshotRNTupleHelper::InitTask(TTreeReader *, unsigned int slot)

tree/ntuple/inc/ROOT/REntry.hxx

@@ -31,10 +31,10 @@
 
 namespace ROOT {
 
+class RNTupleFillContext;
 class RNTupleReader;
 
 namespace Experimental {
-class RNTupleFillContext;
 class RNTupleProcessor;
 class RNTupleSingleProcessor;
 class RNTupleChainProcessor;
@@ -52,9 +52,9 @@ with values are managed through shared pointers.
 */
 // clang-format on
 class REntry {
+   friend class RNTupleFillContext;
    friend class RNTupleModel;
    friend class RNTupleReader;
-   friend class Experimental::RNTupleFillContext;
    friend class Experimental::RNTupleProcessor;
    friend class Experimental::RNTupleSingleProcessor;
    friend class Experimental::RNTupleChainProcessor;

tree/ntuple/inc/ROOT/RNTupleFillContext.hxx

@@ -2,8 +2,6 @@
 /// \ingroup NTuple
 /// \author Jakob Blomer <[email protected]>
 /// \date 2024-02-22
-/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
-/// is welcome!
 
 /*************************************************************************
  * Copyright (C) 1995-2024, Rene Brun and Fons Rademakers.               *
@@ -32,11 +30,10 @@
 #include <vector>
 
 namespace ROOT {
-namespace Experimental {
 
 // clang-format off
 /**
-\class ROOT::Experimental::RNTupleFillContext
+\class ROOT::RNTupleFillContext
 \ingroup NTuple
 \brief A context for filling entries (data) into clusters of an RNTuple
 
@@ -61,7 +58,7 @@ private:
    /// Needs to be destructed before fSink
    std::unique_ptr<ROOT::RNTupleModel> fModel;
 
-   Detail::RNTupleMetrics fMetrics;
+   Experimental::Detail::RNTupleMetrics fMetrics;
 
    ROOT::NTupleSize_t fLastFlushed = 0;
    ROOT::NTupleSize_t fNEntries = 0;
@@ -132,14 +129,14 @@ public:
    ///
    /// This method will check the entry's model ID to ensure it comes from the context's own model or throw an exception
    /// otherwise.
-   void FillNoFlush(Detail::RRawPtrWriteEntry &entry, ROOT::RNTupleFillStatus &status)
+   void FillNoFlush(Experimental::Detail::RRawPtrWriteEntry &entry, ROOT::RNTupleFillStatus &status)
    {
       FillNoFlushImpl(entry, status);
    }
    /// Fill an RRawPtrWriteEntry into this context.  This method will check the entry's model ID to ensure it comes
    /// from the context's own model or throw an exception otherwise.
    /// \return The number of uncompressed bytes written.
-   std::size_t Fill(Detail::RRawPtrWriteEntry &entry) { return FillImpl(entry); }
+   std::size_t Fill(Experimental::Detail::RRawPtrWriteEntry &entry) { return FillImpl(entry); }
 
    /// Flush column data, preparing for CommitCluster or to reduce memory usage. This will trigger compression of pages,
    /// but not actually write to storage.
@@ -151,7 +148,7 @@ public:
 
    const ROOT::RNTupleModel &GetModel() const { return *fModel; }
    std::unique_ptr<ROOT::REntry> CreateEntry() const { return fModel->CreateEntry(); }
-   std::unique_ptr<Detail::RRawPtrWriteEntry> CreateRawPtrWriteEntry() const
+   std::unique_ptr<Experimental::Detail::RRawPtrWriteEntry> CreateRawPtrWriteEntry() const
    {
       return fModel->CreateRawPtrWriteEntry();
    }
@@ -171,10 +168,9 @@ public:
    bool IsStagedClusterCommittingEnabled() const { return fStagedClusterCommitting; }
 
    void EnableMetrics() { fMetrics.Enable(); }
-   const Detail::RNTupleMetrics &GetMetrics() const { return fMetrics; }
+   const Experimental::Detail::RNTupleMetrics &GetMetrics() const { return fMetrics; }
 };
 
-} // namespace Experimental
 } // namespace ROOT
 
 #endif // ROOT_RNTupleFillContext

tree/ntuple/inc/ROOT/RNTupleFillStatus.hxx

@@ -20,9 +20,7 @@
 
 namespace ROOT {
 
-namespace Experimental {
 class RNTupleFillContext;
-}
 
 // clang-format off
 /**
@@ -35,7 +33,7 @@ ShouldFlushCluster() and call RNTupleWriter::FlushCluster() or RNTupleFillContex
 */
 // clang-format on
 class RNTupleFillStatus {
-   friend class Experimental::RNTupleFillContext;
+   friend class RNTupleFillContext;
 
 private:
    /// Number of entries written into the current cluster

tree/ntuple/inc/ROOT/RNTupleParallelWriter.hxx

@@ -2,8 +2,6 @@
 /// \ingroup NTuple
 /// \author Jonas Hahnfeld <[email protected]>
 /// \date 2024-02-01
-/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
-/// is welcome!
 
 /*************************************************************************
  * Copyright (C) 1995-2024, Rene Brun and Fons Rademakers.               *
@@ -34,12 +32,10 @@ namespace Internal {
 class RPageSink;
 } // namespace Internal
 
-namespace Experimental {
-
 class RNTupleFillContext;
 
 /**
-\class ROOT::Experimental::RNTupleParallelWriter
+\class ROOT::RNTupleParallelWriter
 \ingroup NTuple
 \brief A writer to fill an RNTuple from multiple contexts
 
@@ -72,7 +68,7 @@ private:
    std::unique_ptr<ROOT::Internal::RPageSink> fSink;
    /// The original RNTupleModel connected to fSink; needs to be destructed before it.
    std::unique_ptr<ROOT::RNTupleModel> fModel;
-   Detail::RNTupleMetrics fMetrics;
+   Experimental::Detail::RNTupleMetrics fMetrics;
    /// List of all created helpers. They must be destroyed before this RNTupleParallelWriter is destructed.
    std::vector<std::weak_ptr<RNTupleFillContext>> fFillContexts;
 
@@ -109,10 +105,9 @@ public:
    void CommitDataset();
 
    void EnableMetrics() { fMetrics.Enable(); }
-   const Detail::RNTupleMetrics &GetMetrics() const { return fMetrics; }
+   const Experimental::Detail::RNTupleMetrics &GetMetrics() const { return fMetrics; }
 };
 
-} // namespace Experimental
 } // namespace ROOT
 
 #endif

tree/ntuple/inc/ROOT/RNTupleWriter.hxx

@@ -104,7 +104,7 @@ class RNTupleWriter {
       Internal::CreateRNTupleWriter(std::unique_ptr<ROOT::RNTupleModel>, std::unique_ptr<Internal::RPageSink>);
 
 private:
-   Experimental::RNTupleFillContext fFillContext;
+   RNTupleFillContext fFillContext;
    Experimental::Detail::RNTupleMetrics fMetrics;
 
    ROOT::NTupleSize_t fLastCommittedClusterGroup = 0;

tree/ntuple/inc/ROOT/RRawPtrWriteEntry.hxx

@@ -28,10 +28,9 @@ namespace ROOT {
 
 class RNTupleModel;
 
-namespace Experimental {
-
 class RNTupleFillContext;
 
+namespace Experimental {
 namespace Detail {
 
 // clang-format off
@@ -46,7 +45,7 @@ provided by REntry, with safe interfaces, type checks, and shared object ownersh
 // clang-format on
 class RRawPtrWriteEntry {
    friend class ROOT::RNTupleModel;
-   friend class ROOT::Experimental::RNTupleFillContext;
+   friend class ROOT::RNTupleFillContext;
 
 private:
    /// The entry must be linked to a specific model, identified by a model ID

tree/ntuple/src/RNTupleFillContext.cxx

@@ -2,8 +2,6 @@
 /// \ingroup NTuple
 /// \author Jakob Blomer <[email protected]>
 /// \date 2024-02-22
-/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
-/// is welcome!
 
 /*************************************************************************
  * Copyright (C) 1995-2024, Rene Brun and Fons Rademakers.               *
@@ -27,8 +25,8 @@
 #include <algorithm>
 #include <utility>
 
-ROOT::Experimental::RNTupleFillContext::RNTupleFillContext(std::unique_ptr<ROOT::RNTupleModel> model,
-                                                           std::unique_ptr<ROOT::Internal::RPageSink> sink)
+ROOT::RNTupleFillContext::RNTupleFillContext(std::unique_ptr<ROOT::RNTupleModel> model,
+                                             std::unique_ptr<ROOT::Internal::RPageSink> sink)
    : fSink(std::move(sink)), fModel(std::move(model)), fMetrics("RNTupleFillContext")
 {
    fModel->Freeze();
@@ -42,7 +40,7 @@ ROOT::Experimental::RNTupleFillContext::RNTupleFillContext(std::unique_ptr<ROOT:
    fUnzippedClusterSizeEst = scale * writeOpts.GetApproxZippedClusterSize();
 }
 
-ROOT::Experimental::RNTupleFillContext::~RNTupleFillContext()
+ROOT::RNTupleFillContext::~RNTupleFillContext()
 {
    try {
       FlushCluster();
@@ -56,14 +54,14 @@ ROOT::Experimental::RNTupleFillContext::~RNTupleFillContext()
    }
 }
 
-void ROOT::Experimental::RNTupleFillContext::FlushColumns()
+void ROOT::RNTupleFillContext::FlushColumns()
 {
    for (auto &field : ROOT::Internal::GetFieldZeroOfModel(*fModel)) {
       ROOT::Internal::CallFlushColumnsOnField(field);
    }
 }
 
-void ROOT::Experimental::RNTupleFillContext::FlushCluster()
+void ROOT::RNTupleFillContext::FlushCluster()
 {
    if (fNEntries == fLastFlushed) {
       return;
@@ -91,7 +89,7 @@ void ROOT::Experimental::RNTupleFillContext::FlushCluster()
    fUnzippedClusterSize = 0;
 }
 
-void ROOT::Experimental::RNTupleFillContext::CommitStagedClusters()
+void ROOT::RNTupleFillContext::CommitStagedClusters()
 {
    if (fStagedClusters.empty()) {
       return;