Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4b578e1085ee3e41591613048becabb34a13cd9c
entt/structentt_1_1basic__container.html
Michele Caini 4b578e1085 API reference v3.6.0
2021-01-09 18:58:42 +01:00

339 lines
19 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">
<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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_container&lt; Container &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.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">EnTT
&#160;<span id="projectnumber">3.6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @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>
<!-- 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 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__container.html">basic_container</a></li> </ul>
</div>
</div><!-- top -->
<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="structentt_1_1basic__container-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::basic_container&lt; Container &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Basic STL-compatible container traits.
<a href="structentt_1_1basic__container.html#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 name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a980602ee3d88568dfbe10e37cf96077c"><td class="memItemLeft" align="right" valign="top"><a id="a980602ee3d88568dfbe10e37cf96077c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a980602ee3d88568dfbe10e37cf96077c">iterator</a> = typename Container::iterator</td></tr>
<tr class="memdesc:a980602ee3d88568dfbe10e37cf96077c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator type of the container. <br /></td></tr>
<tr class="separator:a980602ee3d88568dfbe10e37cf96077c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7b4e2cc9e908f3bb4742e6a42913ede"><td class="memItemLeft" align="right" valign="top"><a id="ab7b4e2cc9e908f3bb4742e6a42913ede"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#ab7b4e2cc9e908f3bb4742e6a42913ede">const_iterator</a> = typename Container::const_iterator</td></tr>
<tr class="memdesc:ab7b4e2cc9e908f3bb4742e6a42913ede"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterator type of the container. <br /></td></tr>
<tr class="separator:ab7b4e2cc9e908f3bb4742e6a42913ede"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22e81e6f0d46434a0b5cb2c2d98d8e60"><td class="memItemLeft" align="right" valign="top"><a id="a22e81e6f0d46434a0b5cb2c2d98d8e60"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a22e81e6f0d46434a0b5cb2c2d98d8e60">size_type</a> = typename Container::size_type</td></tr>
<tr class="memdesc:a22e81e6f0d46434a0b5cb2c2d98d8e60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a22e81e6f0d46434a0b5cb2c2d98d8e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a072d9cc2d2fa351b9de8c7328fff211c"><td class="memItemLeft" align="right" valign="top"><a id="a072d9cc2d2fa351b9de8c7328fff211c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a072d9cc2d2fa351b9de8c7328fff211c">value_type</a> = typename Container::value_type</td></tr>
<tr class="memdesc:a072d9cc2d2fa351b9de8c7328fff211c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value type of the container. <br /></td></tr>
<tr class="separator:a072d9cc2d2fa351b9de8c7328fff211c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1361e8f4689de3ab5b0dcaebaf00eed1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structentt_1_1basic__container.html#a22e81e6f0d46434a0b5cb2c2d98d8e60">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a1361e8f4689de3ab5b0dcaebaf00eed1">size</a> (const Container &amp;cont) noexcept</td></tr>
<tr class="memdesc:a1361e8f4689de3ab5b0dcaebaf00eed1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the given container. <a href="structentt_1_1basic__container.html#a1361e8f4689de3ab5b0dcaebaf00eed1">More...</a><br /></td></tr>
<tr class="separator:a1361e8f4689de3ab5b0dcaebaf00eed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1cb6601a8fe6d0bef10778310f15751"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structentt_1_1basic__container.html#a980602ee3d88568dfbe10e37cf96077c">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#ac1cb6601a8fe6d0bef10778310f15751">begin</a> (Container &amp;cont)</td></tr>
<tr class="memdesc:ac1cb6601a8fe6d0bef10778310f15751"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the first element of the given container. <a href="structentt_1_1basic__container.html#ac1cb6601a8fe6d0bef10778310f15751">More...</a><br /></td></tr>
<tr class="separator:ac1cb6601a8fe6d0bef10778310f15751"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6749688ba3a083944e62ad84679edec"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structentt_1_1basic__container.html#ab7b4e2cc9e908f3bb4742e6a42913ede">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#ab6749688ba3a083944e62ad84679edec">cbegin</a> (const Container &amp;cont)</td></tr>
<tr class="memdesc:ab6749688ba3a083944e62ad84679edec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the first element of the given container. <a href="structentt_1_1basic__container.html#ab6749688ba3a083944e62ad84679edec">More...</a><br /></td></tr>
<tr class="separator:ab6749688ba3a083944e62ad84679edec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e15a46760784c7534b2b4271a5b192c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structentt_1_1basic__container.html#a980602ee3d88568dfbe10e37cf96077c">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a4e15a46760784c7534b2b4271a5b192c">end</a> (Container &amp;cont)</td></tr>
<tr class="memdesc:a4e15a46760784c7534b2b4271a5b192c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator past the last element of the given container. <a href="structentt_1_1basic__container.html#a4e15a46760784c7534b2b4271a5b192c">More...</a><br /></td></tr>
<tr class="separator:a4e15a46760784c7534b2b4271a5b192c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2daa6256840bab89255e9ba543126fa7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structentt_1_1basic__container.html#ab7b4e2cc9e908f3bb4742e6a42913ede">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__container.html#a2daa6256840bab89255e9ba543126fa7">cend</a> (const Container &amp;cont)</td></tr>
<tr class="memdesc:a2daa6256840bab89255e9ba543126fa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator past the last element of the given container. <a href="structentt_1_1basic__container.html#a2daa6256840bab89255e9ba543126fa7">More...</a><br /></td></tr>
<tr class="separator:a2daa6256840bab89255e9ba543126fa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Container&gt;<br />
struct entt::basic_container&lt; Container &gt;</h3>
<p>Basic STL-compatible container traits. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Container</td><td>The type of the container. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00035">35</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac1cb6601a8fe6d0bef10778310f15751"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1cb6601a8fe6d0bef10778310f15751">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Container &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structentt_1_1basic__container.html#a980602ee3d88568dfbe10e37cf96077c">iterator</a> <a class="el" href="structentt_1_1basic__container.html">entt::basic_container</a>&lt; Container &gt;::begin </td>
<td>(</td>
<td class="paramtype">Container &amp;&#160;</td>
<td class="paramname"><em>cont</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the first element of the given container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cont</td><td>The container for which to return the iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first element of the given container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00059">59</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="ab6749688ba3a083944e62ad84679edec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6749688ba3a083944e62ad84679edec">&#9670;&nbsp;</a></span>cbegin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Container &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structentt_1_1basic__container.html#ab7b4e2cc9e908f3bb4742e6a42913ede">const_iterator</a> <a class="el" href="structentt_1_1basic__container.html">entt::basic_container</a>&lt; Container &gt;::cbegin </td>
<td>(</td>
<td class="paramtype">const Container &amp;&#160;</td>
<td class="paramname"><em>cont</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the first element of the given container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cont</td><td>The container for which to return the iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first element of the given container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00068">68</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a2daa6256840bab89255e9ba543126fa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2daa6256840bab89255e9ba543126fa7">&#9670;&nbsp;</a></span>cend()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Container &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structentt_1_1basic__container.html#ab7b4e2cc9e908f3bb4742e6a42913ede">const_iterator</a> <a class="el" href="structentt_1_1basic__container.html">entt::basic_container</a>&lt; Container &gt;::cend </td>
<td>(</td>
<td class="paramtype">const Container &amp;&#160;</td>
<td class="paramname"><em>cont</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator past the last element of the given container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cont</td><td>The container for which to return the iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator past the last element of the given container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00086">86</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a4e15a46760784c7534b2b4271a5b192c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e15a46760784c7534b2b4271a5b192c">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Container &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structentt_1_1basic__container.html#a980602ee3d88568dfbe10e37cf96077c">iterator</a> <a class="el" href="structentt_1_1basic__container.html">entt::basic_container</a>&lt; Container &gt;::end </td>
<td>(</td>
<td class="paramtype">Container &amp;&#160;</td>
<td class="paramname"><em>cont</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator past the last element of the given container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cont</td><td>The container for which to return the iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator past the last element of the given container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00077">77</a> of file <a class="el" href="container_8hpp_source.html">container.hpp</a>.</p>
</div>
</div>
<a id="a1361e8f4689de3ab5b0dcaebaf00eed1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1361e8f4689de3ab5b0dcaebaf00eed1">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Container &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structentt_1_1basic__container.html#a22e81e6f0d46434a0b5cb2c2d98d8e60">size_type</a> <a class="el" href="structentt_1_1basic__container.html">entt::basic_container</a>&lt; Container &gt;::size </td>
<td>(</td>
<td class="paramtype">const Container &amp;&#160;</td>
<td class="paramname"><em>cont</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size of the given container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cont</td><td>The container for which to return the size. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The size of the given container. </dd></dl>
<p class="definition">Definition at line <a class="el" href="container_8hpp_source.html#l00050">50</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="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink