EQ2EMu/EQ2/source/depends/boost_1_72_0/libs/geometry/doc/generated/relate.qbk

[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
  Copyright (c) 2009-2013 Mateusz Loskot, London, UK.

  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 1.1.1, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__relate.xml]
[section:relate_4_with_strategy relate (with strategy)]

'''<indexterm><primary>relate</primary></indexterm>'''
Checks relation between a pair of geometries defined by a mask. 

[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Mask, typename Strategy>
bool relate(Geometry1 const & geometry1, Geometry2 const & geometry2, Mask const & mask,
            Strategy const & strategy)``

[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 ]]
[[Mask const &] [An intersection model Mask type. ] [mask] [An intersection model mask object. ]]
[[Strategy const &] [Any type fulfilling a Relate Strategy Concept ] [strategy] [The strategy which will be used for relate calculations ]]
]


[heading Returns]
true if the relation is compatible with the mask, false otherwise.

[heading Header]
Either

`#include <boost/geometry.hpp>`


Or

`#include <boost/geometry/algorithms/relate.hpp>`

[include reference/algorithms/relate.qbk]


[endsect]

[section:relate_3 relate]

'''<indexterm><primary>relate</primary></indexterm>'''
Checks relation between a pair of geometries defined by a mask. 

[heading Synopsis]
``template<typename Geometry1, typename Geometry2, typename Mask>
bool relate(Geometry1 const & geometry1, Geometry2 const & geometry2, Mask const & mask)``

[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 ]]
[[Mask const &] [An intersection model Mask type. ] [mask] [An intersection model mask object. ]]
]


[heading Returns]
true if the relation is compatible with the mask, false otherwise.

[heading Header]
Either

`#include <boost/geometry.hpp>`


Or

`#include <boost/geometry/algorithms/relate.hpp>`

[include reference/algorithms/relate.qbk]


[endsect]