diff options
Diffstat (limited to 'libs/geometry/doc/html/geometry/reference/views')
5 files changed, 982 insertions, 0 deletions
diff --git a/libs/geometry/doc/html/geometry/reference/views/box_view.html b/libs/geometry/doc/html/geometry/reference/views/box_view.html new file mode 100755 index 0000000000..343457093d --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/views/box_view.html @@ -0,0 +1,262 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>box_view</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="../views.html" title="Views"> +<link rel="prev" href="../views.html" title="Views"> +<link rel="next" href="segment_view.html" title="segment_view"> +</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="../views.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="segment_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.views.box_view"></a><a class="link" href="box_view.html" title="box_view">box_view</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id974315"></a> +Makes a box behave like a ring or a range. + </p> +<h6> +<a name="geometry.reference.views.box_view.h0"></a> + <span><a name="geometry.reference.views.box_view.description"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.description">Description</a> + </h6> +<p> + Adapts a box to the Boost.Range concept, enabling the user to iterating + box corners. The box_view is registered as a Ring Concept + </p> +<h6> +<a name="geometry.reference.views.box_view.h1"></a> + <span><a name="geometry.reference.views.box_view.model_of"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.model_of">Model + of</a> + </h6> +<p> + <a class="link" href="../concepts/concept_ring.html" title="Ring Concept">Ring Concept</a> + </p> +<h6> +<a name="geometry.reference.views.box_view.h2"></a> + <span><a name="geometry.reference.views.box_view.synopsis"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.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">Box</span><span class="special">,</span> <span class="keyword">bool</span> <span class="identifier">Clockwise</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">box_view</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.views.box_view.h3"></a> + <span><a name="geometry.reference.views.box_view.template_parameter_s_"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Default + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + typename Box + </p> + </td> +<td> + </td> +<td> + <p> + A type fulfilling the Box Concept + </p> + </td> +</tr> +<tr> +<td> + <p> + bool Clockwise + </p> + </td> +<td> + <p> + true + </p> + </td> +<td> + <p> + If true, walks in clockwise direction, otherwise it walks in + counterclockwise direction + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.views.box_view.h4"></a> + <span><a name="geometry.reference.views.box_view.constructor_s_"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.constructor_s_">Constructor(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">box_view</span><span class="special">(</span><span class="identifier">Box</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">box</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + <p> + Constructor accepting the box to adapt. + </p> + </td> +<td> + <p> + <span class="bold"><strong>Box const &</strong></span>: <span class="emphasis"><em>box</em></span>: + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="geometry.reference.views.box_view.h5"></a> + <span><a name="geometry.reference.views.box_view.header"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.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">views</span><span class="special">/</span><span class="identifier">box_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> +<h6> +<a name="geometry.reference.views.box_view.h6"></a> + <span><a name="geometry.reference.views.box_view.complexity"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.complexity">Complexity</a> + </h6> +<p> + Compile time + </p> +<h6> +<a name="geometry.reference.views.box_view.h7"></a> + <span><a name="geometry.reference.views.box_view.example"></a></span><a class="link" href="box_view.html#geometry.reference.views.box_view.example">Example</a> + </h6> +<p> + Shows usage of the Boost.Range compatible view on a box + </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">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="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">box</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">model</span><span class="special">::</span><span class="identifier">point</span><span class="special"><</span><span class="keyword">double</span><span class="special">,</span> <span class="number">2</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">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">></span> + <span class="special">></span> <span class="identifier">box_type</span><span class="special">;</span> + + <span class="comment">// Define the Boost.Range compatible type:</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">box_view</span><span class="special"><</span><span class="identifier">box_type</span><span class="special">></span> <span class="identifier">box_view</span><span class="special">;</span> + + <span class="identifier">box_type</span> <span class="identifier">box</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">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">4</span><span class="special">,</span> <span class="number">4</span><span class="special">);</span> + + <span class="identifier">box_view</span> <span class="identifier">view</span><span class="special">(</span><span class="identifier">box</span><span class="special">);</span> + + <span class="comment">// Iterating in clockwise direction over the points of this box</span> + <span class="keyword">for</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">box_view</span> <span class="keyword">const</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">view</span><span class="special">);</span> + <span class="identifier">it</span> <span class="special">!=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">view</span><span class="special">);</span> <span class="special">++</span><span class="identifier">it</span><span class="special">)</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">" "</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">it</span><span class="special">);</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="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> + + <span class="comment">// Note that a box_view is tagged as a ring, so supports area etc.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Area: "</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">area</span><span class="special">(</span><span class="identifier">view</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">(0, 0) (0, 4) (4, 4) (4, 0) (0, 0) +Area: 16 +</pre> +</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="../views.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="segment_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/geometry/doc/html/geometry/reference/views/closeable_view.html b/libs/geometry/doc/html/geometry/reference/views/closeable_view.html new file mode 100755 index 0000000000..c843058cf7 --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/views/closeable_view.html @@ -0,0 +1,131 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>closeable_view</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="../views.html" title="Views"> +<link rel="prev" href="segment_view.html" title="segment_view"> +<link rel="next" href="reversible_view.html" title="reversible_view"> +</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="segment_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="reversible_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.views.closeable_view"></a><a class="link" href="closeable_view.html" title="closeable_view">closeable_view</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id977169"></a> +View on a range, either closing it or leaving it as it is. + </p> +<h6> +<a name="geometry.reference.views.closeable_view.h0"></a> + <span><a name="geometry.reference.views.closeable_view.description"></a></span><a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.description">Description</a> + </h6> +<p> + The closeable_view is used internally by the library to handle all rings, + either closed or open, the same way. The default method is closed, all + algorithms process rings as if they are closed. Therefore, if they are + opened, a view is created which closes them. The closeable_view might be + used by library users, but its main purpose is internally. + </p> +<h6> +<a name="geometry.reference.views.closeable_view.h1"></a> + <span><a name="geometry.reference.views.closeable_view.synopsis"></a></span><a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.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">Range</span><span class="special">,</span> <span class="identifier">closure_selector</span> <span class="identifier">Close</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">closeable_view</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.views.closeable_view.h2"></a> + <span><a name="geometry.reference.views.closeable_view.template_parameter_s_"></a></span><a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + typename Range + </p> + </td> +<td> + <p> + Original range + </p> + </td> +</tr> +<tr> +<td> + <p> + closure_selector Close + </p> + </td> +<td> + <p> + Specifies if it the range is closed, if so, nothing will happen. + If it is open, it will iterate the first point after the last + point. + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.views.closeable_view.h3"></a> + <span><a name="geometry.reference.views.closeable_view.header"></a></span><a class="link" href="closeable_view.html#geometry.reference.views.closeable_view.header">Header</a> + </h6> +<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">views</span><span class="special">/</span><span class="identifier">closeable_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </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="segment_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="reversible_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/geometry/doc/html/geometry/reference/views/identity_view.html b/libs/geometry/doc/html/geometry/reference/views/identity_view.html new file mode 100755 index 0000000000..75069b2a95 --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/views/identity_view.html @@ -0,0 +1,236 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>identity_view</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="../views.html" title="Views"> +<link rel="prev" href="reversible_view.html" title="reversible_view"> +<link rel="next" href="../../release_notes.html" title="Release Notes"> +</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="reversible_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="../../release_notes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.views.identity_view"></a><a class="link" href="identity_view.html" title="identity_view">identity_view</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id977836"></a> +View on a range, not modifying anything. + </p> +<h6> +<a name="geometry.reference.views.identity_view.h0"></a> + <span><a name="geometry.reference.views.identity_view.synopsis"></a></span><a class="link" href="identity_view.html#geometry.reference.views.identity_view.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">Range</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">identity_view</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.views.identity_view.h1"></a> + <span><a name="geometry.reference.views.identity_view.template_parameter_s_"></a></span><a class="link" href="identity_view.html#geometry.reference.views.identity_view.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> + typename Range + </p> + </td> +<td> + <p> + original range + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="geometry.reference.views.identity_view.h2"></a> + <span><a name="geometry.reference.views.identity_view.constructor_s_"></a></span><a class="link" href="identity_view.html#geometry.reference.views.identity_view.constructor_s_">Constructor(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">identity_view</span><span class="special">(</span><span class="identifier">Range</span> <span class="special">&</span> <span class="identifier">r</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + <p> + <span class="bold"><strong>Range &</strong></span>: <span class="emphasis"><em>r</em></span>: + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="geometry.reference.views.identity_view.h3"></a> + <span><a name="geometry.reference.views.identity_view.member_function_s_"></a></span><a class="link" href="identity_view.html#geometry.reference.views.identity_view.member_function_s_">Member + Function(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +<th> + <p> + Returns + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">const_iterator</span> <span class="identifier">begin</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">const_iterator</span> <span class="identifier">end</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">iterator</span> <span class="identifier">begin</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +<tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">iterator</span> <span class="identifier">end</span><span class="special">()</span></pre> +<p> + </p> + </td> +<td> + </td> +<td> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.views.identity_view.h4"></a> + <span><a name="geometry.reference.views.identity_view.header"></a></span><a class="link" href="identity_view.html#geometry.reference.views.identity_view.header">Header</a> + </h6> +<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">views</span><span class="special">/</span><span class="identifier">identity_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </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="reversible_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="../../release_notes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/geometry/doc/html/geometry/reference/views/reversible_view.html b/libs/geometry/doc/html/geometry/reference/views/reversible_view.html new file mode 100755 index 0000000000..b4ce0e464c --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/views/reversible_view.html @@ -0,0 +1,118 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>reversible_view</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="../views.html" title="Views"> +<link rel="prev" href="closeable_view.html" title="closeable_view"> +<link rel="next" href="identity_view.html" title="identity_view"> +</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="closeable_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="identity_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.views.reversible_view"></a><a class="link" href="reversible_view.html" title="reversible_view">reversible_view</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id977523"></a> +View on a range, reversing direction if necessary. + </p> +<h6> +<a name="geometry.reference.views.reversible_view.h0"></a> + <span><a name="geometry.reference.views.reversible_view.synopsis"></a></span><a class="link" href="reversible_view.html#geometry.reference.views.reversible_view.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">Range</span><span class="special">,</span> <span class="identifier">iterate_direction</span> <span class="identifier">Direction</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">reversible_view</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.views.reversible_view.h1"></a> + <span><a name="geometry.reference.views.reversible_view.template_parameter_s_"></a></span><a class="link" href="reversible_view.html#geometry.reference.views.reversible_view.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + typename Range + </p> + </td> +<td> + <p> + original range + </p> + </td> +</tr> +<tr> +<td> + <p> + iterate_direction Direction + </p> + </td> +<td> + <p> + direction of iteration + </p> + </td> +</tr> +</tbody> +</table></div> +<h6> +<a name="geometry.reference.views.reversible_view.h2"></a> + <span><a name="geometry.reference.views.reversible_view.header"></a></span><a class="link" href="reversible_view.html#geometry.reference.views.reversible_view.header">Header</a> + </h6> +<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">views</span><span class="special">/</span><span class="identifier">reversible_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </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="closeable_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="identity_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/libs/geometry/doc/html/geometry/reference/views/segment_view.html b/libs/geometry/doc/html/geometry/reference/views/segment_view.html new file mode 100755 index 0000000000..2448423fb1 --- /dev/null +++ b/libs/geometry/doc/html/geometry/reference/views/segment_view.html @@ -0,0 +1,235 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>segment_view</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="../views.html" title="Views"> +<link rel="prev" href="box_view.html" title="box_view"> +<link rel="next" href="closeable_view.html" title="closeable_view"> +</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="box_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="closeable_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="geometry.reference.views.segment_view"></a><a class="link" href="segment_view.html" title="segment_view">segment_view</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="id975768"></a> +Makes a segment behave like a linestring or a range. + </p> +<h6> +<a name="geometry.reference.views.segment_view.h0"></a> + <span><a name="geometry.reference.views.segment_view.description"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.description">Description</a> + </h6> +<p> + Adapts a segment to the Boost.Range concept, enabling the user to iterate + the two segment points. The segment_view is registered as a LineString + Concept + </p> +<h6> +<a name="geometry.reference.views.segment_view.h1"></a> + <span><a name="geometry.reference.views.segment_view.model_of"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.model_of">Model + of</a> + </h6> +<p> + <a class="link" href="../concepts/concept_linestring.html" title="Linestring Concept">LineString + Concept</a> + </p> +<h6> +<a name="geometry.reference.views.segment_view.h2"></a> + <span><a name="geometry.reference.views.segment_view.synopsis"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.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">Segment</span><span class="special">></span> +<span class="keyword">struct</span> <span class="identifier">segment_view</span> +<span class="special">{</span> + <span class="comment">// ...</span> +<span class="special">};</span> +</pre> +<p> + </p> +<h6> +<a name="geometry.reference.views.segment_view.h3"></a> + <span><a name="geometry.reference.views.segment_view.template_parameter_s_"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.template_parameter_s_">Template + parameter(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Parameter + </p> + </th> +<th> + <p> + Description + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> + typename Segment + </p> + </td> +<td> + <p> + A type fulfilling the Segment Concept + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="geometry.reference.views.segment_view.h4"></a> + <span><a name="geometry.reference.views.segment_view.constructor_s_"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.constructor_s_">Constructor(s)</a> + </h6> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Description + </p> + </th> +<th> + <p> + Parameters + </p> + </th> +</tr></thead> +<tbody><tr> +<td> + <p> +</p> +<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">segment_view</span><span class="special">(</span><span class="identifier">Segment</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">segment</span><span class="special">)</span></pre> +<p> + </p> + </td> +<td> + <p> + Constructor accepting the segment to adapt. + </p> + </td> +<td> + <p> + <span class="bold"><strong>Segment const &</strong></span>: <span class="emphasis"><em>segment</em></span>: + </p> + </td> +</tr></tbody> +</table></div> +<h6> +<a name="geometry.reference.views.segment_view.h5"></a> + <span><a name="geometry.reference.views.segment_view.header"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.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">views</span><span class="special">/</span><span class="identifier">segment_view</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> + </p> +<h6> +<a name="geometry.reference.views.segment_view.h6"></a> + <span><a name="geometry.reference.views.segment_view.complexity"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.complexity">Complexity</a> + </h6> +<p> + Compile time + </p> +<h6> +<a name="geometry.reference.views.segment_view.h7"></a> + <span><a name="geometry.reference.views.segment_view.example"></a></span><a class="link" href="segment_view.html#geometry.reference.views.segment_view.example">Example</a> + </h6> +<p> + Shows usage of the Boost.Range compatible view on a box + </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">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="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">segment</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">model</span><span class="special">::</span><span class="identifier">point</span><span class="special"><</span><span class="keyword">double</span><span class="special">,</span> <span class="number">2</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">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">></span> + <span class="special">></span> <span class="identifier">segment_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">segment_view</span><span class="special"><</span><span class="identifier">segment_type</span><span class="special">></span> <span class="identifier">segment_view</span><span class="special">;</span> + + <span class="identifier">segment_type</span> <span class="identifier">segment</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">assign_values</span><span class="special">(</span><span class="identifier">segment</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">1</span><span class="special">,</span> <span class="number">1</span><span class="special">);</span> + + <span class="identifier">segment_view</span> <span class="identifier">view</span><span class="special">(</span><span class="identifier">segment</span><span class="special">);</span> + + <span class="comment">// Iterating over the points of this segment</span> + <span class="keyword">for</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_iterator</span><span class="special"><</span><span class="identifier">segment_view</span> <span class="keyword">const</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">view</span><span class="special">);</span> + <span class="identifier">it</span> <span class="special">!=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">end</span><span class="special">(</span><span class="identifier">view</span><span class="special">);</span> <span class="special">++</span><span class="identifier">it</span><span class="special">)</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">" "</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">it</span><span class="special">);</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="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> + + <span class="comment">// Note that a segment_view is tagged as a linestring, so supports length etc.</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Length: "</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">length</span><span class="special">(</span><span class="identifier">view</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">(0, 0) (0, 4) (4, 4) (4, 0) (0, 0) +Area: 16 +</pre> +</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="box_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../views.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="closeable_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |