EQ2EMu/EQ2/source/depends/boost_1_72_0/libs/geometry/doc/generated/distance_pythagoras_box_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__box__box.xml]
[section:strategy_distance_pythagoras_box_box strategy::distance::pythagoras_box_box]

'''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>pythagoras_box_box</primary></indexterm>'''
Strategy to calculate the distance between two boxes. 

[heading Synopsis]
``template<typename CalculationType>
class strategy::distance::pythagoras_box_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 Box1, typename Box2>
calculation_type< Box1, Box2 >::type apply(Box1 const & box1, Box2 const & box2)``

] [applies the distance calculation using pythagoras_box_box] [[* Box1 const &]: ['box1]:  first box 

[* Box2 const &]: ['box2]:  second box 



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

]
]
]

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

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

[endsect]