simplify.qbk 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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/group__simplify.xml]
  12. [section:simplify_4_with_strategy simplify (with strategy)]
  13. '''<indexterm><primary>simplify</primary></indexterm>'''
  14. Simplify a geometry using a specified strategy.
  15. [heading Synopsis]
  16. ``template<typename Geometry, typename Distance, typename Strategy>
  17. void simplify(Geometry const & geometry, Geometry & out, Distance const & max_distance,
  18. Strategy const & strategy)``
  19. [heading Parameters]
  20. [table
  21. [[Type] [Concept] [Name] [Description] ]
  22. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
  23. [[Geometry &] [Any type fulfilling a Geometry Concept ] [out] [output geometry, simplified version of the input geometry ]]
  24. [[Distance const &] [A numerical distance measure ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed ]]
  25. [[Strategy const &] [A type fulfilling a SimplifyStrategy concept ] [strategy] [simplify strategy to be used for simplification, might include point-distance strategy]]
  26. ]
  27. [heading Header]
  28. Either
  29. `#include <boost/geometry.hpp>`
  30. Or
  31. `#include <boost/geometry/algorithms/simplify.hpp>`
  32. [endsect]
  33. [section:simplify_3 simplify]
  34. '''<indexterm><primary>simplify</primary></indexterm>'''
  35. Simplify a geometry.
  36. [heading Synopsis]
  37. ``template<typename Geometry, typename Distance>
  38. void simplify(Geometry const & geometry, Geometry & out, Distance const & max_distance)``
  39. [heading Parameters]
  40. [table
  41. [[Type] [Concept] [Name] [Description] ]
  42. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [input geometry, to be simplified ]]
  43. [[Geometry &] [Any type fulfilling a Geometry Concept ] [out] [output geometry, simplified version of the input geometry ]]
  44. [[Distance const &] [numerical type (int, double, ttmath, ...) ] [max_distance] [distance (in units of input coordinates) of a vertex to other segments to be removed]]
  45. ]
  46. [heading Header]
  47. Either
  48. `#include <boost/geometry.hpp>`
  49. Or
  50. `#include <boost/geometry/algorithms/simplify.hpp>`
  51. [include reference/algorithms/simplify.qbk]
  52. [endsect]