geometry/doc/generated/intersects.qbk
Barend Gehrels eb0bc69f56 Doc update
[SVN r69343]
2011-02-27 18:20:28 +00:00

83 lines
2.2 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__intersects.xml]
[section:intersects_2_two_geometries intersects (two geometries)]
Checks if two geometries have at least one intersection.
[heading Synopsis]
``template<typename Geometry1, typename Geometry2>
bool intersects(Geometry1 const & geometry1, Geometry2 const & geometry2)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
]
[heading Returns]
Returns true if two geometries intersect each other
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/intersects.hpp>`
[include reference/algorithms/intersects.qbk]
[endsect]
[section:intersects_1_one_geometry intersects (one geometry)]
Checks if a geometry has at least one intersection (crossing or self-tangency).
[heading Synopsis]
``template<typename Geometry>
bool intersects(Geometry const & geometry)``
[heading Parameters]
[table
[[Type] [Concept] [Name] [Description] ]
[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
]
[heading Returns]
Returns true if the geometry is self-intersecting
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/intersects.hpp>`
[include reference/algorithms/intersects.qbk]
[endsect]