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

 1[/============================================================================
 2  Boost.Geometry (aka GGL, Generic Geometry Library)
 3
 4  Copyright (c) 2009-2011 Barend Gehrels, Amsterdam, the Netherlands.
 5  Copyright (c) 2009-2011 Mateusz Loskot, London, UK.
 6  Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
 7
 8  Use, modification and distribution is subject to the Boost Software License,
 9  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
10  http://www.boost.org/LICENSE_1_0.txt)
11=============================================================================/]
12
13[include generated/within_status.qbk]
14
15[heading Notes]
16If a point is located exactly on the border of a geometry, the result depends on the strategy.
17The default strategy ([link geometry.reference.strategies.strategy_within_winding Winding (coordinate system agnostic)]) 
18returns false in that case.
19
20If a polygon has a reverse oriented (e.g. counterclockwise for a clockwise typed polygon), the result also depends on the strategy.
21The 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.
22
23[heading Complexity]
24Linear
25