libs/geometry/doc/html/geometry/reference/views/closeable_view.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>closeable_view</title>
   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&#160;1.&#160;Geometry">
   8 <link rel="up" href="../views.html" title="Views">
   9 <link rel="prev" href="segment_view.html" title="segment_view">
  10 <link rel="next" href="reversible_view.html" title="reversible_view">
  11 </head>
  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>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.views.closeable_view"></a><a class="link" href="closeable_view.html" title="closeable_view">closeable_view</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp136957808"></a>
  31 View on a range, either closing it or leaving it as it is.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.views.closeable_view.h0"></a>
  35           <span class="phrase"><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>
  36         </h6>
  37 <p>
  38           The closeable_view is used internally by the library to handle all rings,
  39           either closed or open, the same way. The default method is closed, all
  40           algorithms process rings as if they are closed. Therefore, if they are
  41           opened, a view is created which closes them. The closeable_view might be
  42           used by library users, but its main purpose is internally.
  43         </p>
  44 <h6>
  45 <a name="geometry.reference.views.closeable_view.h1"></a>
  46           <span class="phrase"><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>
  47         </h6>
  48 <p>
  49 </p>
  50 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  51 <span class="keyword">struct</span> <span class="identifier">closeable_view</span>
  52 <span class="special">{</span>
  53   <span class="comment">// ...</span>
  54 <span class="special">};</span>
  55 </pre>
  56 <p>
  57         </p>
  58 <h6>
  59 <a name="geometry.reference.views.closeable_view.h2"></a>
  60           <span class="phrase"><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
  61           parameter(s)</a>
  62         </h6>
  63 <div class="informaltable"><table class="table">
  64 <colgroup>
  65 <col>
  66 <col>
  67 </colgroup>
  68 <thead><tr>
  69 <th>
  70                   <p>
  71                     Parameter
  72                   </p>
  73                 </th>
  74 <th>
  75                   <p>
  76                     Description
  77                   </p>
  78                 </th>
  79 </tr></thead>
  80 <tbody>
  81 <tr>
  82 <td>
  83                   <p>
  84                     typename Range
  85                   </p>
  86                 </td>
  87 <td>
  88                   <p>
  89                     Original range
  90                   </p>
  91                 </td>
  92 </tr>
  93 <tr>
  94 <td>
  95                   <p>
  96                     closure_selector Close
  97                   </p>
  98                 </td>
  99 <td>
 100                   <p>
 101                     Specifies if it the range is closed, if so, nothing will happen.
 102                     If it is open, it will iterate the first point after the last
 103                     point.
 104                   </p>
 105                 </td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 <h6>
 110 <a name="geometry.reference.views.closeable_view.h3"></a>
 111           <span class="phrase"><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>
 112         </h6>
 113 <p>
 114           Either
 115         </p>
 116 <p>
 117           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span></code>
 118         </p>
 119 <p>
 120           Or
 121         </p>
 122 <p>
 123           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span></code>
 124         </p>
 125 </div>
 126 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 127 <td align="left"></td>
 128 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 129       Wulkiewicz, Oracle and/or its affiliates<p>
 130         Distributed under the Boost Software License, Version 1.0. (See accompanying
 131         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>)
 132       </p>
 133 </div></td>
 134 </tr></table>
 135 <hr>
 136 <div class="spirit-nav">
 137 <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>
 138 </div>
 139 </body>
 140 </html>