Tensor.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Tensor_H
#define EDM4EIC_Tensor_H
 
#include "edm4eic/TensorObj.h"
 
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
#include "podio/detail/OrderKey.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class TensorCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Tensor& obj);
};
 
namespace edm4eic {
 
class MutableTensor;
class TensorCollection;
class TensorCollectionData;
 
/** @class Tensor
 *  Tensor type for use in training in inference of ML models
 *  @author: D. Kalinkin
 */
class Tensor {
 
  friend class MutableTensor;
  friend class TensorCollection;
  friend class edm4eic::TensorCollectionData;
  friend class TensorCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Tensor & obj);
 
public:
  using mutable_type = MutableTensor;
  using collection_type = TensorCollection;
 
  /// default constructor
  Tensor();
 
  /// Constructor initializing all members
  Tensor(std::int32_t elementType);
 
  /// copy constructor
  Tensor(const Tensor& other) = default;
 
  /// copy-assignment operator
  Tensor& operator=(Tensor other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTensor clone(bool cloneRelations=true) const;
 
  /// destructor
  ~Tensor() = default;
 
  /// converting constructor from mutable object
  Tensor(const MutableTensor& other);
 
  static Tensor makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::Tensor";
 
  /// Access the Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
  std::int32_t getElementType() const;
 
 
 
  std::size_t shape_size() const;
  std::int64_t getShape(std::size_t) const;
  std::vector<std::int64_t>::const_iterator shape_begin() const;
  std::vector<std::int64_t>::const_iterator shape_end() const;
  podio::RelationRange<std::int64_t> getShape() const;
  std::size_t floatData_size() const;
  float getFloatData(std::size_t) const;
  std::vector<float>::const_iterator floatData_begin() const;
  std::vector<float>::const_iterator floatData_end() const;
  podio::RelationRange<float> getFloatData() const;
  std::size_t int64Data_size() const;
  std::int64_t getInt64Data(std::size_t) const;
  std::vector<std::int64_t>::const_iterator int64Data_begin() const;
  std::vector<std::int64_t>::const_iterator int64Data_end() const;
  podio::RelationRange<std::int64_t> getInt64Data() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TensorObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TensorObj>{nullptr}; }
 
  bool operator==(const Tensor& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableTensor& other) const;
 
  bool operator!=(const Tensor& other) const { return !(*this == other); }
  bool operator!=(const MutableTensor& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Tensor& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(Tensor& a, Tensor& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TensorObj
  explicit Tensor(podio::utils::MaybeSharedPtr<TensorObj> obj);
  Tensor(TensorObj* obj);
 
  podio::utils::MaybeSharedPtr<TensorObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Tensor& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Tensor& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif