Chris@16: // Boost.Geometry (aka GGL, Generic Geometry Library)
Chris@16: 
Chris@16: // Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
Chris@16: // Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
Chris@16: // Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
Chris@16: 
Chris@101: // This file was modified by Oracle on 2013, 2014.
Chris@101: // Modifications copyright (c) 2013, 2014 Oracle and/or its affiliates.
Chris@101: 
Chris@16: // Parts of Boost.Geometry are redesigned from Geodan's Geographic Library
Chris@16: // (geolib/GGL), copyright (c) 1995-2010 Geodan, Amsterdam, the Netherlands.
Chris@16: 
Chris@16: // Use, modification and distribution is subject to the Boost Software License,
Chris@16: // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@101: // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
Chris@101: 
Chris@16: #ifndef BOOST_GEOMETRY_ALGORITHMS_COVERED_BY_HPP
Chris@16: #define BOOST_GEOMETRY_ALGORITHMS_COVERED_BY_HPP
Chris@16: 
Chris@16: 
Chris@16: #include <cstddef>
Chris@16: 
Chris@101: #include <boost/variant/apply_visitor.hpp>
Chris@101: #include <boost/variant/static_visitor.hpp>
Chris@101: #include <boost/variant/variant_fwd.hpp>
Chris@101: 
Chris@16: #include <boost/geometry/algorithms/not_implemented.hpp>
Chris@16: #include <boost/geometry/algorithms/within.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/strategies/cartesian/point_in_box.hpp>
Chris@16: #include <boost/geometry/strategies/cartesian/box_in_box.hpp>
Chris@101: #include <boost/geometry/strategies/default_strategy.hpp>
Chris@16: 
Chris@16: namespace boost { namespace geometry
Chris@16: {
Chris@16: 
Chris@101: #ifndef DOXYGEN_NO_DETAIL
Chris@101: namespace detail { namespace covered_by {
Chris@101: 
Chris@101: struct use_point_in_geometry
Chris@101: {
Chris@101:     template <typename Geometry1, typename Geometry2, typename Strategy>
Chris@101:     static inline bool apply(Geometry1 const& geometry1, Geometry2 const& geometry2, Strategy const& strategy)
Chris@101:     {
Chris@101:         return detail::within::point_in_geometry(geometry1, geometry2, strategy) >= 0;
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: struct use_relate
Chris@101: {
Chris@101:     template <typename Geometry1, typename Geometry2, typename Strategy>
Chris@101:     static inline bool apply(Geometry1 const& geometry1, Geometry2 const& geometry2, Strategy const& /*strategy*/)
Chris@101:     {
Chris@101:         return Strategy::apply(geometry1, geometry2);
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: }} // namespace detail::covered_by
Chris@101: #endif // DOXYGEN_NO_DETAIL
Chris@101: 
Chris@16: #ifndef DOXYGEN_NO_DISPATCH
Chris@16: namespace dispatch
Chris@16: {
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Geometry1,
Chris@16:     typename Geometry2,
Chris@16:     typename Tag1 = typename tag<Geometry1>::type,
Chris@16:     typename Tag2 = typename tag<Geometry2>::type
Chris@16: >
Chris@101: struct covered_by
Chris@101:     : not_implemented<Tag1, Tag2>
Chris@16: {};
Chris@16: 
Chris@16: 
Chris@16: template <typename Point, typename Box>
Chris@16: struct covered_by<Point, Box, point_tag, box_tag>
Chris@16: {
Chris@16:     template <typename Strategy>
Chris@16:     static inline bool apply(Point const& point, Box const& box, Strategy const& strategy)
Chris@16:     {
Chris@16:         ::boost::ignore_unused_variable_warning(strategy);
Chris@16:         return strategy.apply(point, box);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: template <typename Box1, typename Box2>
Chris@16: struct covered_by<Box1, Box2, box_tag, box_tag>
Chris@16: {
Chris@16:     template <typename Strategy>
Chris@16:     static inline bool apply(Box1 const& box1, Box2 const& box2, Strategy const& strategy)
Chris@16:     {
Chris@16:         assert_dimension_equal<Box1, Box2>();
Chris@16:         ::boost::ignore_unused_variable_warning(strategy);
Chris@16:         return strategy.apply(box1, box2);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: 
Chris@101: // P/P
Chris@101: 
Chris@101: template <typename Point1, typename Point2>
Chris@101: struct covered_by<Point1, Point2, point_tag, point_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiPoint>
Chris@101: struct covered_by<Point, MultiPoint, point_tag, multi_point_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // P/L
Chris@101: 
Chris@101: template <typename Point, typename Segment>
Chris@101: struct covered_by<Point, Segment, point_tag, segment_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename Linestring>
Chris@101: struct covered_by<Point, Linestring, point_tag, linestring_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiLinestring>
Chris@101: struct covered_by<Point, MultiLinestring, point_tag, multi_linestring_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // P/A
Chris@16: 
Chris@16: template <typename Point, typename Ring>
Chris@16: struct covered_by<Point, Ring, point_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename Polygon>
Chris@101: struct covered_by<Point, Polygon, point_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiPolygon>
Chris@101: struct covered_by<Point, MultiPolygon, point_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // L/L
Chris@101: 
Chris@101: template <typename Linestring1, typename Linestring2>
Chris@101: struct covered_by<Linestring1, Linestring2, linestring_tag, linestring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename MultiLinestring>
Chris@101: struct covered_by<Linestring, MultiLinestring, linestring_tag, multi_linestring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Linestring>
Chris@101: struct covered_by<MultiLinestring, Linestring, multi_linestring_tag, linestring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring1, typename MultiLinestring2>
Chris@101: struct covered_by<MultiLinestring1, MultiLinestring2, multi_linestring_tag, multi_linestring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: // L/A
Chris@101: 
Chris@101: template <typename Linestring, typename Ring>
Chris@101: struct covered_by<Linestring, Ring, linestring_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Ring>
Chris@101: struct covered_by<MultiLinestring, Ring, multi_linestring_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename Polygon>
Chris@101: struct covered_by<Linestring, Polygon, linestring_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Polygon>
Chris@101: struct covered_by<MultiLinestring, Polygon, multi_linestring_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename MultiPolygon>
Chris@101: struct covered_by<Linestring, MultiPolygon, linestring_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename MultiPolygon>
Chris@101: struct covered_by<MultiLinestring, MultiPolygon, multi_linestring_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: // A/A
Chris@101: 
Chris@101: template <typename Ring1, typename Ring2>
Chris@101: struct covered_by<Ring1, Ring2, ring_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Ring, typename Polygon>
Chris@101: struct covered_by<Ring, Polygon, ring_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon, typename Ring>
Chris@101: struct covered_by<Polygon, Ring, polygon_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon1, typename Polygon2>
Chris@101: struct covered_by<Polygon1, Polygon2, polygon_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Ring, typename MultiPolygon>
Chris@101: struct covered_by<Ring, MultiPolygon, ring_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon, typename Ring>
Chris@101: struct covered_by<MultiPolygon, Ring, multi_polygon_tag, ring_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon, typename MultiPolygon>
Chris@101: struct covered_by<Polygon, MultiPolygon, polygon_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon, typename Polygon>
Chris@101: struct covered_by<MultiPolygon, Polygon, multi_polygon_tag, polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon1, typename MultiPolygon2>
Chris@101: struct covered_by<MultiPolygon1, MultiPolygon2, multi_polygon_tag, multi_polygon_tag>
Chris@101:     : public detail::covered_by::use_relate
Chris@101: {};
Chris@101: 
Chris@101: } // namespace dispatch
Chris@101: #endif // DOXYGEN_NO_DISPATCH
Chris@101: 
Chris@101: 
Chris@101: namespace resolve_strategy {
Chris@101: 
Chris@101: struct covered_by
Chris@16: {
Chris@101:     template <typename Geometry1, typename Geometry2, typename Strategy>
Chris@101:     static inline bool apply(Geometry1 const& geometry1,
Chris@101:                              Geometry2 const& geometry2,
Chris@101:                              Strategy const& strategy)
Chris@16:     {
Chris@101:         concept::within::check
Chris@16:             <
Chris@101:                 typename tag<Geometry1>::type,
Chris@101:                 typename tag<Geometry2>::type,
Chris@101:                 typename tag_cast<typename tag<Geometry2>::type, areal_tag>::type,
Chris@16:                 Strategy
Chris@101:             >();
Chris@101:         concept::check<Geometry1 const>();
Chris@101:         concept::check<Geometry2 const>();
Chris@101:         assert_dimension_equal<Geometry1, Geometry2>();
Chris@101: 
Chris@101:         return dispatch::covered_by<Geometry1, Geometry2>::apply(geometry1,
Chris@101:                                                                  geometry2,
Chris@101:                                                                  strategy);
Chris@101:     }
Chris@101: 
Chris@101:     template <typename Geometry1, typename Geometry2>
Chris@101:     static inline bool apply(Geometry1 const& geometry1,
Chris@101:                              Geometry2 const& geometry2,
Chris@101:                              default_strategy)
Chris@101:     {
Chris@101:         typedef typename point_type<Geometry1>::type point_type1;
Chris@101:         typedef typename point_type<Geometry2>::type point_type2;
Chris@101: 
Chris@101:         typedef typename strategy::covered_by::services::default_strategy
Chris@101:             <
Chris@101:                 typename tag<Geometry1>::type,
Chris@101:                 typename tag<Geometry2>::type,
Chris@101:                 typename tag<Geometry1>::type,
Chris@101:                 typename tag_cast<typename tag<Geometry2>::type, areal_tag>::type,
Chris@101:                 typename tag_cast
Chris@101:                     <
Chris@101:                         typename cs_tag<point_type1>::type, spherical_tag
Chris@101:                     >::type,
Chris@101:                 typename tag_cast
Chris@101:                     <
Chris@101:                         typename cs_tag<point_type2>::type, spherical_tag
Chris@101:                     >::type,
Chris@101:                 Geometry1,
Chris@101:                 Geometry2
Chris@101:             >::type strategy_type;
Chris@101: 
Chris@101:         return covered_by::apply(geometry1, geometry2, strategy_type());
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@101: } // namespace resolve_strategy
Chris@101: 
Chris@101: 
Chris@101: namespace resolve_variant {
Chris@101: 
Chris@101: template <typename Geometry1, typename Geometry2>
Chris@101: struct covered_by
Chris@16: {
Chris@16:     template <typename Strategy>
Chris@101:     static inline bool apply(Geometry1 const& geometry1,
Chris@101:                              Geometry2 const& geometry2,
Chris@101:                              Strategy const& strategy)
Chris@16:     {
Chris@101:         return resolve_strategy::covered_by
Chris@101:                                ::apply(geometry1, geometry2, strategy);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@101: template <BOOST_VARIANT_ENUM_PARAMS(typename T), typename Geometry2>
Chris@101: struct covered_by<boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)>, Geometry2>
Chris@101: {
Chris@101:     template <typename Strategy>
Chris@101:     struct visitor: boost::static_visitor<bool>
Chris@101:     {
Chris@101:         Geometry2 const& m_geometry2;
Chris@101:         Strategy const& m_strategy;
Chris@101: 
Chris@101:         visitor(Geometry2 const& geometry2, Strategy const& strategy)
Chris@101:         : m_geometry2(geometry2), m_strategy(strategy) {}
Chris@101: 
Chris@101:         template <typename Geometry1>
Chris@101:         bool operator()(Geometry1 const& geometry1) const
Chris@101:         {
Chris@101:             return covered_by<Geometry1, Geometry2>
Chris@101:                    ::apply(geometry1, m_geometry2, m_strategy);
Chris@101:         }
Chris@101:     };
Chris@101: 
Chris@101:     template <typename Strategy>
Chris@101:     static inline bool
Chris@101:     apply(boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> const& geometry1,
Chris@101:           Geometry2 const& geometry2,
Chris@101:           Strategy const& strategy)
Chris@101:     {
Chris@101:         return boost::apply_visitor(visitor<Strategy>(geometry2, strategy), geometry1);
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: template <typename Geometry1, BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@101: struct covered_by<Geometry1, boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
Chris@101: {
Chris@101:     template <typename Strategy>
Chris@101:     struct visitor: boost::static_visitor<bool>
Chris@101:     {
Chris@101:         Geometry1 const& m_geometry1;
Chris@101:         Strategy const& m_strategy;
Chris@101: 
Chris@101:         visitor(Geometry1 const& geometry1, Strategy const& strategy)
Chris@101:         : m_geometry1(geometry1), m_strategy(strategy) {}
Chris@101: 
Chris@101:         template <typename Geometry2>
Chris@101:         bool operator()(Geometry2 const& geometry2) const
Chris@101:         {
Chris@101:             return covered_by<Geometry1, Geometry2>
Chris@101:                    ::apply(m_geometry1, geometry2, m_strategy);
Chris@101:         }
Chris@101:     };
Chris@101: 
Chris@101:     template <typename Strategy>
Chris@101:     static inline bool
Chris@101:     apply(Geometry1 const& geometry1,
Chris@101:           boost::variant<BOOST_VARIANT_ENUM_PARAMS(T)> const& geometry2,
Chris@101:           Strategy const& strategy)
Chris@101:     {
Chris@101:         return boost::apply_visitor(visitor<Strategy>(geometry1, strategy), geometry2);
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: template <
Chris@101:     BOOST_VARIANT_ENUM_PARAMS(typename T1),
Chris@101:     BOOST_VARIANT_ENUM_PARAMS(typename T2)
Chris@101: >
Chris@101: struct covered_by<
Chris@101:     boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)>,
Chris@101:     boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)>
Chris@101: >
Chris@101: {
Chris@101:     template <typename Strategy>
Chris@101:     struct visitor: boost::static_visitor<bool>
Chris@101:     {
Chris@101:         Strategy const& m_strategy;
Chris@101: 
Chris@101:         visitor(Strategy const& strategy): m_strategy(strategy) {}
Chris@101: 
Chris@101:         template <typename Geometry1, typename Geometry2>
Chris@101:         bool operator()(Geometry1 const& geometry1,
Chris@101:                         Geometry2 const& geometry2) const
Chris@101:         {
Chris@101:             return covered_by<Geometry1, Geometry2>
Chris@101:                    ::apply(geometry1, geometry2, m_strategy);
Chris@101:         }
Chris@101:     };
Chris@101: 
Chris@101:     template <typename Strategy>
Chris@101:     static inline bool
Chris@101:     apply(boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)> const& geometry1,
Chris@101:           boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)> const& geometry2,
Chris@101:           Strategy const& strategy)
Chris@101:     {
Chris@101:         return boost::apply_visitor(visitor<Strategy>(strategy), geometry1, geometry2);
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: } // namespace resolve_variant
Chris@16: 
Chris@16: 
Chris@16: /*!
Chris@16: \brief \brief_check12{is inside or on border}
Chris@16: \ingroup covered_by
Chris@16: \details \details_check12{covered_by, is inside or on border}.
Chris@16: \tparam Geometry1 \tparam_geometry
Chris@16: \tparam Geometry2 \tparam_geometry
Chris@16: \param geometry1 \param_geometry which might be inside or on the border of the second geometry
Chris@16: \param geometry2 \param_geometry which might cover the first geometry
Chris@16: \return true if geometry1 is inside of or on the border of geometry2,
Chris@16:     else false
Chris@16: \note The default strategy is used for covered_by detection
Chris@16: 
Chris@16: \qbk{[include reference/algorithms/covered_by.qbk]}
Chris@16: 
Chris@16:  */
Chris@16: template<typename Geometry1, typename Geometry2>
Chris@16: inline bool covered_by(Geometry1 const& geometry1, Geometry2 const& geometry2)
Chris@16: {
Chris@101:     return resolve_variant::covered_by<Geometry1, Geometry2>
Chris@101:                           ::apply(geometry1, geometry2, default_strategy());
Chris@16: }
Chris@16: 
Chris@16: /*!
Chris@16: \brief \brief_check12{is inside or on border} \brief_strategy
Chris@16: \ingroup covered_by
Chris@16: \details \details_check12{covered_by, is inside or on border}, \brief_strategy. \details_strategy_reasons
Chris@16: \tparam Geometry1 \tparam_geometry
Chris@16: \tparam Geometry2 \tparam_geometry
Chris@16: \param geometry1 \param_geometry which might be inside or on the border of the second geometry
Chris@16: \param geometry2 \param_geometry which might cover the first geometry
Chris@16: \param strategy strategy to be used
Chris@16: \return true if geometry1 is inside of or on the border of geometry2,
Chris@16:     else false
Chris@16: 
Chris@16: \qbk{distinguish,with strategy}
Chris@16: \qbk{[include reference/algorithms/covered_by.qbk]}
Chris@16: 
Chris@16: */
Chris@16: template<typename Geometry1, typename Geometry2, typename Strategy>
Chris@16: inline bool covered_by(Geometry1 const& geometry1, Geometry2 const& geometry2,
Chris@16:         Strategy const& strategy)
Chris@16: {
Chris@101:     return resolve_variant::covered_by<Geometry1, Geometry2>
Chris@101:                           ::apply(geometry1, geometry2, strategy);
Chris@16: }
Chris@16: 
Chris@16: }} // namespace boost::geometry
Chris@16: 
Chris@16: #endif // BOOST_GEOMETRY_ALGORITHMS_COVERED_BY_HPP