BinnedArray1D.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

// BinnedArray1D.h, (c) ATLAS Detector software
 
#ifndef TRKDETDESCRUTILS_BINNEDARRAY1D_H
#define TRKDETDESCRUTILS_BINNEDARRAY1D_H
 
#include "TrkDetDescrUtils/BinUtility.h"
#include "TrkDetDescrUtils/BinnedArray.h"
 
// STL
#include <vector>
#include <memory>
 
#include "CxxUtils/CachedUniquePtr.h"
 
 
namespace Trk {

 
template<class T>
class BinnedArray1D final : public BinnedArray<T>
{
 
public:
 //defaults, copy assignment can not be defaulted (CachedPtr)
 BinnedArray1D() = default;
 BinnedArray1D(BinnedArray1D&&) = default;
 BinnedArray1D& operator=(BinnedArray1D&&) = default;
 ~BinnedArray1D() = default;
 BinnedArray1D(
     const std::vector<std::pair<std::shared_ptr<T>, Amg::Vector3D>>& tclassvector,
     const BinUtility& bingen)
     : BinnedArray<T>(),
       m_array{},
       m_arrayObjects(nullptr),
       m_binUtility(bingen) {
   initialize(tclassvector);
  }
  BinnedArray1D(
    const std::vector<std::pair<std::shared_ptr<T>, Amg::Vector3D>>& tclassvector,
    BinUtility&& bingen)
    : BinnedArray<T>()
    , m_array{}
    , m_arrayObjects(nullptr)
    , m_binUtility(std::move(bingen))
  {
    initialize(tclassvector);
  }

  BinnedArray1D(const BinnedArray1D& barr)
    : BinnedArray<T>()
    , m_array{barr.m_array}
    , m_arrayObjects(nullptr)
    , m_binUtility(barr.m_binUtility)
  {
  }

  BinnedArray1D& operator=(const BinnedArray1D& barr)
  {
    if (this != &barr) {
      m_binUtility = barr.m_binUtility;
      m_array.clear();
      m_arrayObjects.release();
      m_array = barr.m_array;
    }
    return *this;
  }

  BinnedArray1D* clone() const { return new BinnedArray1D(*this); }

  T* object(const Amg::Vector2D& lp) const
  {
    if (m_binUtility.inside(lp)) {
      return (m_array[m_binUtility.bin(lp, 0)]).get();
    }
    return nullptr;
  }

  T* object(const Amg::Vector3D& gp) const
  {
    return (m_array[m_binUtility.bin(gp, 0)]).get();
  }

  T* entryObject(const Amg::Vector3D& gp) const
  {
    return (m_array[m_binUtility.entry(gp, 0)]).get();
  }

  T* nextObject(const Amg::Vector3D& gp,
                const Amg::Vector3D& mom,
                bool associatedResult = true) const
  {
    // the bins
    size_t bin = associatedResult ? m_binUtility.bin(gp, 0)
                                  : m_binUtility.next(gp, mom, 0);
    return (m_array[bin]).get();
  }

  std::span<T* const> arrayObjects()
  {
    createArrayCache();
    return std::span<T* const>(m_arrayObjects->begin(), m_arrayObjects->end());
  }

  std::span<T const * const > arrayObjects() const
  {
    createArrayCache();
    return std::span<const T* const>(m_arrayObjects->begin(), m_arrayObjects->end());
  }

  unsigned int arrayObjectsNumber() const { return arrayObjects().size(); }

  const BinUtility* binUtility() const { return &m_binUtility; }
 
private:
  void createArrayCache() const
  {
    if (!m_arrayObjects) {
      std::unique_ptr<std::vector<T*>> arrayObjects = std::make_unique<std::vector<T*>>();
      auto bins = m_binUtility.bins(0);
      arrayObjects->reserve(bins);
      for (size_t ill = 0; ill < bins; ++ill) {
        arrayObjects->push_back((m_array[ill]).get());
      }
      m_arrayObjects.set(std::move(arrayObjects));
    }
  }
 
  void initialize(const std::vector<std::pair<std::shared_ptr<T>, Amg::Vector3D>>& tclassvector) {
    // prepare the binned Array
    size_t vecsize = tclassvector.size();
    m_array = std::vector<std::shared_ptr<T>>(vecsize);
    for (size_t ivec = 0; ivec < vecsize; ++ivec) {
      const Amg::Vector3D currentGlobal(((tclassvector[ivec]).second));
      if (m_binUtility.inside(currentGlobal)) {
        m_array[m_binUtility.bin(currentGlobal, 0)] =
            ((tclassvector)[ivec]).first;
      } else
        throw GaudiException("BinnedArray1D constructor",
                             "Object outside bounds", StatusCode::FAILURE);
    }
  }
  std::vector<std::shared_ptr<T>> m_array{};
  CxxUtils::CachedUniquePtr<std::vector<T*>> m_arrayObjects{nullptr};
  BinUtility m_binUtility{};
};
 
} // end of namespace Trk
 
#endif // TRKSURFACES_BINNEDARRAY1D_H