/Src/Dependencies/Boost/libs/geometry/doc/reference/algorithms/within.qbk

http://hadesmem.googlecode.com/ · text · 25 lines · 18 code · 7 blank · 0 comment · 0 complexity · c545b8396b79995f373f394dd7077ebd MD5 · raw file

  1. [/============================================================================
  2. Boost.Geometry (aka GGL, Generic Geometry Library)
  3. Copyright (c) 2009-2011 Barend Gehrels, Amsterdam, the Netherlands.
  4. Copyright (c) 2009-2011 Mateusz Loskot, London, UK.
  5. Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
  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. [include generated/within_status.qbk]
  11. [heading Notes]
  12. If a point is located exactly on the border of a geometry, the result depends on the strategy.
  13. The default strategy ([link geometry.reference.strategies.strategy_within_winding Winding (coordinate system agnostic)])
  14. returns false in that case.
  15. If a polygon has a reverse oriented (e.g. counterclockwise for a clockwise typed polygon), the result also depends on the strategy.
  16. The default strategy returns still true if a point is completely within the reversed polygon. There is a specific strategy which returns false in this case.
  17. [heading Complexity]
  18. Linear