BinnedArray2D.h

Go to the documentation of this file.

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

// BinnedArray2D.h, (c) ATLAS Detector software
 
#ifndef TRKDETDESCRUTILS_BINNEDARRAY2D_H
#define TRKDETDESCRUTILS_BINNEDARRAY2D_H
 
#include "GaudiKernel/GaudiException.h"
#include "TrkDetDescrUtils/BinUtility.h"
#include "TrkDetDescrUtils/BinnedArray.h"
 
// STL
#include <vector>
#include <memory>
 
class MsgStream;
 
namespace Trk {

 
template<class T>
class BinnedArray2D final : public BinnedArray<T>
{
 
public:
 // defaults, copy assignment can not be defaulted (CachedPtr)
 BinnedArray2D() = default;
 BinnedArray2D(BinnedArray2D&&) = default;
 BinnedArray2D& operator=(BinnedArray2D&&) = default;
 ~BinnedArray2D() = default;

 BinnedArray2D(
     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);
 }
 BinnedArray2D(
     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);
 }

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

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

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

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

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

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

  T* nextObject(const Amg::Vector3D& gp,
                const Amg::Vector3D& mom,
                bool associatedResult = true) const
  {
    // direct access to associated one
    if (associatedResult){
      return object(gp);
    }
    size_t nextFirst = m_binUtility.next(gp, mom, 0);
    size_t nextSecond = m_binUtility.next(gp, mom, 1);
 
    return (nextFirst > 0 && nextSecond > 0)
             ? (m_array[nextSecond][nextFirst]).get()
             : nullptr;
  }

  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<T const * const>(m_arrayObjects->begin(), m_arrayObjects->end());
  }

  unsigned int arrayObjectsNumber() const
  {
    return (m_array.size() * (m_array[0]).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*>>();
      arrayObjects->reserve(arrayObjectsNumber());
      for (size_t ihl = 0; ihl < (m_binUtility.bins(1)); ++ihl) {
        for (size_t ill = 0; ill < (m_binUtility.bins(0)); ++ill) {
          arrayObjects->push_back((m_array[ihl][ill]).get());
        }
      }
      m_arrayObjects.set(std::move(arrayObjects));
    }
  }
 
  void initialize(const std::vector<std::pair<std::shared_ptr<T>, Amg::Vector3D>>& tclassvector){
    m_array = std::vector<std::vector<std::shared_ptr<T>>>(m_binUtility.bins(1));
    for (size_t i = 0; i < m_binUtility.bins(1); ++i) {
      m_array[i] = std::vector<std::shared_ptr<T>>(m_binUtility.bins(0));
    }
    // fill the Volume vector into the array
    size_t vecsize = tclassvector.size();
    for (size_t ivec = 0; ivec < vecsize; ++ivec) {
      const Amg::Vector3D currentGlobal(((tclassvector[ivec]).second));
      if (m_binUtility.inside(currentGlobal)) {
        std::vector<std::shared_ptr<T>>& curVec = m_array[m_binUtility.bin(currentGlobal, 1)];
        curVec[m_binUtility.bin(currentGlobal, 0)] = ((tclassvector)[ivec]).first;
      } else {
        throw GaudiException("BinnedArray2D", "Object outside bounds",
                             StatusCode::FAILURE);
      }
    }
  }
  std::vector<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_BINNEDARRAY2D_H