Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / concepts_2point_8hpp_source.html
1 <!-- HTML header for doxygen 1.8.13-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7     <meta name="generator" content="Doxygen 1.8.15"/>
8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
9     <title>Generic Image Library: point.hpp Source File</title>
10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
11     <script type="text/javascript" src="jquery.js"></script>
12     <script type="text/javascript" src="dynsections.js"></script>
13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
15   </head>
16   <body>
17     <div class="boost-header">
18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
19         <tr>
20           <td valign="top" width="300">
21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
22           </td>
23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
24           <td></td>
25         </tr>
26       </table>
27     </div>
28     <hr/>
29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30 <!-- Generated by Doxygen 1.8.15 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
41   <ul>
42 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li><li class="navelem"><a class="el" href="dir_65525b100b86579f1f0652bf33388089.html">concepts</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="headertitle">
47 <div class="title">concepts/point.hpp</div>  </div>
48 </div><!--header-->
49 <div class="contents">
50 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef BOOST_GIL_CONCEPTS_POINT_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define BOOST_GIL_CONCEPTS_POINT_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/basic.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/concept_check.hpp&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#pragma GCC diagnostic push</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#pragma GCC diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// Forward declarations</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">class </span>point;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">template</span> &lt;std::<span class="keywordtype">size_t</span> K, <span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;T <span class="keyword">const</span>&amp; axis_value(point&lt;T&gt; <span class="keyword">const</span>&amp; p);</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">template</span> &lt;std::<span class="keywordtype">size_t</span> K, <span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;T&amp; axis_value(point&lt;T&gt;&amp; p);</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> P&gt;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_point_n_d_concept.html">   60</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_point_n_d_concept.html">PointNDConcept</a></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;{</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    {</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        gil_function_requires&lt;Regular&lt;P&gt;&gt;();</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        <span class="keyword">using</span> value_type = <span class="keyword">typename</span> P::value_type;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        ignore_unused_variable_warning(value_type{});</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="keyword">static</span> <span class="keyword">const</span> std::size_t N = P::num_dimensions;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        ignore_unused_variable_warning(N);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        <span class="keyword">using</span> FT = <span class="keyword">typename</span> P::template axis&lt;0&gt;::coord_t;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        <span class="keyword">using</span> LT = <span class="keyword">typename</span> P::template axis&lt;N - 1&gt;::coord_t;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        FT ft = gil::axis_value&lt;0&gt;(<a class="code" href="classboost_1_1gil_1_1point.html">point</a>);</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        axis_value&lt;0&gt;(<a class="code" href="classboost_1_1gil_1_1point.html">point</a>) = ft;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        LT lt = axis_value&lt;N - 1&gt;(<a class="code" href="classboost_1_1gil_1_1point.html">point</a>);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        axis_value&lt;N - 1&gt;(<a class="code" href="classboost_1_1gil_1_1point.html">point</a>) = lt;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        <span class="comment">//value_type v=point[0];</span></div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        <span class="comment">//ignore_unused_variable_warning(v);</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    }</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    P <a class="code" href="classboost_1_1gil_1_1point.html">point</a>;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> P&gt;</div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_point2_d_concept.html">  102</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_point2_d_concept.html">Point2DConcept</a></div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;{</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    {</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        gil_function_requires&lt;PointNDConcept&lt;P&gt;&gt;();</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        static_assert(P::num_dimensions == 2, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <a class="code" href="classboost_1_1gil_1_1point.html">point</a>.x = <a class="code" href="classboost_1_1gil_1_1point.html">point</a>.y;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        <a class="code" href="classboost_1_1gil_1_1point.html">point</a>[0] = <a class="code" href="classboost_1_1gil_1_1point.html">point</a>[1];</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    }</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    P <a class="code" href="classboost_1_1gil_1_1point.html">point</a>;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;};</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;}} <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="preprocessor">#pragma GCC diagnostic pop</span></div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structboost_1_1gil_1_1_point_n_d_concept_html"><div class="ttname"><a href="structboost_1_1gil_1_1_point_n_d_concept.html">boost::gil::PointNDConcept</a></div><div class="ttdoc">N-dimensional point concept.</div><div class="ttdef"><b>Definition:</b> concepts/point.hpp:60</div></div>
51 <div class="ttc" id="structboost_1_1gil_1_1_point2_d_concept_html"><div class="ttname"><a href="structboost_1_1gil_1_1_point2_d_concept.html">boost::gil::Point2DConcept</a></div><div class="ttdoc">2-dimensional point concept</div><div class="ttdef"><b>Definition:</b> concepts/point.hpp:102</div></div>
52 <div class="ttc" id="classboost_1_1gil_1_1point_html"><div class="ttname"><a href="classboost_1_1gil_1_1point.html">boost::gil::point</a></div><div class="ttdoc">2D point both axes of which have the same dimension typeModels: Point2DConcept</div><div class="ttdef"><b>Definition:</b> locator.hpp:28</div></div>
53 </div><!-- fragment --></div><!-- contents -->
54      <!-- HTML footer for doxygen 1.8.13-->
55      <!-- start footer part -->
56      <hr class="footer"/>
57      <address class="footer">
58       <small>
59         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
60       </small>
61     </address>
62   </body>
63 </html>