EQ2EMu/EQ2/source/depends/boost_1_72_0/libs/geometry/doc/generated/distance_pythagoras_point_box.qbk

[/============================================================================
  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_1pythagoras__point__box.xml]
[section:strategy_distance_pythagoras_point_box strategy::distance::pythagoras_point_box]

'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>pythagoras_point_box</primary></indexterm>'''
Strategy to calculate the distance between a point and a box. 

[heading Synopsis]
``template<typename CalculationType>
class strategy::distance::pythagoras_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]]
]

[heading Member Function(s)]
[table
[[Function] [Description] [Parameters]  [Returns]]
[[``template<typename Point, typename Box>
calculation_type< Point, Box >::type apply(Point const & point, Box const & box)``

] [applies the distance calculation using pythagoras ] [[* Point const &]: ['point]:  point 

[* Box const &]: ['box]:  box 



][
the calculated distance (including taking the square root) 

]
]
]

[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp>`

[heading Notes]
[note Can be used for points and boxes with two, three or more dimensions]
[heading See also]
[link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)]

[endsect]