1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 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 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/group__relate.xml] 16[section:relate_4_with_strategy relate (with strategy)] 17 18'''<indexterm><primary>relate</primary></indexterm>''' 19Checks relation between a pair of geometries defined by a mask. 20 21[heading Synopsis] 22``template<typename Geometry1, typename Geometry2, typename Mask, typename Strategy> 23bool relate(Geometry1 const & geometry1, Geometry2 const & geometry2, Mask const & mask, 24 Strategy const & strategy)`` 25 26[heading Parameters] 27 28[table 29[[Type] [Concept] [Name] [Description] ] 30[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]] 31[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]] 32[[Mask const &] [An intersection model Mask type. ] [mask] [An intersection model mask object. ]] 33[[Strategy const &] [Any type fulfilling a Relate Strategy Concept ] [strategy] [The strategy which will be used for relate calculations ]] 34] 35 36 37[heading Returns] 38true if the relation is compatible with the mask, false otherwise. 39 40[heading Header] 41Either 42 43`#include <boost/geometry.hpp>` 44 45 46Or 47 48`#include <boost/geometry/algorithms/relate.hpp>` 49 50[include reference/algorithms/relate.qbk] 51 52 53[endsect] 54 55[section:relate_3 relate] 56 57'''<indexterm><primary>relate</primary></indexterm>''' 58Checks relation between a pair of geometries defined by a mask. 59 60[heading Synopsis] 61``template<typename Geometry1, typename Geometry2, typename Mask> 62bool relate(Geometry1 const & geometry1, Geometry2 const & geometry2, Mask const & mask)`` 63 64[heading Parameters] 65 66[table 67[[Type] [Concept] [Name] [Description] ] 68[[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]] 69[[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]] 70[[Mask const &] [An intersection model Mask type. ] [mask] [An intersection model mask object. ]] 71] 72 73 74[heading Returns] 75true if the relation is compatible with the mask, false otherwise. 76 77[heading Header] 78Either 79 80`#include <boost/geometry.hpp>` 81 82 83Or 84 85`#include <boost/geometry/algorithms/relate.hpp>` 86 87[include reference/algorithms/relate.qbk] 88 89 90[endsect] 91 92