num_points.qbk 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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__num__points.xml]
  12. [section:num_points num_points]
  13. '''<indexterm><primary>num_points</primary></indexterm>'''
  14. Calculates the number of points of a geometry.
  15. [heading Description]
  16. The free function num\u005fpoints calculates the number of points of a geometry.
  17. [heading Synopsis]
  18. ``template<typename Geometry>
  19. std::size_t num_points(Geometry const & geometry, bool add_for_open = false)``
  20. [heading Parameters]
  21. [table
  22. [[Type] [Concept] [Name] [Description] ]
  23. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
  24. [[bool] [] [add_for_open] [add one for open geometries (i.e. polygon types which are not closed) ]]
  25. ]
  26. [heading Returns]
  27. The calculated number of points
  28. [heading Header]
  29. Either
  30. `#include <boost/geometry.hpp>`
  31. Or
  32. `#include <boost/geometry/algorithms/num_points.hpp>`
  33. [include reference/algorithms/num_points.qbk]
  34. [endsect]