ever_circling_iterator.qbk 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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_1ever__circling__iterator.xml]
  12. [section:ever_circling_iterator ever_circling_iterator]
  13. '''<indexterm><primary>ever_circling_iterator</primary></indexterm>'''
  14. Iterator which ever circles through a range.
  15. [heading Synopsis]
  16. ``template<typename Iterator>
  17. struct ever_circling_iterator
  18. : public detail::iterators::iterator_base< ever_circling_iterator< Iterator >, Iterator >
  19. {
  20. // ...
  21. };
  22. ``
  23. [heading Template parameter(s)]
  24. [table
  25. [[Parameter] [Description]]
  26. [[typename Iterator] [iterator on which this class is based on]]
  27. ]
  28. [heading Constructor(s)]
  29. [table
  30. [[Function] [Description] [Parameters] ]
  31. [[``ever_circling_iterator(Iterator begin, Iterator end, bool skip_first = false)``
  32. ] [] [[* Iterator]: ['begin]:
  33. [* Iterator]: ['end]:
  34. [* bool]: ['skip_first]:
  35. ]]
  36. [[``ever_circling_iterator(Iterator begin, Iterator end, Iterator start,
  37. bool skip_first = false)``
  38. ] [] [[* Iterator]: ['begin]:
  39. [* Iterator]: ['end]:
  40. [* Iterator]: ['start]:
  41. [* bool]: ['skip_first]:
  42. ]]
  43. ]
  44. [heading Member Function(s)]
  45. [table
  46. [[Function] [Description] [Parameters] [Returns]]
  47. [[``void moveto(Iterator it)``
  48. ] [] [[* Iterator]: ['it]:
  49. ][
  50. ]
  51. ]
  52. ]
  53. [heading Header]
  54. `#include <boost/geometry/iterators/ever_circling_iterator.hpp>`
  55. [endsect]