include/ActsPodioEdm/MutableJacobian.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef ACTSPODIOEDM_MutableJacobian_H
0004 #define ACTSPODIOEDM_MutableJacobian_H
0005
0006 #include "ActsPodioEdm/JacobianObj.h"
0007 // Make the immutable class available from its mutable version but not vice
0008 // versa
0009 #include "ActsPodioEdm/Jacobian.h"
0010 #include "ActsPodioEdm/JacobianInfo.h"
0011
0012 #include <cstdint>
0013
0014 #include "podio/utilities/MaybeSharedPtr.h"
0015
0016 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0017 #include "nlohmann/json_fwd.hpp"
0018 #endif
0019
0020 // forward declarations
0021 namespace ActsPodioEdm {
0022 class JacobianCollection;
0023 }
0024
0025 namespace ActsPodioEdm {
0026
0027 /** @class MutableJacobian
0028  *  Jacobian matrix from the previous track state to the current one
0029  *  @author: Paul Gessinger, CERN
0030  */
0031 class MutableJacobian {
0032   friend class JacobianCollection;
0033   friend class JacobianMutableCollectionIterator;
0034   friend class Jacobian;
0035
0036  public:
0037   using object_type = Jacobian;
0038   using collection_type = JacobianCollection;
0039
0040   /// default constructor
0041   MutableJacobian();
0042
0043   /// Constructor initializing all members
0044   MutableJacobian(const ActsPodioEdm::JacobianInfo& data);
0045
0046   /// copy constructor
0047   MutableJacobian(const MutableJacobian& other) = default;
0048
0049   /// copy-assignment operator
0050   MutableJacobian& operator=(
0051       MutableJacobian other) &;  // Rebind this to other's internal object
0052   MutableJacobian& operator=(MutableJacobian other) && =
0053       delete;  // Prevent rebinding temporary as the changes wouldn't persist
0054
0055   /// create a mutable deep-copy of the object with identical relations
0056   /// if cloneRelations=false, the relations are not cloned and will be empty
0057   MutableJacobian clone(bool cloneRelations = true) const;
0058
0059   /// destructor
0060   ~MutableJacobian() = default;
0061
0062  public:
0063   /// Access the the jacobian data
0064   const ActsPodioEdm::JacobianInfo& getData() const;
0065
0066   /// Set the the jacobian data
0067   void setData(const ActsPodioEdm::JacobianInfo& data);
0068   /// Get mutable reference to the jacobian data
0069   ActsPodioEdm::JacobianInfo& getData();
0070   /// Get reference to the jacobian data
0071   [[deprecated("use getData instead")]]
0072   ActsPodioEdm::JacobianInfo& data();
0073
0074   /// check whether the object is actually available
0075   bool isAvailable() const;
0076   /// disconnect from JacobianObj instance
0077   void unlink() { m_obj = podio::utils::MaybeSharedPtr<JacobianObj>{nullptr}; }
0078
0079   bool operator==(const MutableJacobian& other) const {
0080     return m_obj == other.m_obj;
0081   }
0082   bool operator==(const Jacobian& other) const;
0083
0084   bool operator!=(const MutableJacobian& other) const {
0085     return !(*this == other);
0086   }
0087   bool operator!=(const Jacobian& other) const { return !(*this == other); }
0088
0089   // less comparison operator, so that objects can be e.g. stored in sets.
0090   bool operator<(const MutableJacobian& other) const {
0091     return podio::detail::getOrderKey(*this) <
0092            podio::detail::getOrderKey(other);
0093   }
0094
0095   podio::ObjectID id() const { return getObjectID(); }
0096
0097   const podio::ObjectID getObjectID() const;
0098
0099   friend std::hash<MutableJacobian>;
0100
0101   friend void swap(MutableJacobian& a, MutableJacobian& b) {
0102     using std::swap;
0103     swap(a.m_obj, b.m_obj);  // swap out the internal pointers
0104   }
0105
0106  private:
0107   /// constructor from existing JacobianObj
0108   explicit MutableJacobian(podio::utils::MaybeSharedPtr<JacobianObj> obj);
0109
0110   podio::utils::MaybeSharedPtr<JacobianObj> m_obj{nullptr};
0111 };
0112
0113 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0114 void to_json(nlohmann::json& j, const MutableJacobian& value);
0115 #endif
0116
0117 }  // namespace ActsPodioEdm
0118
0119 template <>
0120 struct std::hash<ActsPodioEdm::MutableJacobian> {
0121   std::size_t operator()(const ActsPodioEdm::MutableJacobian& obj) const {
0122     return std::hash<ActsPodioEdm::JacobianObj*>{}(obj.m_obj.get());
0123   }
0124 };
0125
0126 #endif