TensorCollection.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_TensorCollection_H
#define EDM4EIC_TensorCollection_H
 
// datamodel specific includes
#include "edm4eic/Tensor.h"
#include "edm4eic/MutableTensor.h"
#include "edm4eic/TensorObj.h"
#include "edm4eic/TensorCollectionData.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 TensorCollectionIterator {
public:
  using value_type = Tensor;
  using difference_type = ptrdiff_t;
  using reference = Tensor;
  using pointer = Tensor*;
  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;
 
  TensorCollectionIterator(size_t index, const TensorObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TensorObj>{nullptr}), m_collection(collection) {}
  TensorCollectionIterator() = default;
 
  TensorCollectionIterator(const TensorCollectionIterator&) = default;
  TensorCollectionIterator(TensorCollectionIterator&&) = default;
  TensorCollectionIterator& operator=(const TensorCollectionIterator&) = default;
  TensorCollectionIterator& operator=(TensorCollectionIterator&&) = default;
  ~TensorCollectionIterator() = default;
 
  constexpr auto operator<=>(const TensorCollectionIterator& other) const {
    return m_index <=> other.m_index;
  }
 
  constexpr bool operator==(const TensorCollectionIterator& x) const {
    return m_index ==  x.m_index;
  }
 
  reference operator*() const;
  pointer operator->();
  TensorCollectionIterator& operator++();
  TensorCollectionIterator operator++(int);
  TensorCollectionIterator& operator--();
  TensorCollectionIterator operator--(int);
  TensorCollectionIterator& operator+=(difference_type n);
  TensorCollectionIterator operator+(difference_type n) const;
  friend TensorCollectionIterator operator+(difference_type n, const TensorCollectionIterator& it);
  TensorCollectionIterator& operator-=(difference_type n);
  TensorCollectionIterator operator-(difference_type n) const;
  reference operator[](difference_type n) const;
  difference_type operator-(const TensorCollectionIterator& other) const;
 
private:
  size_t m_index{0};
  Tensor m_object { podio::utils::MaybeSharedPtr<TensorObj>{nullptr} };
  const TensorObjPointerContainer* m_collection{nullptr};
};
 
 
class TensorMutableCollectionIterator {
public:
  using value_type = Tensor;
  using difference_type = ptrdiff_t;
  using reference = MutableTensor;
  using pointer = MutableTensor*;
  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;
 
  TensorMutableCollectionIterator(size_t index, const TensorObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TensorObj>{nullptr}), m_collection(collection) {}
  TensorMutableCollectionIterator() = default;
 
  TensorMutableCollectionIterator(const TensorMutableCollectionIterator&) = default;
  TensorMutableCollectionIterator(TensorMutableCollectionIterator&&) = default;
  TensorMutableCollectionIterator& operator=(const TensorMutableCollectionIterator&) = default;
  TensorMutableCollectionIterator& operator=(TensorMutableCollectionIterator&&) = default;
  ~TensorMutableCollectionIterator() = default;
 
  constexpr auto operator<=>(const TensorMutableCollectionIterator& other) const {
    return m_index <=> other.m_index;
  }
 
  constexpr bool operator==(const TensorMutableCollectionIterator& x) const {
    return m_index ==  x.m_index;
  }
 
  reference operator*() const;
  pointer operator->();
  TensorMutableCollectionIterator& operator++();
  TensorMutableCollectionIterator operator++(int);
  TensorMutableCollectionIterator& operator--();
  TensorMutableCollectionIterator operator--(int);
  TensorMutableCollectionIterator& operator+=(difference_type n);
  TensorMutableCollectionIterator operator+(difference_type n) const;
  friend TensorMutableCollectionIterator operator+(difference_type n, const TensorMutableCollectionIterator& it);
  TensorMutableCollectionIterator& operator-=(difference_type n);
  TensorMutableCollectionIterator operator-(difference_type n) const;
  reference operator[](difference_type n) const;
  difference_type operator-(const TensorMutableCollectionIterator& other) const;
 
private:
  size_t m_index{0};
  MutableTensor m_object { podio::utils::MaybeSharedPtr<TensorObj>{nullptr} };
  const TensorObjPointerContainer* m_collection{nullptr};
};
 
 
/**
A Collection is identified by an ID.
*/
class TensorCollection : public podio::CollectionBase {
public:
  using value_type = Tensor;
  using mutable_type = MutableTensor;
  using const_iterator = TensorCollectionIterator;
  using iterator = TensorMutableCollectionIterator;
  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>;
 
  TensorCollection() = default;
  TensorCollection(TensorCollectionData&& data, bool isSubsetColl);
  // This is a move-only type
  TensorCollection(const TensorCollection& ) = delete;
  TensorCollection& operator=(const TensorCollection& ) = delete;
  TensorCollection(TensorCollection&&) = default;
  TensorCollection& operator=(TensorCollection&&) = default;
 
  ~TensorCollection() override;
#if defined(__cpp_lib_containers_ranges)
  template<podio::detail::RangeConvertibleTo<value_type> R>
  TensorCollection(std::from_range_t, R&& range);
#endif
 
  /// Construct a Tensor collection from a range of mutable or
  /// immutable handles
  template<podio::detail::RangeConvertibleTo<value_type> R>
  static TensorCollection from(R&& range);
 
  constexpr static std::string_view typeName = "edm4eic::TensorCollection";
  constexpr static std::string_view valueTypeName = "edm4eic::Tensor";
  constexpr static std::string_view dataTypeName = "edm4eic::TensorData";
 
  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.
  MutableTensor create();
 
  /// Append a new object to the collection, and return this object.
  /// Initialized with the parameters given
  template<typename... Args>
  MutableTensor 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
  Tensor operator[](std::size_t index) const;
  /// Returns the object of a given index
  MutableTensor operator[](std::size_t index);
  /// Returns the const object of given index
  Tensor at(std::size_t index) const;
  /// Returns the object of given index
  MutableTensor at(std::size_t index);
 
 
  /// Append object to the collection
  void push_back(const MutableTensor& object);
  /// Append an object to the (subset) collection
  void push_back(const Tensor& 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] (TensorObj* 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::int32_t> elementType(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 TensorCollectionData;
 
  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 TensorCollectionData m_storage{};
};
 
std::ostream& operator<<(std::ostream& o, const TensorCollection& v);
 
template<typename... Args>
MutableTensor TensorCollection::create(Args&&... args) {
  if (m_isSubsetColl) {
    throw std::logic_error("Cannot create new elements on a subset collection");
  }
  auto obj = new TensorObj({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, TensorData} constructor
  obj->m_shape = new std::vector<std::int64_t>();
  obj->m_floatData = new std::vector<float>();
  obj->m_int64Data = new std::vector<std::int64_t>();
  m_storage.createRelations(obj);
  return MutableTensor(podio::utils::MaybeSharedPtr(obj));
}
 
 
#if defined(__cpp_lib_containers_ranges)
template<podio::detail::RangeConvertibleTo<TensorCollection::value_type> R>
TensorCollection::TensorCollection(std::from_range_t, R&& range)
  : TensorCollection() {
  setSubsetCollection(podio::detail::RangeOf<R, value_type>);
 
  for (auto&& elem : range) {
    push_back(std::forward<decltype(elem)>(elem));
  }
}
#endif
 
template<podio::detail::RangeConvertibleTo<TensorCollection::value_type> R>
TensorCollection TensorCollection::from(R&& range) {
  TensorCollection 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 TensorCollection& 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::TensorCollection::typeName;
constexpr std::string_view edm4eic::TensorCollection::valueTypeName;
constexpr std::string_view edm4eic::TensorCollection::dataTypeName;
  #pragma clang diagnostic pop
#elif defined(__GNUC__)
  #pragma GCC diagnostic push
  #pragma GCC diagnostic ignored "-Wdeprecated"
constexpr std::string_view edm4eic::TensorCollection::typeName;
constexpr std::string_view edm4eic::TensorCollection::valueTypeName;
constexpr std::string_view edm4eic::TensorCollection::dataTypeName;
  #pragma GCC diagnostic pop
#endif
 
 
#endif