distance_projected_point.qbk 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  5. Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
  6. Use, modification and distribution is subject to the Boost Software License,
  7. Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  8. http://www.boost.org/LICENSE_1_0.txt)
  9. =============================================================================/]
  10. [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
  11. [/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1projected__point.xml]
  12. [section:strategy_distance_projected_point strategy::distance::projected_point]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>distance</primary></indexterm><indexterm><primary>projected_point</primary></indexterm>'''
  14. Strategy for distance point to segment.
  15. [heading Description]
  16. Calculates distance using projected-point method, and (optionally) Pythagoras
  17. [heading Synopsis]
  18. ``template<typename CalculationType, typename Strategy>
  19. class strategy::distance::projected_point
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Default] [Description]]
  27. [[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 ]]
  28. [[typename Strategy] [pythagoras<CalculationType>] [underlying point-point distance strategy ]]
  29. ]
  30. [heading Member Function(s)]
  31. [table
  32. [[Function] [Description] [Parameters] [Returns]]
  33. [[``relate_segment_segment_strategy_type get_relate_segment_segment_strategy()``
  34. ] [] [
  35. ][
  36. ]
  37. ]
  38. [[``point_in_geometry_strategy_type get_point_in_geometry_strategy()``
  39. ] [] [
  40. ][
  41. ]
  42. ]
  43. [[``template<typename Point, typename PointOfSegment>
  44. calculation_type< Point, PointOfSegment >::type apply(Point const & p, PointOfSegment const & p1, PointOfSegment const & p2)``
  45. ] [] [[* Point const &]: ['p]:
  46. [* PointOfSegment const &]: ['p1]:
  47. [* PointOfSegment const &]: ['p2]:
  48. ][
  49. ]
  50. ]
  51. [[``template<typename CT>
  52. CT vertical_or_meridian(CT const & lat1, CT const & lat2)``
  53. ] [] [[* CT const &]: ['lat1]:
  54. [* CT const &]: ['lat2]:
  55. ][
  56. ]
  57. ]
  58. ]
  59. [heading Header]
  60. `#include <boost/geometry/strategies/cartesian/distance_projected_point.hpp>`
  61. [heading See also]
  62. [link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)]
  63. [endsect]