diff options
Diffstat (limited to 'libs/geometry/doc/html/geometry/reference/algorithms/centroid/centroid_2.html')
| -rwxr-xr-x | libs/geometry/doc/html/geometry/reference/algorithms/centroid/centroid_2.html | 516 |
1 files changed, 516 insertions, 0 deletions
diff --git a/libs/geometry/doc/html/geometry/reference/algorithms/centroid/centroid_2.html b/libs/geometry/doc/html/geometry/reference/algorithms/centroid/centroid_2.html new file mode 100755 index 0000000000..a170e59970 --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/algorithms/centroid/centroid_2.html @@ -0,0 +1,516 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>centroid</title> +<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../../../index.html" title="Chapter 1. Geometry"> +<link rel="up" href="../centroid.html" title="centroid"> +<link rel="prev" href="centroid_3_with_strategy.html" title="centroid (with strategy)"> +<link rel="next" href="return_centroid_1.html" title="return_centroid"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="centroid_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../centroid.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="return_centroid_1.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="geometry.reference.algorithms.centroid.centroid_2"></a><a class="link" href="centroid_2.html" title="centroid">centroid</a> +</h5></div></div></div> +<p> + <a class="indexterm" name="id839502"></a> +Calculates the centroid of a geometry. + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h0"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.description"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.description">Description</a> + </h6> +<p> + The free function centroid calculates the geometric center (or: center + of mass) of a geometry. It uses the default strategy, based on the coordinate + system of the geometry. + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h1"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.synopsis"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.synopsis">Synopsis</a> + </h6> +<p> +</p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Point</span><span class="special">></span> +<span class="keyword">void</span> <span class="identifier">centroid</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry</span><span class="special">,</span> <span class="identifier">Point</span> <span class="special">&</span> <span class="identifier">c</span><span class="special">)</span></pre> +<p> + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h2"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.parameters"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.parameters">Parameters</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Type + </p> + </th> +<th> + <p> + Concept + </p> + </th> +<th> + <p> + Name + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Geometry const & + </p> + </td> +<td> + <p> + Any type fulfilling a Geometry Concept + </p> + </td> +<td> + <p> + geometry + </p> + </td> +<td> + <p> + A model of the specified concept + </p> + </td> +</tr> +<tr> +<td> + <p> + Point & + </p> + </td> +<td> + <p> + Any type fulfilling a Point Concept + </p> + </td> +<td> + <p> + c + </p> + </td> +<td> + <p> + The calculated centroid will be assigned to this point reference + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h3"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.header"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.header">Header</a> + </h6> +<p> + Either + </p> +<p> + <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">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> +<p> + Or + </p> +<p> + <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">centroid</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h4"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.conformance"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.conformance">Conformance</a> + </h6> +<p> + The function centroid implements function Centroid from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC + Simple Feature Specification</a>. + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h5"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.behavior"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.behavior">Behavior</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Case + </p> + </th> +<th> + <p> + Behavior + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Point + </p> + </td> +<td> + <p> + Returns the point itself as the centroid + </p> + </td> +</tr> +<tr> +<td> + <p> + Multi Point + </p> + </td> +<td> + <p> + Calculates centroid (based on average) + </p> + </td> +</tr> +<tr> +<td> + <p> + linear (e.g. linestring) + </p> + </td> +<td> + <p> + Calculates centroid (based on weighted length) + </p> + </td> +</tr> +<tr> +<td> + <p> + areal (e.g. polygon) + </p> + </td> +<td> + <p> + Calculates centroid + </p> + </td> +</tr> +<tr> +<td> + <p> + Empty (e.g. polygon without points) + </p> + </td> +<td> + <p> + Throws a <a class="link" href="../../exceptions/centroid_exception.html" title="centroid_exception">centroid_exception</a> + </p> + </td> +</tr> +<tr> +<td> + <p> + Cartesian + </p> + </td> +<td> + <p> + Implemented + </p> + </td> +</tr> +<tr> +<td> + <p> + Spherical + </p> + </td> +<td> + <p> + Calculates the centroid as if based on Cartesian coordinates + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h6"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.supported_geometries"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.supported_geometries">Supported + geometries</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + </th> +<th> + <p> + 2D + </p> + </th> +<th> + <p> + 3D + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + Point + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + Segment + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + Box + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + Linestring + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + Ring + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + Polygon + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + MultiPoint + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + MultiLinestring + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + MultiPolygon + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span> + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span> + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h7"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.complexity"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.complexity">Complexity</a> + </h6> +<p> + Linear + </p> +<h6> +<a name="geometry.reference.algorithms.centroid.centroid_2.h8"></a> + <span><a name="geometry.reference.algorithms.centroid.centroid_2.example"></a></span><a class="link" href="centroid_2.html#geometry.reference.algorithms.centroid.centroid_2.example">Example</a> + </h6> +<p> + Shows calculation of a centroid of a polygon + </p> +<p> +</p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> +<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">list</span><span class="special">></span> + +<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> +<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">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> +<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> + +<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">io</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> + + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> +<span class="special">{</span> + <span class="keyword">typedef</span> <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">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">point_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <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_type</span><span class="special">></span> <span class="identifier">polygon_type</span><span class="special">;</span> + + <span class="identifier">polygon_type</span> <span class="identifier">poly</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">read_wkt</span><span class="special">(</span> + <span class="string">"POLYGON((2 1.3,2.4 1.7,2.8 1.8,3.4 1.2,3.7 1.6,3.4 2,4.1 3,5.3 2.6,5.4 1.2,4.9 0.8,2.9 0.7,2 1.3)"</span> + <span class="string">"(4.0 2.0, 4.2 1.4, 4.8 1.9, 4.4 2.2, 4.0 2.0))"</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">);</span> + + <span class="identifier">point_type</span> <span class="identifier">p</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">centroid</span><span class="special">(</span><span class="identifier">poly</span><span class="special">,</span> <span class="identifier">p</span><span class="special">);</span> + + <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"centroid: "</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">dsv</span><span class="special">(</span><span class="identifier">p</span><span class="special">)</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> + + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + </p> +<p> + Output: + </p> +<pre class="programlisting">centroid: (4.04663, 1.6349) +<img src="../../../../img/algorithms/centroid.png" alt="centroid"> +</pre> +<p> + Note that the centroid might be located in a hole or outside a polygon, + easily. + </p> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2009-2012 Barend + Gehrels, Bruno Lalande, Mateusz Loskot<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="centroid_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../centroid.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="return_centroid_1.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |