closeable_view.qbk 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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/structboost_1_1geometry_1_1closeable__view.xml]
  12. [section:closeable_view closeable_view]
  13. '''<indexterm><primary>closeable_view</primary></indexterm>'''
  14. View on a range, either closing it or leaving it as it is.
  15. [heading Description]
  16. The closeable\u005fview is used internally by the library to handle all rings, either closed or open, the same way. The default method is closed, all algorithms process rings as if they are closed. Therefore, if they are opened, a view is created which closes them. The closeable\u005fview might be used by library users, but its main purpose is internally.
  17. [heading Synopsis]
  18. ``template<typename Range, closure_selector Close>
  19. struct closeable_view
  20. {
  21. // ...
  22. };
  23. ``
  24. [heading Template parameter(s)]
  25. [table
  26. [[Parameter] [Description]]
  27. [[typename Range] [Original range ]]
  28. [[closure_selector Close] [Specifies if it the range is closed, if so, nothing will happen. If it is open, it will iterate the first point after the last point. ]]
  29. ]
  30. [heading Header]
  31. Either
  32. `#include <boost/geometry.hpp>`
  33. Or
  34. `#include <boost/geometry/views/closeable_view.hpp>`
  35. [endsect]