Chris@102: // Boost.Geometry (aka GGL, Generic Geometry Library)
Chris@102: 
Chris@102: // Copyright (c) 2007-2014 Barend Gehrels, Amsterdam, the Netherlands.
Chris@102: // Copyright (c) 2008-2014 Bruno Lalande, Paris, France.
Chris@102: // Copyright (c) 2009-2014 Mateusz Loskot, London, UK.
Chris@102: // Copyright (c) 2013-2014 Adam Wulkiewicz, Lodz, Poland.
Chris@102: // Copyright (c) 2014 Samuel Debionne, Grenoble, France.
Chris@102: 
Chris@102: // This file was modified by Oracle on 2014.
Chris@102: // Modifications copyright (c) 2014, Oracle and/or its affiliates.
Chris@102: 
Chris@102: // Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle
Chris@102: 
Chris@102: // Parts of Boost.Geometry are redesigned from Geodan's Geographic Library
Chris@102: // (geolib/GGL), copyright (c) 1995-2010 Geodan, Amsterdam, the Netherlands.
Chris@102: 
Chris@102: // Use, modification and distribution is subject to the Boost Software License,
Chris@102: // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@102: // http://www.boost.org/LICENSE_1_0.txt)
Chris@102: 
Chris@102: #ifndef BOOST_GEOMETRY_ALGORITHMS_DETAIL_DISTANCE_INTERFACE_HPP
Chris@102: #define BOOST_GEOMETRY_ALGORITHMS_DETAIL_DISTANCE_INTERFACE_HPP
Chris@102: 
Chris@102: #include <boost/concept_check.hpp>
Chris@102: 
Chris@102: #include <boost/mpl/always.hpp>
Chris@102: #include <boost/mpl/bool.hpp>
Chris@102: #include <boost/mpl/vector.hpp>
Chris@102: 
Chris@102: #include <boost/geometry/core/point_type.hpp>
Chris@102: 
Chris@102: #include <boost/geometry/geometries/concepts/check.hpp>
Chris@102: 
Chris@102: #include <boost/geometry/strategies/default_strategy.hpp>
Chris@102: #include <boost/geometry/strategies/distance.hpp>
Chris@102: #include <boost/geometry/strategies/default_distance_result.hpp>
Chris@102: #include <boost/geometry/strategies/distance_result.hpp>
Chris@102: 
Chris@102: #include <boost/geometry/algorithms/detail/throw_on_empty_input.hpp>
Chris@102: #include <boost/geometry/algorithms/detail/distance/default_strategies.hpp>
Chris@102: 
Chris@102: #include <boost/geometry/algorithms/dispatch/distance.hpp>
Chris@102: 
Chris@102: 
Chris@102: namespace boost { namespace geometry
Chris@102: {
Chris@102: 
Chris@102: 
Chris@102: #ifndef DOXYGEN_NO_DISPATCH
Chris@102: namespace dispatch
Chris@102: {
Chris@102: 
Chris@102: 
Chris@102: // If reversal is needed, perform it
Chris@102: template
Chris@102: <
Chris@102:     typename Geometry1, typename Geometry2, typename Strategy,
Chris@102:     typename Tag1, typename Tag2, typename StrategyTag
Chris@102: >
Chris@102: struct distance
Chris@102: <
Chris@102:     Geometry1, Geometry2, Strategy,
Chris@102:     Tag1, Tag2, StrategyTag,
Chris@102:     true
Chris@102: >
Chris@102:     : distance<Geometry2, Geometry1, Strategy, Tag2, Tag1, StrategyTag, false>
Chris@102: {
Chris@102:     typedef typename strategy::distance::services::return_type
Chris@102:                      <
Chris@102:                          Strategy,
Chris@102:                          typename point_type<Geometry2>::type,
Chris@102:                          typename point_type<Geometry1>::type
Chris@102:                      >::type return_type;
Chris@102: 
Chris@102:     static inline return_type apply(
Chris@102:         Geometry1 const& g1,
Chris@102:         Geometry2 const& g2,
Chris@102:         Strategy const& strategy)
Chris@102:     {
Chris@102:         return distance
Chris@102:             <
Chris@102:                 Geometry2, Geometry1, Strategy,
Chris@102:                 Tag2, Tag1, StrategyTag,
Chris@102:                 false
Chris@102:             >::apply(g2, g1, strategy);
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: 
Chris@102: } // namespace dispatch
Chris@102: #endif // DOXYGEN_NO_DISPATCH
Chris@102: 
Chris@102: 
Chris@102: namespace resolve_strategy
Chris@102: {
Chris@102: 
Chris@102: struct distance
Chris@102: {
Chris@102:     template <typename Geometry1, typename Geometry2, typename Strategy>
Chris@102:     static inline typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102:     apply(Geometry1 const& geometry1,
Chris@102:           Geometry2 const& geometry2,
Chris@102:           Strategy const& strategy)
Chris@102:     {
Chris@102:         return dispatch::distance
Chris@102:             <
Chris@102:                 Geometry1, Geometry2, Strategy
Chris@102:             >::apply(geometry1, geometry2, strategy);
Chris@102:     }
Chris@102: 
Chris@102:     template <typename Geometry1, typename Geometry2>
Chris@102:     static inline
Chris@102:     typename distance_result<Geometry1, Geometry2, default_strategy>::type
Chris@102:     apply(Geometry1 const& geometry1,
Chris@102:           Geometry2 const& geometry2,
Chris@102:           default_strategy)
Chris@102:     {
Chris@102:         typedef typename detail::distance::default_strategy
Chris@102:             <
Chris@102:                 Geometry1, Geometry2
Chris@102:             >::type strategy_type;
Chris@102: 
Chris@102:         return dispatch::distance
Chris@102:             <
Chris@102:                 Geometry1, Geometry2, strategy_type
Chris@102:             >::apply(geometry1, geometry2, strategy_type());
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: } // namespace resolve_strategy
Chris@102: 
Chris@102: 
Chris@102: namespace resolve_variant
Chris@102: {
Chris@102: 
Chris@102: 
Chris@102: template <typename Geometry1, typename Geometry2>
Chris@102: struct distance
Chris@102: {
Chris@102:     template <typename Strategy>
Chris@102:     static inline typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102:     apply(Geometry1 const& geometry1,
Chris@102:           Geometry2 const& geometry2,
Chris@102:           Strategy const& strategy)
Chris@102:     {
Chris@102:         return
Chris@102:             resolve_strategy::distance::apply(geometry1, geometry2, strategy);
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: 
Chris@102: template <BOOST_VARIANT_ENUM_PARAMS(typename T), typename Geometry2>
Chris@102: struct distance<variant<BOOST_VARIANT_ENUM_PARAMS(T)>, Geometry2>
Chris@102: {
Chris@102:     template <typename Strategy>
Chris@102:     struct visitor: static_visitor
Chris@102:         <
Chris@102:             typename distance_result
Chris@102:                 <
Chris@102:                     variant<BOOST_VARIANT_ENUM_PARAMS(T)>,
Chris@102:                     Geometry2,
Chris@102:                     Strategy
Chris@102:                 >::type
Chris@102:         >
Chris@102:     {
Chris@102:         Geometry2 const& m_geometry2;
Chris@102:         Strategy const& m_strategy;
Chris@102: 
Chris@102:         visitor(Geometry2 const& geometry2,
Chris@102:                 Strategy const& strategy)
Chris@102:             : m_geometry2(geometry2),
Chris@102:               m_strategy(strategy)
Chris@102:         {}
Chris@102: 
Chris@102:         template <typename Geometry1>
Chris@102:         typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102:         operator()(Geometry1 const& geometry1) const
Chris@102:         {
Chris@102:             return distance
Chris@102:                 <
Chris@102:                     Geometry1,
Chris@102:                     Geometry2
Chris@102:                 >::template apply
Chris@102:                     <
Chris@102:                         Strategy
Chris@102:                     >(geometry1, m_geometry2, m_strategy);
Chris@102:         }
Chris@102:     };
Chris@102: 
Chris@102:     template <typename Strategy>
Chris@102:     static inline typename distance_result
Chris@102:         <
Chris@102:             variant<BOOST_VARIANT_ENUM_PARAMS(T)>,
Chris@102:             Geometry2,
Chris@102:             Strategy
Chris@102:         >::type
Chris@102:     apply(variant<BOOST_VARIANT_ENUM_PARAMS(T)> const& geometry1,
Chris@102:           Geometry2 const& geometry2,
Chris@102:           Strategy const& strategy)
Chris@102:     {
Chris@102:         return apply_visitor(visitor<Strategy>(geometry2, strategy), geometry1);
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: 
Chris@102: template <typename Geometry1, BOOST_VARIANT_ENUM_PARAMS(typename T)>
Chris@102: struct distance<Geometry1, variant<BOOST_VARIANT_ENUM_PARAMS(T)> >
Chris@102: {
Chris@102:     template <typename Strategy>
Chris@102:     struct visitor: static_visitor
Chris@102:         <
Chris@102:             typename distance_result
Chris@102:                 <
Chris@102:                     Geometry1,
Chris@102:                     variant<BOOST_VARIANT_ENUM_PARAMS(T)>,
Chris@102:                     Strategy
Chris@102:                 >::type
Chris@102:         >
Chris@102:     {
Chris@102:         Geometry1 const& m_geometry1;
Chris@102:         Strategy const& m_strategy;
Chris@102: 
Chris@102:         visitor(Geometry1 const& geometry1,
Chris@102:                 Strategy const& strategy)
Chris@102:             : m_geometry1(geometry1),
Chris@102:               m_strategy(strategy)
Chris@102:         {}
Chris@102: 
Chris@102:         template <typename Geometry2>
Chris@102:         typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102:         operator()(Geometry2 const& geometry2) const
Chris@102:         {
Chris@102:             return distance
Chris@102:                 <
Chris@102:                     Geometry1,
Chris@102:                     Geometry2
Chris@102:                 >::template apply
Chris@102:                 <
Chris@102:                     Strategy
Chris@102:                 >(m_geometry1, geometry2, m_strategy);
Chris@102:         }
Chris@102:     };
Chris@102: 
Chris@102:     template <typename Strategy>
Chris@102:     static inline typename distance_result
Chris@102:         <
Chris@102:             Geometry1,
Chris@102:             variant<BOOST_VARIANT_ENUM_PARAMS(T)>,
Chris@102:             Strategy
Chris@102:         >::type
Chris@102:     apply(
Chris@102:         Geometry1 const& geometry1,
Chris@102:         const variant<BOOST_VARIANT_ENUM_PARAMS(T)>& geometry2,
Chris@102:         Strategy const& strategy)
Chris@102:     {
Chris@102:         return apply_visitor(visitor<Strategy>(geometry1, strategy), geometry2);
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: 
Chris@102: template
Chris@102: <
Chris@102:     BOOST_VARIANT_ENUM_PARAMS(typename T1),
Chris@102:     BOOST_VARIANT_ENUM_PARAMS(typename T2)
Chris@102: >
Chris@102: struct distance
Chris@102:     <
Chris@102:         boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)>,
Chris@102:         boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)>
Chris@102:     >
Chris@102: {
Chris@102:     template <typename Strategy>
Chris@102:     struct visitor: static_visitor
Chris@102:         <
Chris@102:             typename distance_result
Chris@102:                 <
Chris@102:                     boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)>,
Chris@102:                     boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)>,
Chris@102:                     Strategy
Chris@102:                 >::type
Chris@102:         >
Chris@102:     {
Chris@102:         Strategy const& m_strategy;
Chris@102: 
Chris@102:         visitor(Strategy const& strategy)
Chris@102:             : m_strategy(strategy)
Chris@102:         {}
Chris@102: 
Chris@102:         template <typename Geometry1, typename Geometry2>
Chris@102:         typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102:         operator()(Geometry1 const& geometry1, Geometry2 const& geometry2) const
Chris@102:         {
Chris@102:             return distance
Chris@102:                 <
Chris@102:                     Geometry1,
Chris@102:                     Geometry2
Chris@102:                 >::template apply
Chris@102:                 <
Chris@102:                     Strategy
Chris@102:                 >(geometry1, geometry2, m_strategy);
Chris@102:         }
Chris@102:     };
Chris@102: 
Chris@102:     template <typename Strategy>
Chris@102:     static inline typename distance_result
Chris@102:         <
Chris@102:             boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)>,
Chris@102:             boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)>,
Chris@102:             Strategy
Chris@102:         >::type
Chris@102:     apply(boost::variant<BOOST_VARIANT_ENUM_PARAMS(T1)> const& geometry1,
Chris@102:           boost::variant<BOOST_VARIANT_ENUM_PARAMS(T2)> const& geometry2,
Chris@102:           Strategy const& strategy)
Chris@102:     {
Chris@102:         return apply_visitor(visitor<Strategy>(strategy), geometry1, geometry2);
Chris@102:     }
Chris@102: };
Chris@102: 
Chris@102: } // namespace resolve_variant
Chris@102: 
Chris@102: 
Chris@102: /*!
Chris@102: \brief \brief_calc2{distance} \brief_strategy
Chris@102: \ingroup distance
Chris@102: \details
Chris@102: \details \details_calc{area}. \brief_strategy. \details_strategy_reasons
Chris@102: 
Chris@102: \tparam Geometry1 \tparam_geometry
Chris@102: \tparam Geometry2 \tparam_geometry
Chris@102: \tparam Strategy \tparam_strategy{Distance}
Chris@102: \param geometry1 \param_geometry
Chris@102: \param geometry2 \param_geometry
Chris@102: \param strategy \param_strategy{distance}
Chris@102: \return \return_calc{distance}
Chris@102: \note The strategy can be a point-point strategy. In case of distance point-line/point-polygon
Chris@102:     it may also be a point-segment strategy.
Chris@102: 
Chris@102: \qbk{distinguish,with strategy}
Chris@102: 
Chris@102: \qbk{
Chris@102: [heading Available Strategies]
Chris@102: \* [link geometry.reference.strategies.strategy_distance_pythagoras Pythagoras (cartesian)]
Chris@102: \* [link geometry.reference.strategies.strategy_distance_haversine Haversine (spherical)]
Chris@102: \* [link geometry.reference.strategies.strategy_distance_cross_track Cross track (spherical\, point-to-segment)]
Chris@102: \* [link geometry.reference.strategies.strategy_distance_projected_point Projected point (cartesian\, point-to-segment)]
Chris@102: \* more (currently extensions): Vincenty\, Andoyer (geographic)
Chris@102: }
Chris@102:  */
Chris@102: 
Chris@102: /*
Chris@102: Note, in case of a Compilation Error:
Chris@102: if you get:
Chris@102:  - "Failed to specialize function template ..."
Chris@102:  - "error: no matching function for call to ..."
Chris@102: for distance, it is probably so that there is no specialization
Chris@102: for return_type<...> for your strategy.
Chris@102: */
Chris@102: template <typename Geometry1, typename Geometry2, typename Strategy>
Chris@102: inline typename distance_result<Geometry1, Geometry2, Strategy>::type
Chris@102: distance(Geometry1 const& geometry1,
Chris@102:          Geometry2 const& geometry2,
Chris@102:          Strategy const& strategy)
Chris@102: {
Chris@102:     concept::check<Geometry1 const>();
Chris@102:     concept::check<Geometry2 const>();
Chris@102: 
Chris@102:     detail::throw_on_empty_input(geometry1);
Chris@102:     detail::throw_on_empty_input(geometry2);
Chris@102: 
Chris@102:     return resolve_variant::distance
Chris@102:                <
Chris@102:                    Geometry1,
Chris@102:                    Geometry2
Chris@102:                >::apply(geometry1, geometry2, strategy);
Chris@102: }
Chris@102: 
Chris@102: 
Chris@102: /*!
Chris@102: \brief \brief_calc2{distance}
Chris@102: \ingroup distance
Chris@102: \details The default strategy is used, corresponding to the coordinate system of the geometries
Chris@102: \tparam Geometry1 \tparam_geometry
Chris@102: \tparam Geometry2 \tparam_geometry
Chris@102: \param geometry1 \param_geometry
Chris@102: \param geometry2 \param_geometry
Chris@102: \return \return_calc{distance}
Chris@102: 
Chris@102: \qbk{[include reference/algorithms/distance.qbk]}
Chris@102:  */
Chris@102: template <typename Geometry1, typename Geometry2>
Chris@102: inline typename default_distance_result<Geometry1, Geometry2>::type
Chris@102: distance(Geometry1 const& geometry1,
Chris@102:          Geometry2 const& geometry2)
Chris@102: {
Chris@102:     concept::check<Geometry1 const>();
Chris@102:     concept::check<Geometry2 const>();
Chris@102: 
Chris@102:     return distance(geometry1, geometry2, default_strategy());
Chris@102: }
Chris@102: 
Chris@102: }} // namespace boost::geometry
Chris@102: 
Chris@102: #endif // BOOST_GEOMETRY_ALGORITHMS_DETAIL_DISTANCE_INTERFACE_HPP