api largely finished, polish and comments still needed.

This commit is contained in:
2026-05-17 02:38:56 -05:00
parent 11c2ad914c
commit 2440359748
166 changed files with 17690 additions and 16 deletions

View File

@@ -0,0 +1,222 @@
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: dynamic_array Struct 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 id="projectrow">
<td id="projectalign">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdynamic__array-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dynamic_array Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="marigold__dynamic__array_8h_source.html">marigold_dynamic_array.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3b19d692a6b8539bc58551e39bf6dfaa" id="r_a3b19d692a6b8539bc58551e39bf6dfaa"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#a3b19d692a6b8539bc58551e39bf6dfaa">item_size</a></td></tr>
<tr class="separator:a3b19d692a6b8539bc58551e39bf6dfaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fec64b33dac49cedbc5888cd8e8a846" id="r_a2fec64b33dac49cedbc5888cd8e8a846"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#a2fec64b33dac49cedbc5888cd8e8a846">memory_block_pointer</a></td></tr>
<tr class="separator:a2fec64b33dac49cedbc5888cd8e8a846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac33ca1e3db1d4229852b9f36b62f2e08" id="r_ac33ca1e3db1d4229852b9f36b62f2e08"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#ac33ca1e3db1d4229852b9f36b62f2e08">starting_capacity</a></td></tr>
<tr class="separator:ac33ca1e3db1d4229852b9f36b62f2e08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633fcea60fb454a78a7a058e3bda0bbe" id="r_a633fcea60fb454a78a7a058e3bda0bbe"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#a633fcea60fb454a78a7a058e3bda0bbe">current_capacity</a></td></tr>
<tr class="separator:a633fcea60fb454a78a7a058e3bda0bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7da5f21eb2bfdeff0e05b53598185c5" id="r_ae7da5f21eb2bfdeff0e05b53598185c5"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#ae7da5f21eb2bfdeff0e05b53598185c5">current_size</a></td></tr>
<tr class="separator:ae7da5f21eb2bfdeff0e05b53598185c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a105f76026911ac2665bf25a73ecf30a6" id="r_a105f76026911ac2665bf25a73ecf30a6"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#a105f76026911ac2665bf25a73ecf30a6">owner_count</a></td></tr>
<tr class="separator:a105f76026911ac2665bf25a73ecf30a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3d42a1672d2015f89d8c607124fa3e5" id="r_aa3d42a1672d2015f89d8c607124fa3e5"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#aa3d42a1672d2015f89d8c607124fa3e5">growth_factor</a></td></tr>
<tr class="separator:aa3d42a1672d2015f89d8c607124fa3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affeb533fae8aa1d8d80abc61e3380cc1" id="r_affeb533fae8aa1d8d80abc61e3380cc1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdynamic__array.html#affeb533fae8aa1d8d80abc61e3380cc1">is_multithread_safe</a></td></tr>
<tr class="separator:affeb533fae8aa1d8d80abc61e3380cc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a633fcea60fb454a78a7a058e3bda0bbe" name="a633fcea60fb454a78a7a058e3bda0bbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a633fcea60fb454a78a7a058e3bda0bbe">&#9670;&#160;</a></span>current_capacity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dynamic_array::current_capacity</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae7da5f21eb2bfdeff0e05b53598185c5" name="ae7da5f21eb2bfdeff0e05b53598185c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7da5f21eb2bfdeff0e05b53598185c5">&#9670;&#160;</a></span>current_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dynamic_array::current_size</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa3d42a1672d2015f89d8c607124fa3e5" name="aa3d42a1672d2015f89d8c607124fa3e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3d42a1672d2015f89d8c607124fa3e5">&#9670;&#160;</a></span>growth_factor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dynamic_array::growth_factor</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="affeb533fae8aa1d8d80abc61e3380cc1" name="affeb533fae8aa1d8d80abc61e3380cc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affeb533fae8aa1d8d80abc61e3380cc1">&#9670;&#160;</a></span>is_multithread_safe</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dynamic_array::is_multithread_safe</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3b19d692a6b8539bc58551e39bf6dfaa" name="a3b19d692a6b8539bc58551e39bf6dfaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b19d692a6b8539bc58551e39bf6dfaa">&#9670;&#160;</a></span>item_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t dynamic_array::item_size</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2fec64b33dac49cedbc5888cd8e8a846" name="a2fec64b33dac49cedbc5888cd8e8a846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fec64b33dac49cedbc5888cd8e8a846">&#9670;&#160;</a></span>memory_block_pointer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* dynamic_array::memory_block_pointer</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a105f76026911ac2665bf25a73ecf30a6" name="a105f76026911ac2665bf25a73ecf30a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a105f76026911ac2665bf25a73ecf30a6">&#9670;&#160;</a></span>owner_count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short dynamic_array::owner_count</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac33ca1e3db1d4229852b9f36b62f2e08" name="ac33ca1e3db1d4229852b9f36b62f2e08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33ca1e3db1d4229852b9f36b62f2e08">&#9670;&#160;</a></span>starting_capacity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dynamic_array::starting_capacity</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>source_code/MODULE_marigold_dynamic_array/<a class="el" href="marigold__dynamic__array_8h_source.html">marigold_dynamic_array.h</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.8
</small></address>
</body>
</html>