ConvexHull2D.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/DBoundingBox.h>
#include <OpenMS/DATASTRUCTURES/DPosition.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <functional>
#include <map>
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI ConvexHull2D
  {
public:
    typedef DPosition<2> PointType;
    typedef std::vector<PointType> PointArrayType;
    typedef PointArrayType::size_type SizeType;
    typedef PointArrayType::const_iterator PointArrayTypeConstIterator;
 
    typedef std::map<PointType::CoordinateType, DBoundingBox<1> > HullPointType;
 
    ConvexHull2D();
 
    ConvexHull2D(const ConvexHull2D&) = default;
 
    ConvexHull2D(ConvexHull2D&&) = default;
 
    ConvexHull2D& operator=(const ConvexHull2D& rhs);
 
    ConvexHull2D& operator=(ConvexHull2D&&) & = default;
 
    bool operator==(const ConvexHull2D& rhs) const;
 
    void clear();
 
    const PointArrayType& getHullPoints() const;
 
    const HullPointType& getMapPoints() const { return map_points_; }
 
    void setHullPoints(const PointArrayType& points);
 
    DBoundingBox<2> getBoundingBox() const;
 
    bool addPoint(const PointType& point);
 
    void addPoints(const PointArrayType& points);
 
    Size compress();
 
    void expandToBoundingBox();
 
 
    bool encloses(const PointType& point) const;
 
protected:
    HullPointType map_points_;
 
    mutable PointArrayType outer_points_;
 
  };
} // namespace OpenMS
 
// Hash function specialization for ConvexHull2D
namespace std
{
  template<>
  struct hash<OpenMS::ConvexHull2D>
  {
    std::size_t operator()(const OpenMS::ConvexHull2D& hull) const noexcept
    {
      std::size_t seed = 0;
 
      // Hash map_points_ (map of RT -> m/z bounding box)
      // std::map iteration order is deterministic (sorted by key)
      const auto& map_points = hull.getMapPoints();
      OpenMS::hash_combine(seed, OpenMS::hash_int(map_points.size()));
      for (const auto& entry : map_points)
      {
        OpenMS::hash_combine(seed, OpenMS::hash_float(entry.first));
        OpenMS::hash_combine(seed, std::hash<OpenMS::DBoundingBox<1>>{}(entry.second));
      }
 
      // Hash outer_points_ (vector of DPosition<2>)
      const auto& outer_points = hull.getHullPoints();
      OpenMS::hash_combine(seed, OpenMS::hash_int(outer_points.size()));
      for (const auto& point : outer_points)
      {
        OpenMS::hash_combine(seed, std::hash<OpenMS::DPosition<2>>{}(point));
      }
 
      return seed;
    }
  };
} // namespace std