API reference v3.12.0

This commit is contained in:
Michele Caini
2023-06-15 11:47:04 +02:00
parent d914ed4a81
commit 7cf7699bab
1796 changed files with 43348 additions and 33717 deletions

View File

@@ -1,9 +1,9 @@
<!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">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: src/entt/core/algorithm.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -12,7 +12,7 @@
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
@@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.11.0</span>
<div id="projectname">EnTT<span id="projectnumber">&#160;3.12.0</span>
</div>
</td>
</tr>
@@ -29,10 +29,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -55,9 +55,16 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
@@ -113,46 +120,47 @@ $(function() {
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> It, <span class="keyword">typename</span> Getter = <span class="keywordtype">id</span>entity&gt;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structentt_1_1radix__sort.html#a1989f6fbe18d3d82fdea9745d6b9ee96"> 96</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="structentt_1_1radix__sort.html#a1989f6fbe18d3d82fdea9745d6b9ee96">operator()</a>(It first, It last, Getter getter = Getter{}) <span class="keyword">const</span> {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">if</span>(first &lt; last) {</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> mask = (1 &lt;&lt; Bit) - 1;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> buckets = 1 &lt;&lt; Bit;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> passes = N / Bit;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">using </span>value_type = <span class="keyword">typename</span> std::iterator_traits&lt;It&gt;::value_type;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> std::vector&lt;value_type&gt; aux(std::distance(first, last));</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">auto</span> part = [getter = std::move(getter)](<span class="keyword">auto</span> from, <span class="keyword">auto</span> to, <span class="keyword">auto</span> out, <span class="keyword">auto</span> start) {</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> std::size_t index[buckets]{};</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> std::size_t count[buckets]{};</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> it = from; it != to; ++it) {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> ++count[(getter(*it) &gt;&gt; start) &amp; mask];</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> }</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keywordflow">for</span>(std::size_t pos{}, end = buckets - 1u; pos &lt; end; ++pos) {</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> index[pos + 1u] = index[pos] + count[pos];</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> }</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> it = from; it != to; ++it) {</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> out[index[(getter(*it) &gt;&gt; start) &amp; mask]++] = std::move(*it);</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> }</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> };</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordflow">for</span>(std::size_t pass = 0; pass &lt; (passes &amp; ~1); pass += 2) {</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> part(first, last, aux.begin(), pass * Bit);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> part(aux.begin(), aux.end(), first, (pass + 1) * Bit);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> }</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(passes &amp; 1) {</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> part(first, last, aux.begin(), (passes - 1) * Bit);</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> std::move(aux.begin(), aux.end(), first);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> }</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> }</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>};</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span>} <span class="comment">// namespace entt</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> passes = N / Bit;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">using </span>value_type = <span class="keyword">typename</span> std::iterator_traits&lt;It&gt;::value_type;</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> std::vector&lt;value_type&gt; aux(std::distance(first, last));</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">auto</span> part = [getter = std::move(getter)](<span class="keyword">auto</span> from, <span class="keyword">auto</span> to, <span class="keyword">auto</span> out, <span class="keyword">auto</span> start) {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> mask = (1 &lt;&lt; Bit) - 1;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">constexpr</span> <span class="keyword">auto</span> buckets = 1 &lt;&lt; Bit;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> std::size_t index[buckets]{};</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> std::size_t count[buckets]{};</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> it = from; it != to; ++it) {</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> ++count[(getter(*it) &gt;&gt; start) &amp; mask];</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> }</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordflow">for</span>(std::size_t pos{}, end = buckets - 1u; pos &lt; end; ++pos) {</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> index[pos + 1u] = index[pos] + count[pos];</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span> it = from; it != to; ++it) {</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> out[index[(getter(*it) &gt;&gt; start) &amp; mask]++] = std::move(*it);</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> }</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> };</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keywordflow">for</span>(std::size_t pass = 0; pass &lt; (passes &amp; ~1); pass += 2) {</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> part(first, last, aux.begin(), pass * Bit);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> part(aux.begin(), aux.end(), first, (pass + 1) * Bit);</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> }</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(passes &amp; 1) {</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> part(first, last, aux.begin(), (passes - 1) * Bit);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> std::move(aux.begin(), aux.end(), first);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> }</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> }</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> }</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>};</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>} <span class="comment">// namespace entt</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="dense__map_8hpp_source.html#l00021">dense_map.hpp:21</a></div></div>
<div class="ttc" id="astructentt_1_1insertion__sort_html"><div class="ttname"><a href="structentt_1_1insertion__sort.html">entt::insertion_sort</a></div><div class="ttdoc">Function object for performing insertion sort.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8hpp_source.html#l00042">algorithm.hpp:42</a></div></div>
<div class="ttc" id="astructentt_1_1insertion__sort_html_a73a5644fe5b683f9b9376c89ac47f2b8"><div class="ttname"><a href="structentt_1_1insertion__sort.html#a73a5644fe5b683f9b9376c89ac47f2b8">entt::insertion_sort::operator()</a></div><div class="ttdeci">void operator()(It first, It last, Compare compare=Compare{}) const</div><div class="ttdoc">Sorts the elements in a range.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8hpp_source.html#l00055">algorithm.hpp:55</a></div></div>
@@ -163,7 +171,7 @@ $(function() {
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>