1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1cross__track__point__box.xml] 16[section:strategy_distance_cross_track_point_box strategy::distance::cross_track_point_box] 17 18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>cross_track_point_box</primary></indexterm>''' 19Strategy functor for distance point to box calculation. 20 21[heading Description] 22Class which calculates the distance of a point to a box, for points and boxes on a sphere or globe 23 24[heading Synopsis] 25``template<typename CalculationType, typename Strategy> 26class strategy::distance::cross_track_point_box 27{ 28 // ... 29}; 30`` 31 32[heading Template parameter(s)] 33[table 34[[Parameter] [Default] [Description]] 35[[typename CalculationType] [void] [numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point ]] 36[[typename Strategy] [haversine<double, CalculationType>] [underlying point-point distance strategy ]] 37] 38 39[heading Constructor(s)] 40[table 41[[Function] [Description] [Parameters] ] 42[[``cross_track_point_box()`` 43 44] [] [ 45 46]] 47[[``cross_track_point_box(typename Strategy::radius_type const & r)`` 48 49] [] [[* typename Strategy::radius_type const &]: ['r]: 50 51 52 53]] 54[[``cross_track_point_box(Strategy const & s)`` 55 56] [] [[* Strategy const &]: ['s]: 57 58 59 60]] 61] 62 63[heading Member Function(s)] 64[table 65[[Function] [Description] [Parameters] [Returns]] 66[[``template<typename Point, typename Box> 67return_type< Point, Box >::type apply(Point const & point, Box const & box)`` 68 69] [] [[* Point const &]: ['point]: 70 71[* Box const &]: ['box]: 72 73 74 75][ 76 77] 78] 79[[``Strategy::radius_type radius()`` 80 81] [] [ 82 83][ 84 85] 86] 87] 88 89[heading Header] 90`#include <boost/geometry/strategies/spherical/distance_cross_track_point_box.hpp>` 91 92[endsect] 93 94