<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libstdc++: doxygroups.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libstdc++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00020_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">doxygroups.cc</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2001-2018 Free Software Foundation, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> See license.html for license.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This just provides documentation for stuff that doesn't need to be in the</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> source headers themselves. It is a ".cc" file for the sole cheesy reason</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> that it triggers many different text editors into doing Nice Things when</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> typing comments. However, it is mentioned nowhere except the *cfg.in files.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Some actual code (declarations) is exposed here, but no compiler ever</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> sees it. The decls must be visible to doxygen, and sometimes their real</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> declarations are not visible, or not visible in a way we want.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Pieces separated by '// //' lines will usually not be presented to the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> user on the same page.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">*/</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// // // // // // // // // // // // // // // // // // // // // // // //</span><span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/** @namespace std</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @brief ISO C++ entities toplevel namespace is std.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/** @namespace std::__detail</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @brief Implementation details not part of the namespace std interface.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/** @namespace std::tr1</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief ISO C++ TR1 entities toplevel namespace is std::tr1.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/** @namespace std::tr1::__detail</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @brief Implementation details not part of the namespace std::tr1 interface.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/** @namespace std::tr2</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @brief ISO C++ TR2 entities toplevel namespace is std::tr2.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/** @namespace std::tr2::__detail</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @brief Implementation details not part of the namespace std::tr2 interface.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/** @namespace __gnu_cxx</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @brief GNU extensions for public use.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/** @namespace __gnu_cxx::__detail</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @brief Implementation details not part of the namespace __gnu_cxx </span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * interface.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">*/</span><span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/** @namespace __gnu_internal</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @brief GNU implemenation details, not for public use or</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * export. Used only when anonymous namespaces cannot be substituted.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">*/</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// // // // // // // // // // // // // // // // // // // // // // // //</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/**</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @defgroup extensions Extensions</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> *</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * Components generally useful that are not part of any standard.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/** @defgroup SGIextensions SGI</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @ingroup extensions</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">Because libstdc++ based its implementation of the STL subsections of</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">the library on the SGI 3.3 implementation, we inherited their extensions</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">as well.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">They are additionally documented in the</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"><a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">online documentation</a>, a copy of which is also shipped with the</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">library source code (in .../docs/html/documentation.html). You can also</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">read the documentation <a href="http://www.sgi.com/tech/stl/">on SGI's</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">site</a>, which is still running even though the code is not maintained.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"><strong>NB</strong> that the following notes are pulled from various</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">comments all over the place, so they may seem stilted.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"><hr></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">*/</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/** @defgroup containers Containers</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">Containers are collections of objects.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">A container may hold any type which meets certain requirements, but the type</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">of contained object is chosen at compile time, and all objects in a given</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">container must be of the same type. (Polymorphism is possible by declaring a</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">container of pointers to a base class and then populating it with pointers to</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">instances of derived classes. Variant value types such as the @c any class</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">from <a href="http://www.boost.org/">Boost</a> can also be used.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">All contained types must be @c Assignable and @c CopyConstructible.</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">Specific containers may place additional requirements on the types of</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">their contained objects.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">Containers manage memory allocation and deallocation themselves when</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">storing your objects. The objects are destroyed when the container is</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">itself destroyed. Note that if you are storing pointers in a container,</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">@c delete is @e not automatically called on the pointers before destroying them.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">All containers must meet certain requirements, summarized in</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"><a href="tables.html">tables</a>.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">The standard containers are further refined into</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">@link sequences Sequences@endlink and</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">@link associative_containers Associative Containers@endlink.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">@link unordered_associative_containers Unordered Associative Containers@endlink.</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">*/</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/** @defgroup sequences Sequences</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @ingroup containers</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">Sequences arrange a collection of objects into a strictly linear order.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">The differences between sequences are usually due to one or both of the</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">following:</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> - memory management</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> - algorithmic complexity</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">As an example of the first case, @c vector is required to use a contiguous</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">memory layout, while other sequences such as @c deque are not.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">The prime reason for choosing one sequence over another should be based on</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">the second category of differences, algorithmic complexity. For example, if</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">you need to perform many inserts and removals from the middle of a sequence,</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">@c list would be ideal. But if you need to perform constant-time access to</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">random elements of the sequence, then @c list should not be used.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"></span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">All sequences must meet certain requirements, summarized in</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"><a href="tables.html">tables</a>.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">*/</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/** @defgroup associative_containers Associative</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @ingroup containers</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">Associative containers allow fast retrieval of data based on keys.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">Each container type is parameterized on a @c Key type, and an ordering</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">relation used to sort the elements of the container.</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"></span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">All associative containers must meet certain requirements, summarized in</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"><a href="tables.html">tables</a>.</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">*/</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/** @defgroup unordered_associative_containers Unordered Associative</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @ingroup containers</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment">Unordered associative containers allow fast retrieval of data based on keys.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"></span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">Each container type is parameterized on a @c Key type, a @c Hash type</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">providing a hashing functor, and an ordering relation used to sort the</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">elements of the container.</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">All unordered associative containers must meet certain requirements,</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">summarized in <a href="tables.html">tables</a>. */</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/**</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @defgroup diagnostics Diagnostics</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> *</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * Components for error handling, reporting, and diagnostic operations.</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> */</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/**</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @defgroup concurrency Concurrency</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> *</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * Components for concurrent operations, including threads, mutexes,</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * and condition variables.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div></div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_434a3f2b81816e64e09d7f43ca77c261.html">libstdc++-v3</a></li><li class="navelem"><a class="el" href="dir_70bd1a9573a91da509a1918e3b6a1c52.html">doc</a></li><li class="navelem"><a class="el" href="dir_0f630f6603a9c144244385a2bd1432b8.html">doxygen</a></li><li class="navelem"><b>doxygroups.cc</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
bfb47da7e0322bcb0e23e4b1838d9db9
>
files
>
19
