JetCollection.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_JetCollection_H
#define EDM4EIC_JetCollection_H
 
// datamodel specific includes
#include "edm4eic/Jet.h"
#include "edm4eic/MutableJet.h"
#include "edm4eic/JetObj.h"
#include "edm4eic/JetCollectionData.h"
 
// podio specific includes
#include "podio/ICollectionProvider.h"
#include "podio/CollectionBase.h"
#include "podio/detail/Pythonizations.h"
#include "podio/utilities/TypeHelpers.h"
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
#include <string_view>
#include <vector>
#include <algorithm>
#include <ostream>
#include <mutex>
#include <memory>
#include <cstddef>
 
namespace podio {
  struct RelationNames;
}
 
namespace edm4eic {
 
 
 
class JetCollectionIterator {
public:
  using value_type = Jet;
  using difference_type = ptrdiff_t;
  using reference = Jet;
  using pointer = Jet*;
  using iterator_category = std::input_iterator_tag;
  // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
  // remain valid as long as the iterator is valid, not as long as the range is valid.
  using iterator_concept = std::random_access_iterator_tag;
 
  JetCollectionIterator(size_t index, const JetObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<JetObj>{nullptr}), m_collection(collection) {}
  JetCollectionIterator() = default;
 
  JetCollectionIterator(const JetCollectionIterator&) = default;
  JetCollectionIterator(JetCollectionIterator&&) = default;
  JetCollectionIterator& operator=(const JetCollectionIterator&) = default;
  JetCollectionIterator& operator=(JetCollectionIterator&&) = default;
  ~JetCollectionIterator() = default;
 
  constexpr auto operator<=>(const JetCollectionIterator& other) const {
    return m_index <=> other.m_index;
  }
 
  constexpr bool operator==(const JetCollectionIterator& x) const {
    return m_index ==  x.m_index;
  }
 
  reference operator*() const;
  pointer operator->();
  JetCollectionIterator& operator++();
  JetCollectionIterator operator++(int);
  JetCollectionIterator& operator--();
  JetCollectionIterator operator--(int);
  JetCollectionIterator& operator+=(difference_type n);
  JetCollectionIterator operator+(difference_type n) const;
  friend JetCollectionIterator operator+(difference_type n, const JetCollectionIterator& it);
  JetCollectionIterator& operator-=(difference_type n);
  JetCollectionIterator operator-(difference_type n) const;
  reference operator[](difference_type n) const;
  difference_type operator-(const JetCollectionIterator& other) const;
 
private:
  size_t m_index{0};
  Jet m_object { podio::utils::MaybeSharedPtr<JetObj>{nullptr} };
  const JetObjPointerContainer* m_collection{nullptr};
};
 
 
class JetMutableCollectionIterator {
public:
  using value_type = Jet;
  using difference_type = ptrdiff_t;
  using reference = MutableJet;
  using pointer = MutableJet*;
  using iterator_category = std::input_iterator_tag;
  // `std::forward_iterator` is supported except that the pointers obtained with `operator->()`
  // remain valid as long as the iterator is valid, not as long as the range is valid.
  using iterator_concept = std::random_access_iterator_tag;
 
  JetMutableCollectionIterator(size_t index, const JetObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<JetObj>{nullptr}), m_collection(collection) {}
  JetMutableCollectionIterator() = default;
 
  JetMutableCollectionIterator(const JetMutableCollectionIterator&) = default;
  JetMutableCollectionIterator(JetMutableCollectionIterator&&) = default;
  JetMutableCollectionIterator& operator=(const JetMutableCollectionIterator&) = default;
  JetMutableCollectionIterator& operator=(JetMutableCollectionIterator&&) = default;
  ~JetMutableCollectionIterator() = default;
 
  constexpr auto operator<=>(const JetMutableCollectionIterator& other) const {
    return m_index <=> other.m_index;
  }
 
  constexpr bool operator==(const JetMutableCollectionIterator& x) const {
    return m_index ==  x.m_index;
  }
 
  reference operator*() const;
  pointer operator->();
  JetMutableCollectionIterator& operator++();
  JetMutableCollectionIterator operator++(int);
  JetMutableCollectionIterator& operator--();
  JetMutableCollectionIterator operator--(int);
  JetMutableCollectionIterator& operator+=(difference_type n);
  JetMutableCollectionIterator operator+(difference_type n) const;
  friend JetMutableCollectionIterator operator+(difference_type n, const JetMutableCollectionIterator& it);
  JetMutableCollectionIterator& operator-=(difference_type n);
  JetMutableCollectionIterator operator-(difference_type n) const;
  reference operator[](difference_type n) const;
  difference_type operator-(const JetMutableCollectionIterator& other) const;
 
private:
  size_t m_index{0};
  MutableJet m_object { podio::utils::MaybeSharedPtr<JetObj>{nullptr} };
  const JetObjPointerContainer* m_collection{nullptr};
};
 
 
/**
A Collection is identified by an ID.
*/
class JetCollection : public podio::CollectionBase {
public:
  using value_type = Jet;
  using mutable_type = MutableJet;
  using const_iterator = JetCollectionIterator;
  using iterator = JetMutableCollectionIterator;
  using difference_type = ptrdiff_t;
  using size_type = size_t;
  using const_reverse_iterator = std::reverse_iterator<const_iterator>;
  using reverse_iterator = std::reverse_iterator<iterator>;
 
  JetCollection() = default;
  JetCollection(JetCollectionData&& data, bool isSubsetColl);
  // This is a move-only type
  JetCollection(const JetCollection& ) = delete;
  JetCollection& operator=(const JetCollection& ) = delete;
  JetCollection(JetCollection&&) = default;
  JetCollection& operator=(JetCollection&&) = default;
 
  ~JetCollection() override;
#if defined(__cpp_lib_containers_ranges)
  template<podio::detail::RangeConvertibleTo<value_type> R>
  JetCollection(std::from_range_t, R&& range);
#endif
 
  /// Construct a Jet collection from a range of mutable or
  /// immutable handles
  template<podio::detail::RangeConvertibleTo<value_type> R>
  static JetCollection from(R&& range);
 
  constexpr static std::string_view typeName = "edm4eic::JetCollection";
  constexpr static std::string_view valueTypeName = "edm4eic::Jet";
  constexpr static std::string_view dataTypeName = "edm4eic::JetData";
 
  void clear() final;
 
  /// Cppyy protocol to setup the pythonizations for this class. Not to be called directly.
  static void __cppyy_pythonize__(PyObject* klass, const std::string& name){
        podio::detail::pythonizations::pythonize_subscript(klass, name);
  }
 
  /// Print this collection to the passed stream
  void print(std::ostream& os=std::cout, bool flush=true) const final;
 
  /// Append a new object to the collection, and return this object.
  MutableJet create();
 
  /// Append a new object to the collection, and return this object.
  /// Initialized with the parameters given
  template<typename... Args>
  MutableJet create(Args&&... args);
 
  /// number of elements in the collection
  std::size_t size() const final;
 
  /// maximal number of elements in the collection
  std::size_t max_size() const final;
 
  /// Is the collection empty
  bool empty() const final;
 
  /// fully qualified type name
  const std::string_view getTypeName() const final { return typeName; }
  /// fully qualified type name of elements - with namespace
  const std::string_view getValueTypeName() const final { return valueTypeName; }
  /// fully qualified type name of stored POD elements - with namespace
  const std::string_view getDataTypeName() const final { return dataTypeName; }
  /// schema version
  podio::SchemaVersionT getSchemaVersion() const final;
 
  bool isSubsetCollection() const final {
    return m_isSubsetColl;
  }
 
  void setSubsetCollection(bool setSubset=true) final;
 
  /// Returns the const object of given index
  Jet operator[](std::size_t index) const;
  /// Returns the object of a given index
  MutableJet operator[](std::size_t index);
  /// Returns the const object of given index
  Jet at(std::size_t index) const;
  /// Returns the object of given index
  MutableJet at(std::size_t index);
 
 
  /// Append object to the collection
  void push_back(const MutableJet& object);
  /// Append an object to the (subset) collection
  void push_back(const Jet& object);
 
  void prepareForWrite() const final;
  void prepareAfterRead() final;
  bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
 
  /// Get the collection buffers for this collection
  podio::CollectionWriteBuffers getBuffers() final;
 
  void setID(uint32_t ID) final {
    m_collectionID = ID;
    if (!m_isSubsetColl) {
      std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
                  [ID] (JetObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
      );
    }
  }
 
  uint32_t getID() const final {
    return m_collectionID;
  }
 
  /// check if the collection has a valid ID
  bool hasID() const final {
    return getID() != static_cast<uint32_t>(podio::ObjectID::untracked) &&
        getID() != static_cast<uint32_t>(podio::ObjectID::invalid);
  }
 
  [[deprecated("isValid will be removed, use hasID() if you want to check if it has an ID, otherwise assume the "
               "collection is valid")]]
  bool isValid() const final {
    return hasID();
  }
 
  size_t getDatamodelRegistryIndex() const final;
 
  // support for the iterator protocol
  iterator begin() {
    return iterator(0, &m_storage.entries);
  }
  const_iterator begin() const {
    return const_iterator(0, &m_storage.entries);
  }
  const_iterator cbegin() const {
    return begin();
  }
  iterator end() {
    return iterator(m_storage.entries.size(), &m_storage.entries);
  }
  const_iterator end() const {
    return const_iterator(m_storage.entries.size(), &m_storage.entries);
  }
  const_iterator cend() const {
    return end();
  }
  // reverse iterators
  reverse_iterator rbegin() {
    return reverse_iterator(end());
  }
  const_reverse_iterator rbegin() const {
    return const_reverse_iterator(end());
  }
  const_reverse_iterator crbegin() const {
    return rbegin();
  }
  reverse_iterator rend() {
    return reverse_iterator(begin());
  }
  const_reverse_iterator rend() const {
    return const_reverse_iterator(begin());
  }
  const_reverse_iterator crend() const {
    return rend();
  }
 
 
  std::vector<std::uint32_t> type(const size_t nElem = 0) const;
  std::vector<float> area(const size_t nElem = 0) const;
  std::vector<float> energy(const size_t nElem = 0) const;
  std::vector<float> backgroundEnergyDensity(const size_t nElem = 0) const;
  std::vector<edm4hep::Vector3f> momentum(const size_t nElem = 0) const;
 
private:
  // For setReferences, we need to give our own CollectionData access to our
  // private entries. Otherwise we would need to expose a public member function
  // that gives access to the Obj* which is definitely not what we want
  friend class JetCollectionData;
 
  mutable bool m_isPrepared{false};
  bool m_isSubsetColl{false};
  uint32_t m_collectionID{static_cast<uint32_t>(podio::ObjectID::untracked)};
  mutable std::unique_ptr<std::mutex> m_storageMtx{std::make_unique<std::mutex>()};
  mutable JetCollectionData m_storage{};
};
 
std::ostream& operator<<(std::ostream& o, const JetCollection& v);
 
template<typename... Args>
MutableJet JetCollection::create(Args&&... args) {
  if (m_isSubsetColl) {
    throw std::logic_error("Cannot create new elements on a subset collection");
  }
  auto obj = new JetObj({static_cast<int>(m_storage.entries.size()), m_collectionID}, {std::forward<Args>(args)...});
  m_storage.entries.push_back(obj);
 
  // Need to initialize the relation vectors manually for the {ObjectID, JetData} constructor
  obj->m_constituents = new std::vector<edm4eic::ReconstructedParticle>();
  m_storage.createRelations(obj);
  return MutableJet(podio::utils::MaybeSharedPtr(obj));
}
 
 
#if defined(__cpp_lib_containers_ranges)
template<podio::detail::RangeConvertibleTo<JetCollection::value_type> R>
JetCollection::JetCollection(std::from_range_t, R&& range)
  : JetCollection() {
  setSubsetCollection(podio::detail::RangeOf<R, value_type>);
 
  for (auto&& elem : range) {
    push_back(std::forward<decltype(elem)>(elem));
  }
}
#endif
 
template<podio::detail::RangeConvertibleTo<JetCollection::value_type> R>
JetCollection JetCollection::from(R&& range) {
  JetCollection coll;
  if constexpr (podio::detail::RangeOf<R, value_type>) {
    coll.setSubsetCollection();
  }
 
  for (auto&& elem : range) {
    coll.push_back(std::forward<decltype(elem)>(elem));
  }
 
  return coll;
}
 
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const JetCollection& collection);
#endif
 
} // namespace edm4eic
 
 
// This is needed to avoid triggering opening every library in LD_LIBRARY_PATH
// until it's fixed in ROOT. See https://github.com/root-project/root/issues/18489
// and https://github.com/AIDASoft/podio/issues/770
#if defined(__clang__)
  #pragma clang diagnostic push
  #pragma clang diagnostic ignored "-Wunknown-warning-option"
  #pragma clang diagnostic ignored "-Wdeprecated-redundant-constexpr-static-def"
  #pragma clang diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::JetCollection::typeName;
constexpr std::string_view edm4eic::JetCollection::valueTypeName;
constexpr std::string_view edm4eic::JetCollection::dataTypeName;
  #pragma clang diagnostic pop
#elif defined(__GNUC__)
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::JetCollection::typeName;
constexpr std::string_view edm4eic::JetCollection::valueTypeName;
constexpr std::string_view edm4eic::JetCollection::dataTypeName;
  #pragma GCC diagnostic pop
#endif
 
 
#endif