multi_point.qbk 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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_1model_1_1multi__point.xml]
  12. [section:model_multi_point model::multi_point]
  13. '''<indexterm><primary>model</primary></indexterm><indexterm><primary>multi_point</primary></indexterm>'''
  14. multi_point, a collection of points
  15. [heading Model of]
  16. [link geometry.reference.concepts.concept_multi_point MultiPoint Concept]
  17. [heading Synopsis]
  18. ``template<typename Point, template< typename, typename > class Container, template< typename > class Allocator>
  19. class model::multi_point
  20. : public Container< Point, Allocator< Point > >
  21. {
  22. // ...
  23. };
  24. ``
  25. [heading Template parameter(s)]
  26. [table
  27. [[Parameter] [Default] [Description]]
  28. [[typename Point] [] [Any type fulfilling a Point Concept ]]
  29. [[template< typename, typename > class Container] [std::vector] [container type, for example std::vector, std::deque ]]
  30. [[template< typename > class Allocator] [std::allocator] [container-allocator-type]]
  31. ]
  32. [heading Constructor(s)]
  33. [table
  34. [[Function] [Description] [Parameters] ]
  35. [[``multi_point()``
  36. ] [Default constructor, creating an empty multi_point. ] [
  37. ]]
  38. [[``template<typename Iterator>
  39. multi_point(Iterator begin, Iterator end)``
  40. ] [Constructor with begin and end, filling the multi_point. ] [[* Iterator]: ['begin]:
  41. [* Iterator]: ['end]:
  42. ]]
  43. [[``multi_point(std::initializer_list< Point > l)``
  44. ] [Constructor taking std::initializer_list, filling the multi_point. ] [[* std::initializer_list< Point >]: ['l]:
  45. ]]
  46. ]
  47. [heading Header]
  48. Either
  49. `#include <boost/geometry/geometries/geometries.hpp>`
  50. Or
  51. `#include <boost/geometry/geometries/multi_point.hpp>`
  52. [include reference/geometries/multi_point.qbk]
  53. [endsect]