herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d6/d68/vector_8h_source.html

278 lines
34 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/std/vector.h Source File</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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<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.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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(1); });
/* @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',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d6/d68/vector_8h_source.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">vector.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d6/d68/vector_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file vector.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @brief creates and outlines a dynamic array type and its functions</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef ARC_STD_VECTOR_H_</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define ARC_STD_VECTOR_H_</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="../../d8/d77/bool_8h.html">arc/std/bool.h</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"></span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/**</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * @addtogroup ARC_Vector</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * Additional documentation for group &#39;ARC_Vector&#39;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * @{</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">*/</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"></span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">/**</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @brief a dynamic array type</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">*/</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b"> 26</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"></span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @brief a callback that allows the user to define a way to check the data stored in a vector for a match</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> *</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param[in] dataA the first data to check</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param[in] dataB the second data to check</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> *</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @return ARC_True when dataA == dataB, and ARC_False otherwise</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">*/</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116"> 36</a></span><span class="keyword">typedef</span> <a class="code hl_define" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> (* <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116">ARC_Vector_CompareDataFn</a>)(<span class="keywordtype">void</span> *dataA, <span class="keywordtype">void</span> *dataB);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">/**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @brief a callback that cleans up memory when it is removed from the vector</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> *</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param[in] data the item to destroy</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">*/</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef"> 43</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef">ARC_Vector_DestroyDataFn</a>)(<span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"></span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">/**</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @brief creates an ARC_Vector which is an &quot;expandable&quot; array</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @note for this basic implementation, the array will double in size every time the capacity is hit</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @note the array will also half in size when the array is only half filled</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param[out] vector ARC_Vector to initialize</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @param[in] compareDataFn a callback that checks if data stored in the array matches,</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * if set to NULL and ARC_Vector_Remove is called, the pointer addresses will be compared</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> * @param[in] destroyDataFn a callback that frees an item on remove or clear, can be set to NULL to do nothing</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">*/</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#gac8de583c096684695a7d862c581b78f6"> 56</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#gac8de583c096684695a7d862c581b78f6">ARC_Vector_Create</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> **vector, <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116">ARC_Vector_CompareDataFn</a> *compareDataFn, <a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef">ARC_Vector_DestroyDataFn</a> *destroyDataFn);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"></span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">/**</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @brief destroys an ARC_Vector</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> *</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @note this will not free the items stored in the vector</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @note please make sure to clear and free the children before destroying an ARC_Vector</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> *</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @param[in] vector ARC_Vector to free</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">*/</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga605bb525f6df05ec88742237e1911e47"> 66</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#ga605bb525f6df05ec88742237e1911e47">ARC_Vector_Destroy</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"></span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment">/**</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @brief adds an item to an ARC_Vector</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> *</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> * @note this will error if you add more than 4,294,967,295 items (the max value of an unsigned int 32)</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> *</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> * @param[in] vector ARC_Vector to add to</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @param[in] data data that is being added</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">*/</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga2a06c8c4c1fc1f99e08568ef92c186ae"> 76</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#ga2a06c8c4c1fc1f99e08568ef92c186ae">ARC_Vector_Add</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"></span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">/**</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> * @brief removes an item from a matching item in an ARC_Vector</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> *</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> * @note this function uses the ARC_Vector_CompareDataFn that the ARC_Vector was created with</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @note this function will not throw an error if there is no match</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * @note this function will call ARC_Vector_RemoveIndex, so it&#39;s notes are also applicable to this function</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> *</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @param[in] vector ARC_Vector to remove from</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @param[in] data matching data to remove</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment">*/</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga443185fcb80a2593b4b1f580a1b11133"> 88</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#ga443185fcb80a2593b4b1f580a1b11133">ARC_Vector_Remove</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"></span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">/**</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> * @brief removes an item from an ARC_Vector at an index</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> * @note this function will error if trying to remove an index that is outside the bounds of the ARC_Vector</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * @note this function will use ARC_Vector_DeleteDataFn if it was set in the ARC_Vector_Create function</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * @param[in] vector ARC_Vector to remove from</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> * @param[in] index position of data to remove</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment">*/</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#gab05c0f7ebefe73729d3e2c2e6e528d00"> 99</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#gab05c0f7ebefe73729d3e2c2e6e528d00">ARC_Vector_RemoveIndex</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, uint32_t index);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"></span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment">/**</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @brief clears all items from a vector</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> *</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> * @note this function will call ARC_Vector_RemoveIndex, so it&#39;s notes are also applicable to this function</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> *</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> * @param[in] vector ARC_Vector to clear</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">*/</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#gac0f528744e3da5f3334d91f6ecf542ec"> 108</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#gac0f528744e3da5f3334d91f6ecf542ec">ARC_Vector_Clear</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">/**</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * @brief gets the current size of an ARC_Vector as an unsigned 32 bit integer</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> *</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> * @param[in] vector ARC_Vector to get current size from</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"> *</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"> * @return the current size as a unsigned 32 bit integer</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">*/</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga0c72f76fed251ea51a8be057f9c89504"> 117</a></span>uint32_t <a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#ga0c72f76fed251ea51a8be057f9c89504">ARC_Vector_GetSize</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment"></span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment">/**</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * @brief gets an item from an ARC_Vector at a position index</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"> *</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment"> * @note this function will error if trying to get an index that is outside the bounds of the ARC_Vector</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"> *</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment"> * @param[in] vector ARC_Vector to get data from</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="comment"> * @param[in] index position of data to get</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"> *</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment"> * @return a void * item, or NULL on error</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment">*/</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="../../d2/d19/group__ARC__Vector.html#ga1b01ba012d6fe295e8ce1446f9a6a3a0"> 129</a></span><span class="keywordtype">void</span> *<a class="code hl_function" href="../../d2/d19/group__ARC__Vector.html#ga1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a>(<a class="code hl_typedef" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, uint32_t index);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment"></span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment">/*! @} */</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>}</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_STD_VECTOR_H_</span></div>
<div class="ttc" id="abool_8h_html"><div class="ttname"><a href="../../d8/d77/bool_8h.html">bool.h</a></div></div>
<div class="ttc" id="abool_8h_html_aad51710c999c22d9440e5ce0ba8e2c45"><div class="ttname"><a href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a></div><div class="ttdeci">#define ARC_Bool</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d77/bool_8h_source.html#l00010">bool.h:10</a></div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga069428a2ccbbed066249d48f1b0bf1ef"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef">ARC_Vector_DestroyDataFn</a></div><div class="ttdeci">void(* ARC_Vector_DestroyDataFn)(void *data)</div><div class="ttdoc">a callback that cleans up memory when it is removed from the vector</div><div class="ttdef"><b>Definition</b> <a href="#l00043">vector.h:43</a></div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga0c72f76fed251ea51a8be057f9c89504"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga0c72f76fed251ea51a8be057f9c89504">ARC_Vector_GetSize</a></div><div class="ttdeci">uint32_t ARC_Vector_GetSize(ARC_Vector *vector)</div><div class="ttdoc">gets the current size of an ARC_Vector as an unsigned 32 bit integer</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga1b01ba012d6fe295e8ce1446f9a6a3a0"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a></div><div class="ttdeci">void * ARC_Vector_Get(ARC_Vector *vector, uint32_t index)</div><div class="ttdoc">gets an item from an ARC_Vector at a position index</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga23dfcf0229206051666a31f91c8c6e1b"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a></div><div class="ttdeci">struct ARC_Vector ARC_Vector</div><div class="ttdoc">a dynamic array type</div><div class="ttdef"><b>Definition</b> <a href="#l00026">vector.h:26</a></div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga2a06c8c4c1fc1f99e08568ef92c186ae"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga2a06c8c4c1fc1f99e08568ef92c186ae">ARC_Vector_Add</a></div><div class="ttdeci">void ARC_Vector_Add(ARC_Vector *vector, void *data)</div><div class="ttdoc">adds an item to an ARC_Vector</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga4123cf094e58ae25daa9356b3a51f116"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116">ARC_Vector_CompareDataFn</a></div><div class="ttdeci">ARC_Bool(* ARC_Vector_CompareDataFn)(void *dataA, void *dataB)</div><div class="ttdoc">a callback that allows the user to define a way to check the data stored in a vector for a match</div><div class="ttdef"><b>Definition</b> <a href="#l00036">vector.h:36</a></div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga443185fcb80a2593b4b1f580a1b11133"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga443185fcb80a2593b4b1f580a1b11133">ARC_Vector_Remove</a></div><div class="ttdeci">void ARC_Vector_Remove(ARC_Vector *vector, void *data)</div><div class="ttdoc">removes an item from a matching item in an ARC_Vector</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_ga605bb525f6df05ec88742237e1911e47"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#ga605bb525f6df05ec88742237e1911e47">ARC_Vector_Destroy</a></div><div class="ttdeci">void ARC_Vector_Destroy(ARC_Vector *vector)</div><div class="ttdoc">destroys an ARC_Vector</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_gab05c0f7ebefe73729d3e2c2e6e528d00"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#gab05c0f7ebefe73729d3e2c2e6e528d00">ARC_Vector_RemoveIndex</a></div><div class="ttdeci">void ARC_Vector_RemoveIndex(ARC_Vector *vector, uint32_t index)</div><div class="ttdoc">removes an item from an ARC_Vector at an index</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_gac0f528744e3da5f3334d91f6ecf542ec"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#gac0f528744e3da5f3334d91f6ecf542ec">ARC_Vector_Clear</a></div><div class="ttdeci">void ARC_Vector_Clear(ARC_Vector *vector)</div><div class="ttdoc">clears all items from a vector</div></div>
<div class="ttc" id="agroup__ARC__Vector_html_gac8de583c096684695a7d862c581b78f6"><div class="ttname"><a href="../../d2/d19/group__ARC__Vector.html#gac8de583c096684695a7d862c581b78f6">ARC_Vector_Create</a></div><div class="ttdeci">void ARC_Vector_Create(ARC_Vector **vector, ARC_Vector_CompareDataFn *compareDataFn, ARC_Vector_DestroyDataFn *destroyDataFn)</div><div class="ttdoc">creates an ARC_Vector which is an &quot;expandable&quot; array</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../d6/d68/vector_8h.html">vector.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink