3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../../index.html" title="Chapter 1. Geometry">
8 <link rel="up" href="../algorithms.html" title="Algorithms">
9 <link rel="prev" href="envelope/return_envelope.html" title="return_envelope">
10 <link rel="next" href="expand.html" title="expand">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="envelope/return_envelope.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expand.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="geometry.reference.algorithms.equals"></a><a class="link" href="equals.html" title="equals">equals</a>
28 </h4></div></div></div>
30 <a class="indexterm" name="idp116065072"></a>
31 Checks if a geometry are spatially equal.
34 <a name="geometry.reference.algorithms.equals.h0"></a>
35 <span class="phrase"><a name="geometry.reference.algorithms.equals.description"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.description">Description</a>
38 The free function equals checks if the first geometry is spatially equal
39 the second geometry. Spatially equal means that the same point set is included.
40 A box can therefore be spatially equal to a ring or a polygon, or a linestring
41 can be spatially equal to a multi-linestring or a segment. This only works
42 theoretically, not all combinations are implemented yet.
45 <a name="geometry.reference.algorithms.equals.h1"></a>
46 <span class="phrase"><a name="geometry.reference.algorithms.equals.synopsis"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.synopsis">Synopsis</a>
50 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Geometry1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry2</span><span class="special">></span>
51 <span class="keyword">bool</span> <span class="identifier">equals</span><span class="special">(</span><span class="identifier">Geometry1</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry2</span><span class="special">)</span></pre>
55 <a name="geometry.reference.algorithms.equals.h2"></a>
56 <span class="phrase"><a name="geometry.reference.algorithms.equals.parameters"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.parameters">Parameters</a>
58 <div class="informaltable"><table class="table">
96 Any type fulfilling a Geometry Concept
106 A model of the specified concept
113 Geometry2 const &
118 Any type fulfilling a Geometry Concept
128 A model of the specified concept
135 <a name="geometry.reference.algorithms.equals.h3"></a>
136 <span class="phrase"><a name="geometry.reference.algorithms.equals.returns"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.returns">Returns</a>
139 Returns true if two geometries are spatially equal
142 <a name="geometry.reference.algorithms.equals.h4"></a>
143 <span class="phrase"><a name="geometry.reference.algorithms.equals.header"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.header">Header</a>
149 <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
155 <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">algorithms</span><span class="special">/</span><span class="identifier">equals</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
158 <a name="geometry.reference.algorithms.equals.h5"></a>
159 <span class="phrase"><a name="geometry.reference.algorithms.equals.conformance"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.conformance">Conformance</a>
162 The function equals implements function Equals from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
163 Simple Feature Specification</a>.
166 <a name="geometry.reference.algorithms.equals.h6"></a>
167 <span class="phrase"><a name="geometry.reference.algorithms.equals.supported_geometries"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.supported_geometries">Supported
170 <div class="informaltable"><table class="table">
247 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
252 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
257 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
262 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
267 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
272 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
277 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
282 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
287 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
292 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
304 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
309 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
314 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
319 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
324 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
329 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
334 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
339 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
344 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
349 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
361 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
366 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
371 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
376 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
381 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
386 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
391 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
396 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
401 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
406 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
418 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
423 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
428 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
433 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
438 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
443 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
448 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
453 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
458 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
463 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
475 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
480 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
485 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
490 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
495 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
500 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
505 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
510 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
515 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
520 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
532 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
537 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
542 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
547 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
552 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
557 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
562 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
567 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
572 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
577 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
589 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
594 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
599 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
604 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
609 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
614 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
619 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
624 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
629 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
634 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
646 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
651 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
656 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
661 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
666 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
671 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
676 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
681 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
686 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
691 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
703 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
708 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
713 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
718 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
723 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
728 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
733 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
738 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
743 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
748 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
760 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
765 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
770 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
775 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
780 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
785 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
790 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
795 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
800 <span class="inlinemediaobject"><img src="../../../img/nyi.png" alt="nyi"></span>
805 <span class="inlinemediaobject"><img src="../../../img/ok.png" alt="ok"></span>
812 <a name="geometry.reference.algorithms.equals.h7"></a>
813 <span class="phrase"><a name="geometry.reference.algorithms.equals.complexity"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.complexity">Complexity</a>
819 <a name="geometry.reference.algorithms.equals.h8"></a>
820 <span class="phrase"><a name="geometry.reference.algorithms.equals.example"></a></span><a class="link" href="equals.html#geometry.reference.algorithms.equals.example">Example</a>
823 Shows the predicate equals, which returns true if two geometries are spatially
828 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
830 <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
831 <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
832 <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">adapted</span><span class="special">/</span><span class="identifier">boost_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
834 <span class="identifier">BOOST_GEOMETRY_REGISTER_BOOST_TUPLE_CS</span><span class="special">(</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">)</span>
836 <span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
838 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
839 <span class="special">{</span>
840 <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">::</span><span class="identifier">tuple_list_of</span><span class="special">;</span>
842 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">></span> <span class="identifier">point</span><span class="special">;</span>
844 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span><span class="special"><</span><span class="identifier">point</span><span class="special">></span> <span class="identifier">poly1</span><span class="special">,</span> <span class="identifier">poly2</span><span class="special">;</span>
845 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">tuple_list_of</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">)(</span><span class="number">0</span><span class="special">,</span> <span class="number">5</span><span class="special">)(</span><span class="number">5</span><span class="special">,</span> <span class="number">5</span><span class="special">)(</span><span class="number">5</span><span class="special">,</span> <span class="number">0</span><span class="special">)(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">);</span>
846 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">exterior_ring</span><span class="special">(</span><span class="identifier">poly2</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">tuple_list_of</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="number">0</span><span class="special">)(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">)(</span><span class="number">0</span><span class="special">,</span> <span class="number">5</span><span class="special">)(</span><span class="number">5</span><span class="special">,</span> <span class="number">5</span><span class="special">)(</span><span class="number">5</span><span class="special">,</span> <span class="number">0</span><span class="special">);</span>
848 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span>
849 <span class="special"><<</span> <span class="string">"polygons are spatially "</span>
850 <span class="special"><<</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">equals</span><span class="special">(</span><span class="identifier">poly1</span><span class="special">,</span> <span class="identifier">poly2</span><span class="special">)</span> <span class="special">?</span> <span class="string">"equal"</span> <span class="special">:</span> <span class="string">"not equal"</span><span class="special">)</span>
851 <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
853 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">box</span><span class="special"><</span><span class="identifier">point</span><span class="special">></span> <span class="identifier">box</span><span class="special">;</span>
854 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">assign_values</span><span class="special">(</span><span class="identifier">box</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">5</span><span class="special">);</span>
856 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span>
857 <span class="special"><<</span> <span class="string">"polygon and box are spatially "</span>
858 <span class="special"><<</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">equals</span><span class="special">(</span><span class="identifier">box</span><span class="special">,</span> <span class="identifier">poly2</span><span class="special">)</span> <span class="special">?</span> <span class="string">"equal"</span> <span class="special">:</span> <span class="string">"not equal"</span><span class="special">)</span>
859 <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
862 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
863 <span class="special">}</span>
870 <pre class="programlisting">polygons are spatially equal
871 polygon and box are spatially equal
874 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
875 <td align="left"></td>
876 <td align="right"><div class="copyright-footer">Copyright © 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
877 Wulkiewicz, Oracle and/or its affiliates<p>
878 Distributed under the Boost Software License, Version 1.0. (See accompanying
879 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
884 <div class="spirit-nav">
885 <a accesskey="p" href="envelope/return_envelope.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expand.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>