Acts/Seeding/BinnedGroupIterator.ipp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 // Binned SP Group Iterator
0010
0011 template <typename grid_t>
0012 Acts::BinnedGroupIterator<grid_t>::BinnedGroupIterator(
0013     const Acts::BinnedGroup<grid_t>& group,
0014     std::array<std::size_t, Acts::BinnedGroupIterator<grid_t>::DIM> index,
0015     std::array<std::vector<std::size_t>, Acts::BinnedGroupIterator<grid_t>::DIM>
0016         navigation)
0017     : m_group(group), m_gridItr(group.grid(), index, navigation) {
0018   std::array<std::size_t, DIM> endline{};
0019   for (std::size_t i(0ul); i < DIM; ++i) {
0020     endline[i] = navigation[i].size();
0021   }
0022   m_gridItrEnd = typename grid_t::local_iterator_t(m_group->grid(), endline,
0023                                                    std::move(navigation));
0024   findNotEmptyBin();
0025 }
0026
0027 template <typename grid_t>
0028 bool Acts::BinnedGroupIterator<grid_t>::operator==(
0029     const Acts::BinnedGroupIterator<grid_t>& other) const {
0030   return m_group.ptr == other.m_group.ptr && m_gridItr == other.m_gridItr;
0031 }
0032
0033 template <typename grid_t>
0034 Acts::BinnedGroupIterator<grid_t>&
0035 Acts::BinnedGroupIterator<grid_t>::operator++() {
0036   ++m_gridItr;
0037   findNotEmptyBin();
0038   return *this;
0039 }
0040
0041 template <typename grid_t>
0042 std::tuple<boost::container::small_vector<std::size_t,
0043                                           Acts::detail::ipow(3, grid_t::DIM)>,
0044            std::size_t,
0045            boost::container::small_vector<std::size_t,
0046                                           Acts::detail::ipow(3, grid_t::DIM)>>
0047 Acts::BinnedGroupIterator<grid_t>::operator*() const {
0048   /// Get the global and local position from current iterator. This is the bin
0049   /// with the middle candidate And we know this is not an empty bin
0050   std::array<std::size_t, DIM> localPosition = m_gridItr.localBinsIndices();
0051   std::size_t global_index =
0052       m_group->grid().globalBinFromLocalBins(localPosition);
0053
0054   /// Get the neighbouring bins
0055   boost::container::small_vector<std::size_t, Acts::detail::ipow(3, DIM)>
0056       bottoms =
0057           m_group->m_bottomBinFinder->findBins(localPosition, m_group->grid());
0058   boost::container::small_vector<std::size_t, Acts::detail::ipow(3, DIM)> tops =
0059       m_group->m_topBinFinder->findBins(localPosition, m_group->grid());
0060
0061   // GCC12+ in Release throws an overread warning here due to the move.
0062   // This is from inside boost code, so best we can do is to suppress it.
0063 #if defined(__GNUC__) && __GNUC__ >= 12 && !defined(__clang__)
0064 #pragma GCC diagnostic push
0065 #pragma GCC diagnostic ignored "-Wstringop-overread"
0066 #endif
0067   return {std::move(bottoms), global_index, std::move(tops)};
0068 #if defined(__GNUC__) && __GNUC__ >= 12 && !defined(__clang__)
0069 #pragma GCC diagnostic pop
0070 #endif
0071 }
0072
0073 template <typename grid_t>
0074 void Acts::BinnedGroupIterator<grid_t>::findNotEmptyBin() {
0075   if (m_gridItr == m_gridItrEnd) {
0076     return;
0077   }
0078   /// Iterate on the grid till we find a not-empty bin
0079   /// We start from the current bin configuration and move forward
0080   std::size_t dimCollection = (*m_gridItr).size();
0081   // Check if the current global bin is masked. This only makes sense if
0082   // we have not reached the end of the mask
0083   bool passesMask = false;
0084   if (m_gridItr != m_gridItrEnd) {
0085     passesMask = m_group->mask().at(m_gridItr.globalBinIndex());
0086   }
0087   // loop and only stop when we find a non-empty bin which is not masked
0088   while ((dimCollection == 0ul || !passesMask) &&
0089          (++m_gridItr != m_gridItrEnd)) {
0090     dimCollection = (*m_gridItr).size();
0091     if (dimCollection == 0ul) {
0092       continue;
0093     }
0094     passesMask = m_group->mask().at(m_gridItr.globalBinIndex());
0095   }
0096 }