Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59 Pull Requests 0 Wiki
Tree: 9574459e57
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
gil
/
doc
/
html
/
design
/
concepts.html

concepts.html 10 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 
  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    4. 

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    5. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>Concepts - Boost.GIL  documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
    12. 

  12.     <script type="text/javascript">
    13. 

  13.       var DOCUMENTATION_OPTIONS = {
    14. 

  14.           URL_ROOT:    '../',
    15. 

  15.           VERSION:     '',
    16. 

  16.           COLLAPSE_MODINDEX: false,
    17. 

  17.           FILE_SUFFIX: '.html'
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="../_static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="../_static/underscore.js"></script>
    22. 

  22.     <script type="text/javascript" src="../_static/doctools.js"></script>
    23. 

  23.     <link rel="index" title="Index" href="../genindex.html" />
    24. 

  24.     <link rel="search" title="Search" href="../search.html" />
    25. 

  25.     <link rel="top" title="Boost.GIL  documentation" href="../index.html" />
    26. 

  26.     <link rel="up" title="Design Guide" href="index.html" />
    27. 

  27.     <link rel="next" title="Point" href="point.html" />
    28. 

  28.     <link rel="prev" title="Basics" href="basics.html" /> 
    29. 

  29.   </head>
    30. 

  30.   <body>
    31. 

  31.     <div class="header">
    32. 

  32.     <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
    33. 

  33.     "header">
    34. 

  34.       <tr>
    35. 

  35.         <td valign="top" width="300">
    36. 

  36.           <h3><a href="../index.html"><img
    37. 

  37.           alt="C++ Boost" src="../_static/gil.png" border="0"></a></h3>
    38. 

  38.         </td>
    39. 

  39. 

  40.         <td >
    41. 

  41.           <h1 align="center"><a href="../index.html"></a></h1>
    42. 

  42.         </td>
    43. 

  43. 	<td>
    44. 

  44.       <div id="searchbox" style="display: none">
    45. 

  45.         <form class="search" action="../search.html" method="get">
    46. 

  46.           <input type="text" name="q" size="18" />
    47. 

  47.           <input type="submit" value="Search" />
    48. 

  48.           <input type="hidden" name="check_keywords" value="yes" />
    49. 

  49.           <input type="hidden" name="area" value="default" />
    50. 

  50.         </form>
    51. 

  51.       </div>
    52. 

  52.       <script type="text/javascript">$('#searchbox').show(0);</script>
    53. 

  53. 	</td>
    54. 

  54.       </tr>
    55. 

  55.     </table>
    56. 

  56.     </div>
    57. 

  57.     <hr/>
    58. 

  58.     <div class="content">
    59. 

  59.     <div class="navbar" style="text-align:right;">
    60. 

  60.       
    61. 

  61.       
    62. 

  62.       <a class="prev" title="Basics" href="basics.html"><img src="../_static/prev.png" alt="prev"/></a>
    63. 

  63.       <a class="up" title="Design Guide" href="index.html"><img src="../_static/up.png" alt="up"/></a>
    64. 

  64.       <a class="next" title="Point" href="point.html"><img src="../_static/next.png" alt="next"/></a>
    65. 

  65.       
    66. 

  66.     </div>
    67. 

  67.       
    68. 

  68.   <div class="section" id="concepts">
    69. 

  69. <h1>Concepts</h1>
    70. 

  70. <p>All constructs in GIL are models of GIL concepts. A <em>concept</em> is a set of
    71. 

  71. requirements that a type (or a set of related types) must fulfill to be used
    72. 

  72. correctly in generic algorithms. The requirements include syntactic and
    73. 

  73. algorithmic guarantees. For example, GIL class <code class="docutils literal"><span class="pre">pixel</span></code> is a model of GIL
    74. 

  74. <code class="docutils literal"><span class="pre">PixelConcept</span></code>. The user may substitute the pixel class with one of their
    75. 

  75. own, and, as long as it satisfies the requirements of <code class="docutils literal"><span class="pre">PixelConcept</span></code>,
    76. 

  76. all other GIL classes and algorithms can be used with it.
    77. 

  77. See more about concepts is avaialble at
    78. 

  78. <a class="reference external" href="https://web.archive.org/web/20160324115943/http://www.generic-programming.org/languages/conceptcpp/">Generic Programming in ConceptC++</a></p>
    79. 

  79. <p>In this document we will use a syntax for defining concepts that is described
    80. 

  80. in the C++ standard proposal paper
    81. 

  81. <a class="reference external" href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2081.pdf">[N2081] Concepts</a>.</p>
    82. 

  82. <p>Here are some common concepts that will be used in GIL.
    83. 

  83. Most of them are defined at the
    84. 

  84. <a class="reference external" href="https://web.archive.org/web/20160326060858/http://www.generic-programming.org/languages/conceptcpp/concept_web.php">ConceptC++ Concept Web</a>:</p>
    85. 

  85. <div class="highlight-cpp"><div class="highlight"><pre><span class="k">auto</span> <span class="n">concept</span> <span class="n">DefaultConstructible</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
    86. 

  86. <span class="p">{</span>
    87. 

  87.     <span class="n">T</span><span class="o">::</span><span class="n">T</span><span class="p">();</span>
    88. 

  88. <span class="p">};</span>
    89. 

  89. 

  90. <span class="k">auto</span> <span class="n">concept</span> <span class="n">CopyConstructible</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
    91. 

  91. <span class="p">{</span>
    92. 

  92.     <span class="n">T</span><span class="o">::</span><span class="n">T</span><span class="p">(</span><span class="n">T</span><span class="p">);</span>
    93. 

  93.     <span class="n">T</span><span class="o">::~</span><span class="n">T</span><span class="p">();</span>
    94. 

  94. <span class="p">};</span>
    95. 

  95. 

  96. <span class="k">auto</span> <span class="n">concept</span> <span class="n">Assignable</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="k">typename</span> <span class="n">U</span> <span class="o">=</span> <span class="n">T</span><span class="o">&gt;</span>
    97. 

  97. <span class="p">{</span>
    98. 

  98.     <span class="k">typename</span> <span class="n">result_type</span><span class="p">;</span>
    99. 

  99.     <span class="n">result_type</span> <span class="k">operator</span><span class="o">=</span><span class="p">(</span><span class="n">T</span><span class="o">&amp;</span><span class="p">,</span> <span class="n">U</span><span class="p">);</span>
    100. 

  100. <span class="p">};</span>
    101. 

  101. 

  102. <span class="k">auto</span> <span class="n">concept</span> <span class="n">EqualityComparable</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="k">typename</span> <span class="n">U</span> <span class="o">=</span> <span class="n">T</span><span class="o">&gt;</span>
    103. 

  103. <span class="p">{</span>
    104. 

  104.     <span class="kt">bool</span> <span class="k">operator</span><span class="o">==</span><span class="p">(</span><span class="n">T</span> <span class="n">x</span><span class="p">,</span> <span class="n">T</span> <span class="n">y</span><span class="p">);</span>
    105. 

  105.     <span class="kt">bool</span> <span class="k">operator</span><span class="o">!=</span><span class="p">(</span><span class="n">T</span> <span class="n">x</span><span class="p">,</span> <span class="n">T</span> <span class="n">y</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="o">!</span><span class="p">(</span><span class="n">x</span><span class="o">==</span><span class="n">y</span><span class="p">);</span> <span class="p">}</span>
    106. 

  106. <span class="p">};</span>
    107. 

  107. 

  108. <span class="n">concept</span> <span class="n">SameType</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="p">,</span> <span class="k">typename</span> <span class="n">U</span><span class="o">&gt;</span> <span class="p">{</span> <span class="cm">/* unspecified */</span> <span class="p">};</span>
    109. 

  109. <span class="k">template</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span> <span class="n">concept_map</span> <span class="n">SameType</span><span class="o">&lt;</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="o">&gt;</span> <span class="p">{</span> <span class="cm">/* unspecified */</span> <span class="p">};</span>
    110. 

  110. 

  111. <span class="k">auto</span> <span class="n">concept</span> <span class="n">Swappable</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
    112. 

  112. <span class="p">{</span>
    113. 

  113.     <span class="kt">void</span> <span class="n">swap</span><span class="p">(</span><span class="n">T</span><span class="o">&amp;</span> <span class="n">t</span><span class="p">,</span> <span class="n">T</span><span class="o">&amp;</span> <span class="n">u</span><span class="p">);</span>
    114. 

  114. <span class="p">};</span>
    115. 

  115. </pre></div>
    116. 

  116. </div>
    117. 

  117. <p>Here are some additional basic concepts that GIL needs:</p>
    118. 

  118. <div class="highlight-cpp"><div class="highlight"><pre><span class="k">auto</span> <span class="n">concept</span> <span class="n">Regular</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span> <span class="o">:</span>
    119. 

  119.     <span class="n">DefaultConstructible</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">,</span>
    120. 

  120.     <span class="n">CopyConstructible</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">,</span>
    121. 

  121.     <span class="n">EqualityComparable</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">,</span>
    122. 

  122.     <span class="n">Assignable</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">,</span>
    123. 

  123.     <span class="n">Swappable</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span>
    124. 

  124. <span class="p">{};</span>
    125. 

  125. 

  126. <span class="k">auto</span> <span class="n">concept</span> <span class="n">Metafunction</span><span class="o">&lt;</span><span class="k">typename</span> <span class="n">T</span><span class="o">&gt;</span>
    127. 

  127. <span class="p">{</span>
    128. 

  128.     <span class="k">typename</span> <span class="n">type</span><span class="p">;</span>
    129. 

  129. <span class="p">};</span>
    130. 

  130. </pre></div>
    131. 

  131. </div>
    132. 

  132. </div>
    133. 

  133. 

  134. 

  135.     <div class="navbar" style="text-align:right;">
    136. 

  136.       
    137. 

  137.       
    138. 

  138.       <a class="prev" title="Basics" href="basics.html"><img src="../_static/prev.png" alt="prev"/></a>
    139. 

  139.       <a class="up" title="Design Guide" href="index.html"><img src="../_static/up.png" alt="up"/></a>
    140. 

  140.       <a class="next" title="Point" href="point.html"><img src="../_static/next.png" alt="next"/></a>
    141. 

  141.       
    142. 

  142.     </div>
    143. 

  143.     </div>
    144. 

  144.     <div class="footer" role="contentinfo">
    145. 

  145.       Last updated on 2019-12-10 00:12:10.
    146. 

  146.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
    147. 

  147.     </div>
    148. 

  148.   </body>
    149. 

  149. </html>
    150.