geometry/doc/reference/distance_pythagoras.qbk
Barend Gehrels 8124ca7dce Inspect tool report update
[SVN r67628]
2011-01-03 18:10:53 +00:00

54 lines
1.5 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
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, don't change, it 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]
[heading Synopsis]
``template<typename Point1, typename Point2, typename CalculationType>
class strategy::distance::pythagoras
{
// ...
};
``
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
[[typename Point1] [first point type ]]
[[typename Point2] [optional, second point type, defaults to first point type ]]
[[typename CalculationType] [optional, specify type of calculation ]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point1 const &p1, Point2 const &p2)``
] [] [[* Point1 const &]: ['p1]:
[* Point2 const &]: ['p2]:
]]
]
[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_pythagoras.hpp>`
[endsect]