Barcode.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Barcode.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2018-2020 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Utilities/MultiIndex.hpp"

#include <cstdint>

namespace ActsFatras {

class Barcode : public Acts::MultiIndex<uint64_t, 12, 12, 16, 8, 16> {
  using Base = Acts::MultiIndex<uint64_t, 12, 12, 16, 8, 16>;

 public:
  using Base::Base;
  using Base::Value;

  // Construct an invalid barcode with all levels set to zero.
  Barcode() : Base(Base::Zeros()) {}
  Barcode(const Barcode&) = default;
  Barcode(Barcode&&) = default;
  Barcode& operator=(const Barcode&) = default;
  Barcode& operator=(Barcode&&) = default;

  constexpr Value vertexPrimary() const { return level(0); }
  constexpr Value vertexSecondary() const { return level(1); }
  constexpr Value particle() const { return level(2); }
  constexpr Value generation() const { return level(3); }
  constexpr Value subParticle() const { return level(4); }

  constexpr Barcode& setVertexPrimary(Value id) { return set(0, id), *this; }
  constexpr Barcode& setVertexSecondary(Value id) { return set(1, id), *this; }
  constexpr Barcode& setParticle(Value id) { return set(2, id), *this; }
  constexpr Barcode& setGeneration(Value id) { return set(3, id), *this; }
  constexpr Barcode& setSubParticle(Value id) { return set(4, id), *this; }

  Barcode makeDescendant(Value sub = 0u) const {
    return Barcode(*this).setGeneration(generation() + 1).setSubParticle(sub);
  }
};

}  // namespace ActsFatras

// specialize std::hash so Barcode can be used e.g. in an unordered_map
namespace std {
template <>
struct hash<ActsFatras::Barcode> {
  auto operator()(ActsFatras::Barcode barcode) const noexcept {
    return std::hash<ActsFatras::Barcode::Value>()(barcode.value());
  }
};
}  // namespace std