OverlapMatrixCreator.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
#pragma once
 
#include <vector>
#include <algorithm>
 
namespace Belle2 {
  class OverlapMatrixCreator {
  public:
    OverlapMatrixCreator(std::vector <std::vector <unsigned short> > const& hitRelatedTracks,
                         unsigned short nSpacePointTrackCandidates) :
      m_hitRelatedTracks(hitRelatedTracks), m_overlapMatrix(nSpacePointTrackCandidates)
    {}
 
    std::vector <std::vector<unsigned short> > getOverlapMatrix(unsigned allowedOverlaps = 0)
    {
      //Loop over all the hits and make corresponding connections for the tracks
      //This yields unordered indices of tracks, one for each shared hit.
      for (auto&& tracks : m_hitRelatedTracks) {
        for (unsigned short ii = 0; ii < tracks.size(); ii++) {
          for (unsigned short jj = ii + 1; jj < tracks.size(); jj++) {
            m_overlapMatrix[tracks[ii]].push_back(tracks[jj]);
            m_overlapMatrix[tracks[jj]].push_back(tracks[ii]);
          }
        }
      }
 
      //If it makes sense to have this can be explored by Jonas and Felix...
      //... so let's start with something that works, not necessarily what is fastest.
      //This is probably slower then the version below for 0 overlaps, but shall work with
      //any number of allowed overlaps.
      if (allowedOverlaps) {
        std::vector <unsigned short> overlapChache;
 
        for (auto&& overlapTracks : m_overlapMatrix) {
          std::sort(overlapTracks.begin(), overlapTracks.end());
 
          auto endIter    = overlapTracks.end();
          auto cacheIter  = overlapTracks.begin();
          for (auto iter = overlapTracks.begin(); iter != endIter; iter++) {
            if (*iter != *cacheIter) {
              cacheIter = iter;
            } else if (iter - cacheIter == allowedOverlaps) {
              overlapChache.push_back(*iter);
            }
          }
          overlapTracks = overlapChache;
          overlapChache.clear();
        }
        return m_overlapMatrix;
      }
 
      //sort and erase duplicate overlaps
      //TODO: Check in realistic situation alternative approach:
      //see http://stackoverflow.com/questions/1041620/whats-the-most-efficient-way-to-erase-duplicates-and-sort-a-vector
      for (auto&& overlapTracks : m_overlapMatrix) {
        std::sort(overlapTracks.begin(), overlapTracks.end());
        overlapTracks.erase(std::unique(overlapTracks.begin(), overlapTracks.end()), overlapTracks.end());
      }
 
      return m_overlapMatrix;
    }
 
  private:
    std::vector<std::vector <unsigned short> >const& m_hitRelatedTracks;
    std::vector<std::vector <unsigned short> >        m_overlapMatrix;  
  };
}