line_interpolate_cartesian.qbk 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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_1line__interpolate_1_1cartesian.xml]
  12. [section:strategy_line_interpolate_cartesian strategy::line_interpolate::cartesian]
  13. '''<indexterm><primary>strategy</primary></indexterm><indexterm><primary>line_interpolate</primary></indexterm><indexterm><primary>cartesian</primary></indexterm>'''
  14. Interpolate point on a cartesian segment.
  15. [heading Synopsis]
  16. ``template<typename CalculationType, typename DistanceStrategy>
  17. class strategy::line_interpolate::cartesian
  18. {
  19. // ...
  20. };
  21. ``
  22. [heading Template parameter(s)]
  23. [table
  24. [[Parameter] [Default] [Description]]
  25. [[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 ]]
  26. [[typename DistanceStrategy] [distance::pythagoras<CalculationType>] [The underlying point-point distance strategy]]
  27. ]
  28. [heading Member Function(s)]
  29. [table
  30. [[Function] [Description] [Parameters] [Returns]]
  31. [[``distance_pp_strategy::type get_distance_pp_strategy()``
  32. ] [] [
  33. ][
  34. ]
  35. ]
  36. [[``template<typename Point, typename Fraction, typename Distance>
  37. void apply(Point const & p0, Point const & p1, Fraction const & fraction,
  38. Point & p, Distance const & )``
  39. ] [] [[* Point const &]: ['p0]:
  40. [* Point const &]: ['p1]:
  41. [* Fraction const &]: ['fraction]:
  42. [* Point &]: ['p]:
  43. [* Distance const &]: [']:
  44. ][
  45. ]
  46. ]
  47. ]
  48. [heading Header]
  49. `#include <boost/geometry/strategies/cartesian/line_interpolate.hpp>`
  50. [heading See also]
  51. * [link geometry.reference.algorithms.line_interpolate.line_interpolate_4_with_strategy line_interpolate (with strategy)]
  52. [endsect]