12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- [/============================================================================
- 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__equals.xml]
- [section:equals_3_with_strategy equals (with strategy)]
- '''<indexterm><primary>equals</primary></indexterm>'''
- Checks if a geometry are spatially equal.
- [heading Description]
- The free function equals checks if the first geometry is spatially equal the second geometry. Spatially equal means that the same point set is included. A box can therefore be spatially equal to a ring or a polygon, or a linestring can be spatially equal to a multi-linestring or a segment. This only works theoretically, not all combinations are implemented yet.
- [heading Synopsis]
- ``template<typename Geometry1, typename Geometry2, typename Strategy>
- bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2, 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 ]]
- [[Strategy const &] [Any type fulfilling a Equals Strategy Concept ] [strategy] [The strategy which will be used for equals calculations ]]
- ]
- [heading Returns]
- Returns true if two geometries are spatially equal
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/equals.hpp>`
- [include reference/algorithms/equals.qbk]
- [endsect]
- [section:equals_2 equals]
- '''<indexterm><primary>equals</primary></indexterm>'''
- Checks if a geometry are spatially equal.
- [heading Description]
- The free function equals checks if the first geometry is spatially equal the second geometry. Spatially equal means that the same point set is included. A box can therefore be spatially equal to a ring or a polygon, or a linestring can be spatially equal to a multi-linestring or a segment. This only works theoretically, not all combinations are implemented yet.
- [heading Synopsis]
- ``template<typename Geometry1, typename Geometry2>
- bool equals(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 are spatially equal
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/equals.hpp>`
- [include reference/algorithms/equals.qbk]
- [endsect]
|