Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API reference v3.15.0

Browse Source
This commit is contained in:
Michele Caini
2025-03-19 15:49:42 +01:00
parent 4b4d0ab7ed
commit 1e23a11311
1334 changed files with 46058 additions and 36285 deletions
Download Patch File Download Diff File Expand all files Collapse all files
md_docs_2md_2container.html
+24 -10
View File
@@ -3,13 +3,15 @@
<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.10.0"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: Crash Course: containers</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>
@@ -23,7 +25,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.14.0</span>
<div id="projectname">EnTT<span id="projectnumber">&#160;3.15.0</span>
</div>
</td>
</tr>
@@ -31,23 +33,33 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<!-- 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');
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()"
@@ -70,11 +82,12 @@ $(function() {
</div>
</div><!-- top -->
<div id="doc-content">
<div><div class="header">
<div class="headertitle"><div class="title">Crash Course: containers</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="crash-course-containers"></a> </p>
<div class="textblock"><p><a class="anchor" id="crash-course-containers"></a></p>
<h1><a class="anchor" id="table-of-contents-1"></a>
Table of Contents</h1>
<ul>
@@ -91,10 +104,10 @@ Table of Contents</h1>
</ul>
<h1><a class="anchor" id="introduction-1"></a>
Introduction</h1>
<p>The standard C++ library offers a wide range of containers and adaptors already. It's really difficult to do better (although it's very easy to do worse, as many examples available online demonstrate).<br />
<code>EnTT</code> doesn't try in any way to replace what is offered by the standard. Quite the opposite, given the widespread use that is made of standard containers.<br />
<p>The standard C++ library offers a wide range of containers and adaptors already. It is really difficult to do better (although it is very easy to do worse, as many examples available online demonstrate).<br />
<code>EnTT</code> does not try in any way to replace what is offered by the standard. Quite the opposite, given the widespread use that is made of standard containers.<br />
However, the library also tries to fill a gap in features and functionalities by making available some containers and adaptors initially developed for internal use.</p>
<p>This section of the library is likely to grow larger over time. However, for the moment it's quite small and mainly aimed at satisfying some internal needs.<br />
<p>This section of the library is likely to grow larger over time. However, for the moment it is quite small and mainly aimed at satisfying some internal needs.<br />
For all containers and adaptors made available, full test coverage and stability over time is guaranteed as usual.</p>
<h1><a class="anchor" id="containers"></a>
Containers</h1>
@@ -124,13 +137,14 @@ Table</h2>
The <code>table</code> alias allows users to provide only the types to handle, using <code>std::vector</code> as the default sequential container.</p>
<p>Only a small set of functions is provided, although very close to what the API of the <code>std::vector</code> class offers.<br />
The internal implementation is purposely supported by a tuple of containers rather than a container of tuples. The purpose is to allow efficient access to single columns and not just access to the entire data set of the table.</p>
<p>When a row is accessed, all data are returned in the form of a tuple containing (possibly const) references to the elements of the row itself.<br />
<p>When a row is accessed, all data is returned in the form of a tuple containing (possibly const) references to the elements of the row itself.<br />
Similarly, when a table is iterated, tuples of references to table elements are returned for each row. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- 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.10.0
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>