libs/geometry/doc/generated/equals.qbk

   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__equals.xml]
  16 [section:equals_3_with_strategy equals (with strategy)]
  17
  18 '''<indexterm><primary>equals</primary></indexterm>'''
  19 Checks if a geometry are spatially equal.
  20
  21 [heading Description]
  22 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.
  23
  24 [heading Synopsis]
  25 ``template<typename Geometry1, typename Geometry2, typename Strategy>
  26 bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2, Strategy const & strategy)``
  27
  28 [heading Parameters]
  29
  30 [table
  31 [[Type] [Concept] [Name] [Description] ]
  32 [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  33 [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  34 [[Strategy const &] [Any type fulfilling a Equals Strategy Concept ] [strategy] [The strategy which will be used for equals calculations ]]
  35 ]
  36
  37
  38 [heading Returns]
  39 Returns true if two geometries are spatially equal
  40
  41 [heading Header]
  42 Either
  43
  44 `#include <boost/geometry.hpp>`
  45
  46
  47 Or
  48
  49 `#include <boost/geometry/algorithms/equals.hpp>`
  50
  51 [include reference/algorithms/equals.qbk]
  52
  53
  54 [endsect]
  55
  56 [section:equals_2 equals]
  57
  58 '''<indexterm><primary>equals</primary></indexterm>'''
  59 Checks if a geometry are spatially equal.
  60
  61 [heading Description]
  62 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.
  63
  64 [heading Synopsis]
  65 ``template<typename Geometry1, typename Geometry2>
  66 bool equals(Geometry1 const & geometry1, Geometry2 const & geometry2)``
  67
  68 [heading Parameters]
  69
  70 [table
  71 [[Type] [Concept] [Name] [Description] ]
  72 [[Geometry1 const &] [Any type fulfilling a Geometry Concept ] [geometry1] [A model of the specified concept ]]
  73 [[Geometry2 const &] [Any type fulfilling a Geometry Concept ] [geometry2] [A model of the specified concept ]]
  74 ]
  75
  76
  77 [heading Returns]
  78 Returns true if two geometries are spatially equal
  79
  80 [heading Header]
  81 Either
  82
  83 `#include <boost/geometry.hpp>`
  84
  85
  86 Or
  87
  88 `#include <boost/geometry/algorithms/equals.hpp>`
  89
  90 [include reference/algorithms/equals.qbk]
  91
  92
  93 [endsect]
  94