Files
simdjson-simdjson/concepts_8h_source.html
T
2024-12-06 03:19:07 +00:00

213 lines
20 KiB
HTML

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>simdjson: include/simdjson/concepts.h 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>
<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"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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="projectlogo"><img alt="Logo" src="logotiny.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">simdjson
&#160;<span id="projectnumber">3.11.0</span>
</div>
<div id="projectbrief">Ridiculously Fast JSON</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('concepts_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">concepts.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef SIMDJSON_CONCEPTS_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define SIMDJSON_CONCEPTS_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#if SIMDJSON_SUPPORTS_DESERIALIZATION</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;concepts&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesimdjson.html">simdjson</a> {</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span>concepts {</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="keyword">namespace </span>details {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define SIMDJSON_IMPL_CONCEPT(name, method) \</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor"> template &lt;typename T&gt; \</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"> concept supports_##name = !std::is_const_v&lt;T&gt; &amp;&amp; requires { \</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"> typename std::remove_cvref_t&lt;T&gt;::value_type; \</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor"> requires requires(typename std::remove_cvref_t&lt;T&gt;::value_type &amp;&amp;val, \</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor"> T obj) { \</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"> obj.method(std::move(val)); \</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"> requires !requires { obj = std::move(val); }; \</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"> }; \</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor"> };</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;SIMDJSON_IMPL_CONCEPT(emplace_back, emplace_back);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;SIMDJSON_IMPL_CONCEPT(emplace, emplace);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;SIMDJSON_IMPL_CONCEPT(push_back, push_back);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;SIMDJSON_IMPL_CONCEPT(add, add);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;SIMDJSON_IMPL_CONCEPT(push, push);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;SIMDJSON_IMPL_CONCEPT(append, append);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;SIMDJSON_IMPL_CONCEPT(insert, insert);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;SIMDJSON_IMPL_CONCEPT(op_append, <span class="keyword">operator</span>+=);</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="preprocessor">#undef SIMDJSON_IMPL_CONCEPT</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;} <span class="comment">// namespace details</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;concept appendable_containers =</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; details::supports_emplace_back&lt;T&gt; || details::supports_emplace&lt;T&gt; ||</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; details::supports_push_back&lt;T&gt; || details::supports_push&lt;T&gt; ||</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; details::supports_add&lt;T&gt; || details::supports_append&lt;T&gt; ||</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; details::supports_insert&lt;T&gt;;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">template</span> &lt;appendable_containers T, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;constexpr decltype(<span class="keyword">auto</span>) emplace_one(T &amp;vec, Args &amp;&amp;...args) {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">if</span> constexpr (details::supports_emplace_back&lt;T&gt;) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> vec.emplace_back(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_emplace&lt;T&gt;) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">return</span> vec.emplace(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_push_back&lt;T&gt;) {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> vec.push_back(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_push&lt;T&gt;) {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> vec.push(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_add&lt;T&gt;) {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> vec.add(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_append&lt;T&gt;) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> vec.append(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_insert&lt;T&gt;) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> vec.insert(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> constexpr (details::supports_op_append&lt;T&gt; &amp;&amp; <span class="keyword">sizeof</span>...(Args) == 1) {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">return</span> vec.operator+=(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; static_assert(!<span class="keyword">sizeof</span>(T *),</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="stringliteral">&quot;We don&#39;t know how to add things to this container&quot;</span>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;}</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;concept returns_reference = appendable_containers&lt;T&gt; &amp;&amp; requires {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">typename</span> std::remove_cvref_t&lt;T&gt;::reference;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; requires requires(<span class="keyword">typename</span> std::remove_cvref_t&lt;T&gt;::value_type &amp;&amp;val, T obj) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; emplace_one(obj, std::move(val))</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; } -&gt; std::same_as&lt;typename std::remove_cvref_t&lt;T&gt;::reference&gt;;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; };</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; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;concept smart_pointer = requires(std::remove_cvref_t&lt;T&gt; ptr) {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// Check if T has a member type named element_type</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">typename</span> std::remove_cvref_t&lt;T&gt;::element_type;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// Check if T has a get() member function</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; ptr.get()</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; } -&gt; std::same_as&lt;typename std::remove_cvref_t&lt;T&gt;::element_type *&gt;;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// Check if T can be dereferenced</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; { *ptr } -&gt; std::same_as&lt;typename std::remove_cvref_t&lt;T&gt;::element_type &amp;&gt;;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;};</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;concept optional_type = requires(std::remove_cvref_t&lt;T&gt; obj) {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">typename</span> std::remove_cvref_t&lt;T&gt;::value_type;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; { obj.value() } -&gt; std::same_as&lt;typename std::remove_cvref_t&lt;T&gt;::value_type&amp;&gt;;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; requires requires(<span class="keyword">typename</span> std::remove_cvref_t&lt;T&gt;::value_type &amp;&amp;val) {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; obj.emplace(std::move(val));</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; obj = std::move(val);</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; obj.value_or(val)</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; } -&gt; std::convertible_to&lt;typename std::remove_cvref_t&lt;T&gt;::value_type&gt;;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; };</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; { <span class="keyword">static_cast&lt;</span><span class="keywordtype">bool</span><span class="keyword">&gt;</span>(obj) } -&gt; std::same_as&lt;bool&gt;; <span class="comment">// convertible to bool</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;};</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;} <span class="comment">// namespace concepts</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;} <span class="comment">// namespace simdjson</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// SIMDJSON_SUPPORTS_DESERIALIZATION</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// SIMDJSON_CONCEPTS_H</span></div>
<div class="ttc" id="anamespacesimdjson_html"><div class="ttname"><a href="namespacesimdjson.html">simdjson</a></div><div class="ttdoc">The top level simdjson namespace, containing everything the library provides.</div><div class="ttdef"><b>Definition:</b> <a href="arm64_2base_8h_source.html#l00008">base.h:8</a></div></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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_49a0b2767ded4a45005c5d6720a18cd1.html">simdjson</a></li><li class="navelem"><b>concepts.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>