is_empty.qbk 1.3 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/group__is__empty.xml]
  12. [section:is_empty is_empty]
  13. '''<indexterm><primary>is_empty</primary></indexterm>'''
  14. Checks if a geometry is the empty set.
  15. [heading Synopsis]
  16. ``template<typename Geometry>
  17. bool is_empty(Geometry const & geometry)``
  18. [heading Parameters]
  19. [table
  20. [[Type] [Concept] [Name] [Description] ]
  21. [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
  22. ]
  23. [heading Returns]
  24. Returns true if the geometry is the empty set
  25. [heading Header]
  26. Either
  27. `#include <boost/geometry.hpp>`
  28. Or
  29. `#include <boost/geometry/algorithms/is_empty.hpp>`
  30. [include reference/algorithms/is_empty.qbk]
  31. [endsect]