EDM4eic
EIC data model
Loading...
Searching...
No Matches
TensorCollection.h
Go to the documentation of this file.
1// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
2
3#ifndef EDM4EIC_TensorCollection_H
4#define EDM4EIC_TensorCollection_H
5
6// datamodel specific includes
8#include "edm4eic/Tensor.h"
10#include "edm4eic/TensorObj.h"
12
13// podio specific includes
14#include "podio/ICollectionProvider.h"
15#include "podio/CollectionBase.h"
16#include "podio/CollectionIDTable.h"
17
18#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
19#include "nlohmann/json_fwd.hpp"
20#endif
21
22#include <string>
23#include <vector>
24#include <deque>
25#include <array>
26#include <algorithm>
27#include <ostream>
28#include <mutex>
29#include <memory>
30#include <cstddef>
31
32namespace podio {
33 struct RelationNames;
34}
35
36namespace edm4eic {
37
38
39
41public:
42 TensorCollectionIterator(size_t index, const TensorObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TensorObj>{nullptr}), m_collection(collection) {}
43
46
47 bool operator!=(const TensorCollectionIterator& x) const {
48 return m_index != x.m_index; // TODO: may not be complete
49 }
50
51 bool operator==(const TensorCollectionIterator& x) const {
52 return m_index == x.m_index; // TODO: may not be complete
53 }
54
58
59private:
60 size_t m_index;
61 Tensor m_object;
62 const TensorObjPointerContainer* m_collection;
63};
64
65
67public:
68 TensorMutableCollectionIterator(size_t index, const TensorObjPointerContainer* collection) : m_index(index), m_object(podio::utils::MaybeSharedPtr<TensorObj>{nullptr}), m_collection(collection) {}
69
72
74 return m_index != x.m_index; // TODO: may not be complete
75 }
76
78 return m_index == x.m_index; // TODO: may not be complete
79 }
80
84
85private:
86 size_t m_index;
87 MutableTensor m_object;
88 const TensorObjPointerContainer* m_collection;
89};
90
91
92/**
93A Collection is identified by an ID.
94*/
95class TensorCollection : public podio::CollectionBase {
96public:
100
102 TensorCollection(TensorCollectionData&& data, bool isSubsetColl);
103 // This is a move-only type
108
109// TensorCollection(TensorVector* data, uint32_t collectionID);
111
112 constexpr static auto typeName = "edm4eic::TensorCollection";
113 constexpr static auto valueTypeName = "edm4eic::Tensor";
114 constexpr static auto dataTypeName = "edm4eic::TensorData";
115
116 void clear() final;
117
118 /// Print this collection to the passed stream
119 void print(std::ostream& os=std::cout, bool flush=true) const final;
120
121 /// operator to allow pointer like calling of members a la LCIO
122 TensorCollection* operator->() { return (TensorCollection*) this; }
123
124 /// Append a new object to the collection, and return this object.
126
127 /// Append a new object to the collection, and return this object.
128 /// Initialized with the parameters given
129 template<typename... Args>
130 MutableTensor create(Args&&... args);
131
132 /// number of elements in the collection
133 std::size_t size() const final;
134
135 /// Is the collection empty
136 bool empty() const final;
137
138 /// fully qualified type name
139 const std::string_view getTypeName() const final { return typeName; }
140 /// fully qualified type name of elements - with namespace
141 const std::string_view getValueTypeName() const final { return valueTypeName; }
142 /// fully qualified type name of stored POD elements - with namespace
143 const std::string_view getDataTypeName() const final { return dataTypeName; }
144 /// schema version
145 podio::SchemaVersionT getSchemaVersion() const final;
146
147 bool isSubsetCollection() const final {
148 return m_isSubsetColl;
149 }
150
151 void setSubsetCollection(bool setSubset=true) final;
152
153 /// Returns the const object of given index
154 Tensor operator[](std::size_t index) const;
155 /// Returns the object of a given index
156 MutableTensor operator[](std::size_t index);
157 /// Returns the const object of given index
158 Tensor at(std::size_t index) const;
159 /// Returns the object of given index
160 MutableTensor at(std::size_t index);
161
162
163 /// Append object to the collection
164 void push_back(MutableTensor object);
165 /// Append an object to the (subset) collection
166 void push_back(Tensor object);
167
168 void prepareForWrite() const final;
169 void prepareAfterRead() final;
170 bool setReferences(const podio::ICollectionProvider* collectionProvider) final;
171
172 /// Get the collection buffers for this collection
173 podio::CollectionWriteBuffers getBuffers() final;
174
175 void setID(uint32_t ID) final {
176 m_collectionID = ID;
177 if (!m_isSubsetColl) {
178 std::for_each(m_storage.entries.begin(), m_storage.entries.end(),
179 [ID] (TensorObj* obj) { obj->id = {obj->id.index, static_cast<uint32_t>(ID)}; }
180 );
181 }
182 m_isValid = true;
183 };
184
185 uint32_t getID() const final {
186 return m_collectionID;
187 }
188
189 bool isValid() const final {
190 return m_isValid;
191 }
192
193 size_t getDatamodelRegistryIndex() const final;
194
195 // support for the iterator protocol
196 iterator begin() {
197 return iterator(0, &m_storage.entries);
198 }
200 return const_iterator(0, &m_storage.entries);
201 }
203 return iterator(m_storage.entries.size(), &m_storage.entries);
204 }
206 return const_iterator(m_storage.entries.size(), &m_storage.entries);
207 }
208
209 std::vector<std::int32_t> elementType(const size_t nElem = 0) const;
210
211private:
212 // For setReferences, we need to give our own CollectionData access to our
213 // private entries. Otherwise we would need to expose a public member function
214 // that gives access to the Obj* which is definitely not what we want
216
217 bool m_isValid{false};
218 mutable bool m_isPrepared{false};
219 bool m_isSubsetColl{false};
220 uint32_t m_collectionID{0};
221 mutable std::unique_ptr<std::mutex> m_storageMtx{nullptr};
222 mutable TensorCollectionData m_storage{};
223};
224
225std::ostream& operator<<(std::ostream& o, const TensorCollection& v);
226
227template<typename... Args>
228MutableTensor TensorCollection::create(Args&&... args) {
229 if (m_isSubsetColl) {
230 throw std::logic_error("Cannot create new elements on a subset collection");
231 }
232 const int size = m_storage.entries.size();
233 auto obj = new TensorObj({size, m_collectionID}, {std::forward<Args>(args)...});
234 m_storage.entries.push_back(obj);
235
236 // Need to initialize the relation vectors manually for the {ObjectID, TensorData} constructor
237 obj->m_shape = new std::vector<std::int64_t>();
238 obj->m_floatData = new std::vector<float>();
239 obj->m_int64Data = new std::vector<std::int64_t>();
240 m_storage.createRelations(obj);
241 return MutableTensor(podio::utils::MaybeSharedPtr(obj));
242}
243
244#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
245void to_json(nlohmann::json& j, const TensorCollection& collection);
246#endif
247
248} // namespace edm4eic
249
250
251#endif
Definition MutableTensor.h:32
Definition TensorCollectionData.h:30
TensorObjPointerContainer entries
Definition TensorCollectionData.h:35
Definition TensorCollection.h:95
TensorCollection & operator=(TensorCollection &&)=default
static constexpr auto typeName
Definition TensorCollection.h:112
TensorCollection()
Definition TensorCollection.cc:23
bool isSubsetCollection() const final
Definition TensorCollection.h:147
static constexpr auto dataTypeName
Definition TensorCollection.h:114
void prepareAfterRead() final
Definition TensorCollection.cc:107
uint32_t getID() const final
Definition TensorCollection.h:185
MutableTensor create()
Append a new object to the collection, and return this object.
Definition TensorCollection.cc:69
const std::string_view getTypeName() const final
fully qualified type name
Definition TensorCollection.h:139
const_iterator end() const
Definition TensorCollection.h:205
const std::string_view getValueTypeName() const final
fully qualified type name of elements - with namespace
Definition TensorCollection.h:141
~TensorCollection()
Definition TensorCollection.cc:29
void setID(uint32_t ID) final
Definition TensorCollection.h:175
void push_back(MutableTensor object)
Append object to the collection.
Definition TensorCollection.cc:126
void clear() final
Definition TensorCollection.cc:81
iterator end()
Definition TensorCollection.h:202
TensorCollection(TensorCollection &&)=default
std::size_t size() const final
number of elements in the collection
Definition TensorCollection.cc:50
TensorCollection & operator=(const TensorCollection &)=delete
podio::CollectionWriteBuffers getBuffers() final
Get the collection buffers for this collection.
Definition TensorCollection.cc:159
bool isValid() const final
Definition TensorCollection.h:189
static constexpr auto valueTypeName
Definition TensorCollection.h:113
podio::SchemaVersionT getSchemaVersion() const final
schema version
Definition TensorCollection.cc:178
bool setReferences(const podio::ICollectionProvider *collectionProvider) final
Definition TensorCollection.cc:122
TensorCollection(const TensorCollection &)=delete
void prepareForWrite() const final
Definition TensorCollection.cc:86
const std::string_view getDataTypeName() const final
fully qualified type name of stored POD elements - with namespace
Definition TensorCollection.h:143
const_iterator begin() const
Definition TensorCollection.h:199
void setSubsetCollection(bool setSubset=true) final
Definition TensorCollection.cc:58
Tensor at(std::size_t index) const
Returns the const object of given index.
Definition TensorCollection.cc:38
void print(std::ostream &os=std::cout, bool flush=true) const final
Print this collection to the passed stream.
Definition TensorCollection.cc:352
bool empty() const final
Is the collection empty.
Definition TensorCollection.cc:54
Definition TensorCollection.h:40
Tensor * operator->()
Definition TensorCollection.cc:290
bool operator!=(const TensorCollectionIterator &x) const
Definition TensorCollection.h:47
TensorCollectionIterator(const TensorCollectionIterator &)=delete
TensorCollectionIterator(size_t index, const TensorObjPointerContainer *collection)
Definition TensorCollection.h:42
TensorCollectionIterator & operator++()
Definition TensorCollection.cc:295
bool operator==(const TensorCollectionIterator &x) const
Definition TensorCollection.h:51
Tensor operator*()
Definition TensorCollection.cc:285
TensorCollectionIterator & operator=(const TensorCollectionIterator &)=delete
Definition Tensor.h:33
Definition TensorCollection.h:66
TensorMutableCollectionIterator & operator++()
Definition TensorCollection.cc:312
TensorMutableCollectionIterator & operator=(const TensorMutableCollectionIterator &)=delete
TensorMutableCollectionIterator(size_t index, const TensorObjPointerContainer *collection)
Definition TensorCollection.h:68
bool operator!=(const TensorMutableCollectionIterator &x) const
Definition TensorCollection.h:73
MutableTensor operator*()
Definition TensorCollection.cc:302
TensorMutableCollectionIterator(const TensorMutableCollectionIterator &)=delete
MutableTensor * operator->()
Definition TensorCollection.cc:307
bool operator==(const TensorMutableCollectionIterator &x) const
Definition TensorCollection.h:77
Definition TensorObj.h:18
std::vector< std::int64_t > * m_shape
Definition TensorObj.h:34
Definition CalorimeterHit.cc:18
std::deque< TensorObj * > TensorObjPointerContainer
Definition TensorCollectionData.h:22
std::ostream & operator<<(std::ostream &o, const CalorimeterHit &value)
Definition CalorimeterHit.cc:97
Definition CalorimeterHitCollection.h:32