Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1e23a1131122fef897be4ffffd08bca00a7d291b
entt/structentt_1_1basic__meta__associative__container__traits.html
Michele Caini 1e23a11311 API reference v3.15.0
2025-03-19 15:49:42 +01:00

604 lines
33 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_meta_associative_container_traits&lt; Type &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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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.15.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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_1basic__meta__associative__container__traits.html">basic_meta_associative_container_traits</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structentt_1_1basic__meta__associative__container__traits-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_meta_associative_container_traits&lt; Type &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>General purpose implementation of meta associative container traits.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="container_8hpp_source.html">container.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad307302808908d988ec7f8d6f7988e29" id="r_ad307302808908d988ec7f8d6f7988e29"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a> = typename <a class="el" href="classentt_1_1meta__associative__container.html#a9ef078a3364ff3d53cec2bda15f4782f">meta_associative_container::size_type</a></td></tr>
<tr class="memdesc:ad307302808908d988ec7f8d6f7988e29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:ad307302808908d988ec7f8d6f7988e29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40e3448c9cd000ed80e672847be3c684" id="r_a40e3448c9cd000ed80e672847be3c684"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a> = typename <a class="el" href="classentt_1_1meta__associative__container.html#aafbaf281035562432a4e8e55443e9584">meta_associative_container::iterator</a></td></tr>
<tr class="memdesc:a40e3448c9cd000ed80e672847be3c684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Meta iterator type. <br /></td></tr>
<tr class="separator:a40e3448c9cd000ed80e672847be3c684"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac8eef423df02a2cea999257011b26d5e" id="r_ac8eef423df02a2cea999257011b26d5e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8eef423df02a2cea999257011b26d5e">size</a> (const void *container)</td></tr>
<tr class="memdesc:ac8eef423df02a2cea999257011b26d5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of elements in a container. <br /></td></tr>
<tr class="separator:ac8eef423df02a2cea999257011b26d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf9bc27ae40de083f96c62fcc7bf5aa3" id="r_adf9bc27ae40de083f96c62fcc7bf5aa3"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf9bc27ae40de083f96c62fcc7bf5aa3">clear</a> (void *container)</td></tr>
<tr class="memdesc:adf9bc27ae40de083f96c62fcc7bf5aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears a container. <br /></td></tr>
<tr class="separator:adf9bc27ae40de083f96c62fcc7bf5aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a263fa80500498c321763405824267b5a" id="r_a263fa80500498c321763405824267b5a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a263fa80500498c321763405824267b5a">reserve</a> (void *container, const <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a> sz)</td></tr>
<tr class="memdesc:a263fa80500498c321763405824267b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases the capacity of a container. <br /></td></tr>
<tr class="separator:a263fa80500498c321763405824267b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ae7f3871f82ab98e4516dd34afbb7f" id="r_a08ae7f3871f82ab98e4516dd34afbb7f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a08ae7f3871f82ab98e4516dd34afbb7f">begin</a> (const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;area, void *container, const void *as_const)</td></tr>
<tr class="memdesc:a08ae7f3871f82ab98e4516dd34afbb7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a possibly const iterator to the beginning. <br /></td></tr>
<tr class="separator:a08ae7f3871f82ab98e4516dd34afbb7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a453ea97824664906c5d2296b63543" id="r_a17a453ea97824664906c5d2296b63543"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17a453ea97824664906c5d2296b63543">end</a> (const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;area, void *container, const void *as_const)</td></tr>
<tr class="memdesc:a17a453ea97824664906c5d2296b63543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a possibly const iterator to the end. <br /></td></tr>
<tr class="separator:a17a453ea97824664906c5d2296b63543"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae403d257c39ca55b238e86689e890b19" id="r_ae403d257c39ca55b238e86689e890b19"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae403d257c39ca55b238e86689e890b19">insert</a> (void *container, const void *key, const void *value)</td></tr>
<tr class="memdesc:ae403d257c39ca55b238e86689e890b19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts an element into a container, if the key does not exist. <br /></td></tr>
<tr class="separator:ae403d257c39ca55b238e86689e890b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea3b661f27c029a72fdbc4f70ae798fb" id="r_aea3b661f27c029a72fdbc4f70ae798fb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea3b661f27c029a72fdbc4f70ae798fb">erase</a> (void *container, const void *key)</td></tr>
<tr class="memdesc:aea3b661f27c029a72fdbc4f70ae798fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an element from a container. <br /></td></tr>
<tr class="separator:aea3b661f27c029a72fdbc4f70ae798fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10b86dc92a1d115c794d171472288428" id="r_a10b86dc92a1d115c794d171472288428"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a10b86dc92a1d115c794d171472288428">find</a> (const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;area, void *container, const void *as_const, const void *key)</td></tr>
<tr class="memdesc:a10b86dc92a1d115c794d171472288428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds an element with a given key. <br /></td></tr>
<tr class="separator:a10b86dc92a1d115c794d171472288428"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aa9fe6930c973e89b94aa223ef6c4dc75" id="r_aa9fe6930c973e89b94aa223ef6c4dc75"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9fe6930c973e89b94aa223ef6c4dc75">key_only</a> = internal::key_only_associative_container_v&lt;Type&gt;</td></tr>
<tr class="memdesc:aa9fe6930c973e89b94aa223ef6c4dc75"><td class="mdescLeft">&#160;</td><td class="mdescRight">True in case of key-only containers, false otherwise. <br /></td></tr>
<tr class="separator:aa9fe6930c973e89b94aa223ef6c4dc75"><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 Type&gt;<br />
struct entt::basic_meta_associative_container_traits&lt; Type &gt;</div><p>General purpose implementation of meta associative container traits. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of underlying associative container. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00195">195</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a40e3448c9cd000ed80e672847be3c684" name="a40e3448c9cd000ed80e672847be3c684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40e3448c9cd000ed80e672847be3c684">&#9670;&#160;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::iterator = typename <a class="el" href="classentt_1_1meta__associative__container.html#aafbaf281035562432a4e8e55443e9584">meta_associative_container::iterator</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Meta iterator type. </p>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00201">201</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="ad307302808908d988ec7f8d6f7988e29" name="ad307302808908d988ec7f8d6f7988e29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad307302808908d988ec7f8d6f7988e29">&#9670;&#160;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::size_type = typename <a class="el" href="classentt_1_1meta__associative__container.html#a9ef078a3364ff3d53cec2bda15f4782f">meta_associative_container::size_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsigned integer type. </p>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00199">199</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a08ae7f3871f82ab98e4516dd34afbb7f" name="a08ae7f3871f82ab98e4516dd34afbb7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ae7f3871f82ab98e4516dd34afbb7f">&#9670;&#160;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a> <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::begin </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;</td> <td class="paramname"><span class="paramname"><em>area</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>as_const</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a possibly const iterator to the beginning. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>The context to pass to the newly created iterator. </td></tr>
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">as_const</td><td>Const opaque pointer fallback. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first element of the container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00247">247</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="adf9bc27ae40de083f96c62fcc7bf5aa3" name="adf9bc27ae40de083f96c62fcc7bf5aa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf9bc27ae40de083f96c62fcc7bf5aa3">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::clear </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears a container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00220">220</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a17a453ea97824664906c5d2296b63543" name="a17a453ea97824664906c5d2296b63543"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17a453ea97824664906c5d2296b63543">&#9670;&#160;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a> <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::end </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;</td> <td class="paramname"><span class="paramname"><em>area</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>as_const</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a possibly const iterator to the end. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>The context to pass to the newly created iterator. </td></tr>
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">as_const</td><td>Const opaque pointer fallback. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator that is past the last element of the container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00259">259</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="aea3b661f27c029a72fdbc4f70ae798fb" name="aea3b661f27c029a72fdbc4f70ae798fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea3b661f27c029a72fdbc4f70ae798fb">&#9670;&#160;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a> <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::erase </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes an element from a container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">key</td><td>An opaque key value of an element to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of elements removed (either 0 or 1). </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00285">285</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a10b86dc92a1d115c794d171472288428" name="a10b86dc92a1d115c794d171472288428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b86dc92a1d115c794d171472288428">&#9670;&#160;</a></span>find()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#a40e3448c9cd000ed80e672847be3c684">iterator</a> <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::find </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;</td> <td class="paramname"><span class="paramname"><em>area</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>as_const</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds an element with a given key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>The context to pass to the newly created iterator. </td></tr>
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">as_const</td><td>Const opaque pointer fallback. </td></tr>
<tr><td class="paramname">key</td><td>Opaque key value of an element to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element with the given key, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00297">297</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="ae403d257c39ca55b238e86689e890b19" name="ae403d257c39ca55b238e86689e890b19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae403d257c39ca55b238e86689e890b19">&#9670;&#160;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::insert </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts an element into a container, if the key does not exist. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">key</td><td>An opaque key value of an element to insert. </td></tr>
<tr><td class="paramname">value</td><td>Optional opaque value to insert (key-value containers). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the insertion took place, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00271">271</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a263fa80500498c321763405824267b5a" name="a263fa80500498c321763405824267b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a263fa80500498c321763405824267b5a">&#9670;&#160;</a></span>reserve()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::reserve </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>container</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a></td> <td class="paramname"><span class="paramname"><em>sz</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Increases the capacity of a container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
<tr><td class="paramname">sz</td><td>Desired capacity. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00231">231</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="ac8eef423df02a2cea999257011b26d5e" name="ac8eef423df02a2cea999257011b26d5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8eef423df02a2cea999257011b26d5e">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#ad307302808908d988ec7f8d6f7988e29">size_type</a> <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::size </td>
<td>(</td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>container</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of elements in a container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">container</td><td>Opaque pointer to a container of the given type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of elements. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00211">211</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa9fe6930c973e89b94aa223ef6c4dc75" name="aa9fe6930c973e89b94aa223ef6c4dc75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9fe6930c973e89b94aa223ef6c4dc75">&#9670;&#160;</a></span>key_only</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structentt_1_1basic__meta__associative__container__traits.html">entt::basic_meta_associative_container_traits</a>&lt; Type &gt;::key_only = internal::key_only_associative_container_v&lt;Type&gt;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True in case of key-only containers, false otherwise. </p>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00204">204</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/meta/<a class="el" href="container_8hpp_source.html">container.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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink