123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 |
- [/============================================================================
- 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.xml]
- [section:strategy_distance_pythagoras strategy::distance::pythagoras]
- '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>pythagoras</primary></indexterm>'''
- Strategy to calculate the distance between two points.
- [heading Synopsis]
- ``template<typename CalculationType>
- class strategy::distance::pythagoras
- {
- // ...
- };
- ``
- [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 P1, typename P2>
- calculation_type< P1, P2 >::type apply(P1 const & p1, P2 const & p2)``
- ] [applies the distance calculation using pythagoras ] [[* P1 const &]: ['p1]: first point
- [* P2 const &]: ['p2]: second point
- ][
- the calculated distance (including taking the square root)
- ]
- ]
- ]
- [heading Header]
- `#include <boost/geometry/strategies/cartesian/distance_pythagoras.hpp>`
- [heading Notes]
- [note Can be used for points with two, three or more dimensions]
- [heading See also]
- [link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)]
- [endsect]
|