ConvexPolygonBounds.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file ConvexPolygonBounds.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2020 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Surfaces/BoundaryCheck.hpp"
#include "Acts/Surfaces/PlanarBounds.hpp"
#include "Acts/Surfaces/RectangleBounds.hpp"
#include "Acts/Surfaces/SurfaceBounds.hpp"

#include <array>
#include <cmath>
#include <cstddef>
#include <exception>
#include <iosfwd>
#include <vector>

#include <boost/container/small_vector.hpp>

namespace Acts {

class ConvexPolygonBoundsBase : public PlanarBounds {
 public:
  std::ostream& toStream(std::ostream& sl) const final;

  std::vector<double> values() const final;

 protected:
  template <typename coll_t>
  static RectangleBounds makeBoundingBox(const coll_t& vertices);

  template <typename coll_t>
  static void convex_impl(const coll_t& vertices) noexcept(false);
};

template <int N>
class ConvexPolygonBounds : public ConvexPolygonBoundsBase {
 public:
  static constexpr size_t num_vertices = N;
  using vertex_array = std::array<Vector2, num_vertices>;
  static constexpr size_t eSize = 2 * N;
  using value_array = std::array<double, eSize>;

  static_assert(N >= 3, "ConvexPolygonBounds needs at least 3 sides.");

  ConvexPolygonBounds() = delete;

  ConvexPolygonBounds(const std::vector<Vector2>& vertices) noexcept(false);

  ConvexPolygonBounds(const vertex_array& vertices) noexcept(false);

  ConvexPolygonBounds(const value_array& values) noexcept(false);

  ~ConvexPolygonBounds() override = default;

  BoundsType type() const final;

  bool inside(const Vector2& lposition,
              const BoundaryCheck& bcheck) const final;

  std::vector<Vector2> vertices(unsigned int lseg = 1) const final;

  const RectangleBounds& boundingBox() const final;

 private:
  vertex_array m_vertices;
  RectangleBounds m_boundingBox;

  void checkConsistency() const noexcept(false);
};

constexpr int PolygonDynamic = -1;

template <>
class ConvexPolygonBounds<PolygonDynamic> : public ConvexPolygonBoundsBase {
 public:
  constexpr static int eSize = -1;

  ConvexPolygonBounds() = delete;

  ~ConvexPolygonBounds() override = default;

  ConvexPolygonBounds(const std::vector<Vector2>& vertices);

  BoundsType type() const final;

  bool inside(const Vector2& lposition,
              const BoundaryCheck& bcheck) const final;

  std::vector<Vector2> vertices(unsigned int lseg = 1) const final;

  const RectangleBounds& boundingBox() const final;

 private:
  boost::container::small_vector<Vector2, 10> m_vertices;
  RectangleBounds m_boundingBox;

  void checkConsistency() const noexcept(false);
};

}  // namespace Acts

#include "Acts/Surfaces/ConvexPolygonBounds.ipp"