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_WITHIN_HPP
Chris@16: #define BOOST_GEOMETRY_ALGORITHMS_WITHIN_HPP
Chris@16: 
Chris@16: 
Chris@16: #include <cstddef>
Chris@16: 
Chris@16: #include <boost/concept_check.hpp>
Chris@16: #include <boost/range.hpp>
Chris@101: 
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@16: 
Chris@16: #include <boost/geometry/algorithms/make.hpp>
Chris@16: #include <boost/geometry/algorithms/not_implemented.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/core/access.hpp>
Chris@16: #include <boost/geometry/core/closure.hpp>
Chris@16: #include <boost/geometry/core/cs.hpp>
Chris@16: #include <boost/geometry/core/exterior_ring.hpp>
Chris@16: #include <boost/geometry/core/interior_rings.hpp>
Chris@16: #include <boost/geometry/core/point_order.hpp>
Chris@16: #include <boost/geometry/core/ring_type.hpp>
Chris@16: #include <boost/geometry/core/interior_rings.hpp>
Chris@16: #include <boost/geometry/core/tags.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/geometries/concepts/check.hpp>
Chris@101: #include <boost/geometry/strategies/concepts/within_concept.hpp>
Chris@101: #include <boost/geometry/strategies/default_strategy.hpp>
Chris@16: #include <boost/geometry/strategies/within.hpp>
Chris@16: #include <boost/geometry/util/math.hpp>
Chris@16: #include <boost/geometry/util/order_as_direction.hpp>
Chris@16: #include <boost/geometry/views/closeable_view.hpp>
Chris@16: #include <boost/geometry/views/reversible_view.hpp>
Chris@16: 
Chris@101: #include <boost/geometry/algorithms/detail/within/point_in_geometry.hpp>
Chris@101: 
Chris@101: #include <boost/geometry/algorithms/detail/overlay/get_turns.hpp>
Chris@101: #include <boost/geometry/algorithms/detail/overlay/do_reverse.hpp>
Chris@101: #include <deque>
Chris@16: 
Chris@16: namespace boost { namespace geometry
Chris@16: {
Chris@16: 
Chris@16: #ifndef DOXYGEN_NO_DETAIL
Chris@101: namespace detail { namespace within {
Chris@101: 
Chris@101: struct use_point_in_geometry
Chris@16: {
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@16:     {
Chris@101:         return detail::within::point_in_geometry(geometry1, geometry2, strategy) == 1;
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@101: struct use_relate
Chris@16: {
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@16:     {
Chris@101:         return Strategy::apply(geometry1, geometry2);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: }} // namespace detail::within
Chris@16: #endif // DOXYGEN_NO_DETAIL
Chris@16: 
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 within
Chris@101:     : not_implemented<Tag1, Tag2>
Chris@16: {};
Chris@16: 
Chris@16: 
Chris@16: template <typename Point, typename Box>
Chris@16: struct within<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 within<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@101: // P/P
Chris@16: 
Chris@101: template <typename Point1, typename Point2>
Chris@101: struct within<Point1, Point2, point_tag, point_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiPoint>
Chris@101: struct within<Point, MultiPoint, point_tag, multi_point_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // P/L
Chris@101: 
Chris@101: template <typename Point, typename Segment>
Chris@101: struct within<Point, Segment, point_tag, segment_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename Linestring>
Chris@101: struct within<Point, Linestring, point_tag, linestring_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiLinestring>
Chris@101: struct within<Point, MultiLinestring, point_tag, multi_linestring_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // P/A
Chris@16: 
Chris@16: template <typename Point, typename Ring>
Chris@16: struct within<Point, Ring, point_tag, ring_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename Polygon>
Chris@101: struct within<Point, Polygon, point_tag, polygon_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: template <typename Point, typename MultiPolygon>
Chris@101: struct within<Point, MultiPolygon, point_tag, multi_polygon_tag>
Chris@101:     : public detail::within::use_point_in_geometry
Chris@101: {};
Chris@101: 
Chris@101: // L/L
Chris@101: 
Chris@101: template <typename Linestring1, typename Linestring2>
Chris@101: struct within<Linestring1, Linestring2, linestring_tag, linestring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename MultiLinestring>
Chris@101: struct within<Linestring, MultiLinestring, linestring_tag, multi_linestring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Linestring>
Chris@101: struct within<MultiLinestring, Linestring, multi_linestring_tag, linestring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring1, typename MultiLinestring2>
Chris@101: struct within<MultiLinestring1, MultiLinestring2, multi_linestring_tag, multi_linestring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: // L/A
Chris@101: 
Chris@101: template <typename Linestring, typename Ring>
Chris@101: struct within<Linestring, Ring, linestring_tag, ring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Ring>
Chris@101: struct within<MultiLinestring, Ring, multi_linestring_tag, ring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename Polygon>
Chris@101: struct within<Linestring, Polygon, linestring_tag, polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename Polygon>
Chris@101: struct within<MultiLinestring, Polygon, multi_linestring_tag, polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Linestring, typename MultiPolygon>
Chris@101: struct within<Linestring, MultiPolygon, linestring_tag, multi_polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiLinestring, typename MultiPolygon>
Chris@101: struct within<MultiLinestring, MultiPolygon, multi_linestring_tag, multi_polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: // A/A
Chris@101: 
Chris@101: template <typename Ring1, typename Ring2>
Chris@101: struct within<Ring1, Ring2, ring_tag, ring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Ring, typename Polygon>
Chris@101: struct within<Ring, Polygon, ring_tag, polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon, typename Ring>
Chris@101: struct within<Polygon, Ring, polygon_tag, ring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon1, typename Polygon2>
Chris@101: struct within<Polygon1, Polygon2, polygon_tag, polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Ring, typename MultiPolygon>
Chris@101: struct within<Ring, MultiPolygon, ring_tag, multi_polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon, typename Ring>
Chris@101: struct within<MultiPolygon, Ring, multi_polygon_tag, ring_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename Polygon, typename MultiPolygon>
Chris@101: struct within<Polygon, MultiPolygon, polygon_tag, multi_polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon, typename Polygon>
Chris@101: struct within<MultiPolygon, Polygon, multi_polygon_tag, polygon_tag>
Chris@101:     : public detail::within::use_relate
Chris@101: {};
Chris@101: 
Chris@101: template <typename MultiPolygon1, typename MultiPolygon2>
Chris@101: struct within<MultiPolygon1, MultiPolygon2, multi_polygon_tag, multi_polygon_tag>
Chris@101:     : public detail::within::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@16: {
Chris@101: 
Chris@101: struct within
Chris@101: {
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: 
Chris@101:         return dispatch::within<Geometry1, Geometry2>::apply(geometry1, geometry2, 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::within::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 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: 
Chris@101: template <typename Geometry1, typename Geometry2>
Chris@101: struct within
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:         concept::check<Geometry1 const>();
Chris@101:         concept::check<Geometry2 const>();
Chris@101:         assert_dimension_equal<Geometry1, Geometry2>();
Chris@101: 
Chris@101:         return resolve_strategy::within::apply(geometry1,
Chris@101:                                                geometry2,
Chris@101:                                                strategy);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@101: template <BOOST_VARIANT_ENUM_PARAMS(typename T), typename Geometry2>
Chris@101: struct within<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),
Chris@101:         m_strategy(strategy)
Chris@101:         {}
Chris@101: 
Chris@101:         template <typename Geometry1>
Chris@101:         bool operator()(Geometry1 const& geometry1) const
Chris@101:         {
Chris@101:             return within<Geometry1, Geometry2>::apply(geometry1,
Chris@101:                                                        m_geometry2,
Chris@101:                                                        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(
Chris@101:             visitor<Strategy>(geometry2, strategy),
Chris@101:             geometry1
Chris@101:         );
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: template <typename Geometry1, BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@101: struct within<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),
Chris@101:         m_strategy(strategy)
Chris@101:         {}
Chris@101: 
Chris@101:         template <typename Geometry2>
Chris@101:         bool operator()(Geometry2 const& geometry2) const
Chris@101:         {
Chris@101:             return within<Geometry1, Geometry2>::apply(m_geometry1,
Chris@101:                                                        geometry2,
Chris@101:                                                        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(
Chris@101:             visitor<Strategy>(geometry1, strategy),
Chris@101:             geometry2
Chris@101:         );
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 within<
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 within<Geometry1, Geometry2>::apply(geometry1,
Chris@101:                                                        geometry2,
Chris@101:                                                        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(
Chris@101:             visitor<Strategy>(strategy),
Chris@101:             geometry1, geometry2
Chris@101:         );
Chris@101:     }
Chris@101: };
Chris@101: 
Chris@101: }
Chris@16: 
Chris@16: 
Chris@16: /*!
Chris@16: \brief \brief_check12{is completely inside}
Chris@16: \ingroup within
Chris@16: \details \details_check12{within, is completely inside}.
Chris@16: \tparam Geometry1 \tparam_geometry
Chris@16: \tparam Geometry2 \tparam_geometry
Chris@16: \param geometry1 \param_geometry which might be within the second geometry
Chris@16: \param geometry2 \param_geometry which might contain the first geometry
Chris@16: \return true if geometry1 is completely contained within geometry2,
Chris@16:     else false
Chris@16: \note The default strategy is used for within detection
Chris@16: 
Chris@16: 
Chris@16: \qbk{[include reference/algorithms/within.qbk]}
Chris@16: 
Chris@16: \qbk{
Chris@16: [heading Example]
Chris@16: [within]
Chris@16: [within_output]
Chris@16: }
Chris@16:  */
Chris@16: template<typename Geometry1, typename Geometry2>
Chris@16: inline bool within(Geometry1 const& geometry1, Geometry2 const& geometry2)
Chris@16: {
Chris@101:     return resolve_variant::within
Chris@16:         <
Chris@16:             Geometry1,
Chris@16:             Geometry2
Chris@101:         >::apply(geometry1, geometry2, default_strategy());
Chris@16: }
Chris@16: 
Chris@16: /*!
Chris@16: \brief \brief_check12{is completely inside} \brief_strategy
Chris@16: \ingroup within
Chris@16: \details \details_check12{within, is completely inside}, \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 within the second geometry
Chris@16: \param geometry2 \param_geometry which might contain the first geometry
Chris@16: \param strategy strategy to be used
Chris@16: \return true if geometry1 is completely contained within geometry2,
Chris@16:     else false
Chris@16: 
Chris@16: \qbk{distinguish,with strategy}
Chris@16: \qbk{[include reference/algorithms/within.qbk]}
Chris@16: \qbk{
Chris@16: [heading Available Strategies]
Chris@16: \* [link geometry.reference.strategies.strategy_within_winding Winding (coordinate system agnostic)]
Chris@16: \* [link geometry.reference.strategies.strategy_within_franklin Franklin (cartesian)]
Chris@16: \* [link geometry.reference.strategies.strategy_within_crossings_multiply Crossings Multiply (cartesian)]
Chris@16: 
Chris@16: [heading Example]
Chris@16: [within_strategy]
Chris@16: [within_strategy_output]
Chris@16: 
Chris@16: }
Chris@16: */
Chris@16: template<typename Geometry1, typename Geometry2, typename Strategy>
Chris@16: inline bool within(Geometry1 const& geometry1, Geometry2 const& geometry2,
Chris@16:         Strategy const& strategy)
Chris@16: {
Chris@101:     return resolve_variant::within
Chris@16:         <
Chris@16:             Geometry1,
Chris@16:             Geometry2
Chris@16:         >::apply(geometry1, geometry2, strategy);
Chris@16: }
Chris@16: 
Chris@16: }} // namespace boost::geometry
Chris@16: 
Chris@16: #endif // BOOST_GEOMETRY_ALGORITHMS_WITHIN_HPP