Implementing std::hash specialization for MCCompLabel

matthiasrichter · sawenzel · commit 1188ecb75c04 · 2019-03-06T08:00:56.000+01:00
Restore PR AliceO2Group#1645 after resolving compilation issue. Previous implementation in commit b8470f8 has been reverted in commit 9497df2. Compilation error on macos was simply caused by missing header <unordered_map>.
diff --git a/DataFormats/simulation/include/SimulationDataFormat/MCCompLabel.h b/DataFormats/simulation/include/SimulationDataFormat/MCCompLabel.h
@@ -25,8 +25,6 @@ class MCCompLabel
 
   ULong64_t mLabel = NotSet; ///< MC label encoding MCtrack ID and MCevent origin
 
-  void checkFieldConsistensy();
-
  public:
   // number of bits reserved for MC track ID, DON'T modify this, since the
   // track ID might be negative
@@ -35,6 +33,11 @@ class MCCompLabel
   static constexpr int nbitsSrcID = 8; // number of bits reserved for MC source ID
   // the rest of the bits is reserved at the moment
 
+  // check if the fields are defined consistently
+  static_assert(nbitsTrackID == sizeof(int) * 8, "TrackID must have int size");
+  static_assert(nbitsTrackID + nbitsEvID + nbitsSrcID <= sizeof(ULong64_t) * 8,
+                "Fields cannot be stored in 64 bits");
+
   // mask to extract MC track ID
   static constexpr ULong64_t maskTrackID = (ul0x1 << nbitsTrackID) - 1;
   // mask to extract MC track ID
@@ -105,4 +108,17 @@ class MCCompLabel
 
 std::ostream& operator<<(std::ostream& os, const o2::MCCompLabel& c);
 
+namespace std
+{
+// defining std::hash for MCCompLabel in order to be used with unordered_maps
+template <>
+struct hash<o2::MCCompLabel> {
+ public:
+  size_t operator()(o2::MCCompLabel const& label) const
+  {
+    return static_cast<uint64_t>(label);
+  }
+};
+} // namespace std
+
 #endif
diff --git a/DataFormats/simulation/src/MCCompLabel.cxx b/DataFormats/simulation/src/MCCompLabel.cxx
@@ -37,12 +37,3 @@ std::ostream& operator<<(std::ostream& os, const o2::MCCompLabel& c)
   }
   return os;
 }
-
- //_____________________________________________
-void MCCompLabel::checkFieldConsistensy()
-{
-  // check if the fields are defined consistently
-  static_assert(nbitsTrackID==sizeof(int)*8, "TrackID must have int size");
-  static_assert(nbitsTrackID+nbitsEvID+nbitsSrcID<=sizeof(ULong64_t)*8,
-                "Fields cannot be stored in 64 bits");
-}
diff --git a/DataFormats/simulation/test/testMCCompLabel.cxx b/DataFormats/simulation/test/testMCCompLabel.cxx
@@ -15,6 +15,7 @@
 #include <iomanip>
 #include <ios>
 #include <iostream>
+#include <unordered_map>
 #include "SimulationDataFormat/MCCompLabel.h"
 
 using namespace o2;
@@ -25,16 +26,22 @@ BOOST_AUTO_TEST_CASE(MCCompLabel_test)
   BOOST_CHECK(!lbUndef.isSet()); // test invalid label status
 
   int ev = 200, src = 10;
+  std::unordered_map<MCCompLabel, int> labelMap;
   for (int tr=-100;tr<200;tr+=150) {
     MCCompLabel lb(tr, ev, src);
     std::cout << "Input:   [" << src << '/' << ev << '/'
               << std::setw(6) << tr << ']' << std::endl;
     std::cout << "Encoded: " << lb << " (packed: " << ULong_t(lb) << ")" << std::endl;
+    labelMap[lb] = tr;
     int trE, evE, srcE;
     lb.get(trE, evE, srcE);
     std::cout << "Decoded: [" << srcE << '/' << evE << '/'
               << std::setw(6) << trE << ']' << std::endl;
 
     BOOST_CHECK(tr == trE && ev == evE && src == srcE);
   }
+
+  for (auto& [key, value] : labelMap) {
+    BOOST_CHECK(key.getTrackID() == value);
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,12 +37,3 @@ std::ostream& operator<<(std::ostream& os, const o2::MCCompLabel& c)`
`37`	`37`	`}`
`38`	`38`	`return os;`
`39`	`39`	`}`
`40`		`-`
`41`		`- //_____________________________________________`
`42`		`-void MCCompLabel::checkFieldConsistensy()`
`43`		`-{`
`44`		`- // check if the fields are defined consistently`
`45`		`- static_assert(nbitsTrackID==sizeof(int)*8, "TrackID must have int size");`
`46`		`- static_assert(nbitsTrackID+nbitsEvID+nbitsSrcID<=sizeof(ULong64_t)*8,`
`47`		`- "Fields cannot be stored in 64 bits");`
`48`		`-}`