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_1pythagoras__point__box.xml] 16[section:strategy_distance_pythagoras_point_box strategy::distance::pythagoras_point_box] 17 18'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>pythagoras_point_box</primary></indexterm>''' 19Strategy to calculate the distance between a point and a box. 20 21[heading Synopsis] 22``template<typename CalculationType> 23class strategy::distance::pythagoras_point_box 24{ 25 // ... 26}; 27`` 28 29[heading Template parameter(s)] 30[table 31[[Parameter] [Default] [Description]] 32[[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]] 33] 34 35[heading Member Function(s)] 36[table 37[[Function] [Description] [Parameters] [Returns]] 38[[``template<typename Point, typename Box> 39calculation_type< Point, Box >::type apply(Point const & point, Box const & box)`` 40 41] [applies the distance calculation using pythagoras ] [[* Point const &]: ['point]: point 42 43[* Box const &]: ['box]: box 44 45 46 47][ 48the calculated distance (including taking the square root) 49 50] 51] 52] 53 54[heading Header] 55`#include <boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp>` 56 57[heading Notes] 58[note Can be used for points and boxes with two, three or more dimensions] 59[heading See also] 60[link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)] 61 62[endsect] 63 64