MutableTensor.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTensor_H
#define EDM4EIC_MutableTensor_H
 
#include "edm4eic/TensorObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Tensor.h"
 
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class TensorCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTensor
 *  Tensor type for use in training in inference of ML models
 *  @author: D. Kalinkin
 */
class MutableTensor {
 
  friend class TensorCollection;
  friend class TensorMutableCollectionIterator;
  friend class Tensor;
 
public:
  using object_type = Tensor;
  using collection_type = TensorCollection;
 
  /// default constructor
  MutableTensor();
 
  /// Constructor initializing all members
  MutableTensor(std::int32_t elementType);
 
  /// copy constructor
  MutableTensor(const MutableTensor& other) = default;
 
  /// copy-assignment operator
  MutableTensor& operator=(MutableTensor 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
  ~MutableTensor() = default;
 
 
public:
 
  /// Access the Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
  std::int32_t getElementType() const;
 
 
 
  /// Set the Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
  void setElementType(std::int32_t value);
  /// Get mutable reference to Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
  std::int32_t& getElementType();
  /// Get reference to Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
  [[deprecated("use getElementType instead")]]
  std::int32_t& elementType();
 
 
 
  void addToShape(const std::int64_t&);
  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;
  void addToFloatData(const float&);
  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;
  void addToInt64Data(const std::int64_t&);
  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 MutableTensor& other) const { return m_obj == other.m_obj; }
  bool operator==(const Tensor& other) const;
 
  bool operator!=(const MutableTensor& other) const { return !(*this == other); }
  bool operator!=(const Tensor& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTensor& 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(MutableTensor& a, MutableTensor& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TensorObj
  explicit MutableTensor(podio::utils::MaybeSharedPtr<TensorObj> obj);
 
  podio::utils::MaybeSharedPtr<TensorObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTensor& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif