[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1cross__track__point__box.xml]
[section:strategy_distance_cross_track_point_box strategy::distance::cross_track_point_box]
'''strategydistancecross_track_point_box'''
Strategy functor for distance point to box calculation.
[heading Description]
Class which calculates the distance of a point to a box, for points and boxes on a sphere or globe
[heading Synopsis]
``template
class strategy::distance::cross_track_point_box
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Default] [Description]]
[[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 ]]
[[typename Strategy] [haversine] [underlying point-point distance strategy ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``cross_track_point_box()``
] [] [
]]
[[``cross_track_point_box(typename Strategy::radius_type const & r)``
] [] [[* typename Strategy::radius_type const &]: ['r]:
]]
[[``cross_track_point_box(Strategy const & s)``
] [] [[* Strategy const &]: ['s]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``template
return_type< Point, Box >::type apply(Point const & point, Box const & box)``
] [] [[* Point const &]: ['point]:
[* Box const &]: ['box]:
][
]
]
[[``Strategy::radius_type radius()``
] [] [
][
]
]
]
[heading Header]
`#include `
[endsect]