Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7cf7699bab13f2e0414dd4dda6a29591dd8b5686
entt/structentt_1_1y__combinator.html
Michele Caini 7cf7699bab API reference v3.12.0
2023-06-15 11:47:04 +02:00

257 lines
12 KiB
HTML
Raw Blame History

<!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" 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.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::y_combinator&lt; Func &gt; Struct Template Reference</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="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-awesome.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 id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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/",'.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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<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">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1y__combinator.html">y_combinator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1y__combinator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::y_combinator&lt; Func &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Basic implementation of a y-combinator.
<a href="structentt_1_1y__combinator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adde65963ec96a6e81a331dd16a7da7f4"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1y__combinator.html#adde65963ec96a6e81a331dd16a7da7f4">y_combinator</a> (Func recursive) noexcept(std::is_nothrow_move_constructible_v&lt; Func &gt;)</td></tr>
<tr class="memdesc:adde65963ec96a6e81a331dd16a7da7f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a y-combinator from a given function. <br /></td></tr>
<tr class="separator:adde65963ec96a6e81a331dd16a7da7f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60dcd896c4b8724ed4886c63977943fa"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a60dcd896c4b8724ed4886c63977943fa"><td class="memTemplItemLeft" align="right" valign="top">constexpr decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1y__combinator.html#a60dcd896c4b8724ed4886c63977943fa">operator()</a> (Args &amp;&amp;...args) const noexcept(std::is_nothrow_invocable_v&lt; Func, const <a class="el" href="structentt_1_1y__combinator.html">y_combinator</a> &amp;, Args... &gt;)</td></tr>
<tr class="memdesc:a60dcd896c4b8724ed4886c63977943fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes a y-combinator and therefore its underlying function. <br /></td></tr>
<tr class="separator:a60dcd896c4b8724ed4886c63977943fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1811863af3a07ef59aa25b9bff2a1e1d"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a1811863af3a07ef59aa25b9bff2a1e1d"><td class="memTemplItemLeft" align="right" valign="top">constexpr decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1y__combinator.html#a1811863af3a07ef59aa25b9bff2a1e1d">operator()</a> (Args &amp;&amp;...args) noexcept(std::is_nothrow_invocable_v&lt; Func, <a class="el" href="structentt_1_1y__combinator.html">y_combinator</a> &amp;, Args... &gt;)</td></tr>
<tr class="memdesc:a1811863af3a07ef59aa25b9bff2a1e1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes a y-combinator and therefore its underlying function. <br /></td></tr>
<tr class="separator:a1811863af3a07ef59aa25b9bff2a1e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Func&gt;<br />
struct entt::y_combinator&lt; Func &gt;</div><p>Basic implementation of a y-combinator. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Func</td><td>Type of a potentially recursive function. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="core_2utility_8hpp_source.html#l00070">70</a> of file <a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adde65963ec96a6e81a331dd16a7da7f4" name="adde65963ec96a6e81a331dd16a7da7f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adde65963ec96a6e81a331dd16a7da7f4">&#9670;&#160;</a></span>y_combinator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="structentt_1_1y__combinator.html">entt::y_combinator</a>&lt; Func &gt;::y_combinator </td>
<td>(</td>
<td class="paramtype">Func&#160;</td>
<td class="paramname"><em>recursive</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a y-combinator from a given function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">recursive</td><td>A potentially recursive function. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="core_2utility_8hpp_source.html#l00075">75</a> of file <a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a60dcd896c4b8724ed4886c63977943fa" name="a60dcd896c4b8724ed4886c63977943fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60dcd896c4b8724ed4886c63977943fa">&#9670;&#160;</a></span>operator()() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr decltype(auto) <a class="el" href="structentt_1_1y__combinator.html">entt::y_combinator</a>&lt; Func &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invokes a y-combinator and therefore its underlying function. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>Types of arguments to use to invoke the underlying function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to invoke the underlying function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return value of the underlying function, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="core_2utility_8hpp_source.html#l00085">85</a> of file <a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a>.</p>
</div>
</div>
<a id="a1811863af3a07ef59aa25b9bff2a1e1d" name="a1811863af3a07ef59aa25b9bff2a1e1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1811863af3a07ef59aa25b9bff2a1e1d">&#9670;&#160;</a></span>operator()() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func &gt; </div>
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr decltype(auto) <a class="el" href="structentt_1_1y__combinator.html">entt::y_combinator</a>&lt; Func &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invokes a y-combinator and therefore its underlying function. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>Types of arguments to use to invoke the underlying function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to invoke the underlying function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return value of the underlying function, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="core_2utility_8hpp_source.html#l00091">91</a> of file <a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/core/<a class="el" href="core_2utility_8hpp_source.html">utility.hpp</a></li>
</ul>
</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.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink