182 lines
15 KiB
HTML
182 lines
15 KiB
HTML
<!-- 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 File 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="../../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"> 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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('d6/d68/vector_8h.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="summary">
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">vector.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>creates and outlines a dynamic array type and its functions
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="../../d8/d77/bool_8h_source.html">arc/std/bool.h</a>"</code><br />
|
|
<code>#include <stdint.h></code><br />
|
|
</div>
|
|
<p><a href="../../d6/d68/vector_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga23dfcf0229206051666a31f91c8c6e1b" id="r_ga23dfcf0229206051666a31f91c8c6e1b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a></td></tr>
|
|
<tr class="memdesc:ga23dfcf0229206051666a31f91c8c6e1b"><td class="mdescLeft"> </td><td class="mdescRight">a dynamic array type <br /></td></tr>
|
|
<tr class="separator:ga23dfcf0229206051666a31f91c8c6e1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4123cf094e58ae25daa9356b3a51f116" id="r_ga4123cf094e58ae25daa9356b3a51f116"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116">ARC_Vector_CompareDataFn</a>) (void *dataA, void *dataB)</td></tr>
|
|
<tr class="memdesc:ga4123cf094e58ae25daa9356b3a51f116"><td class="mdescLeft"> </td><td class="mdescRight">a callback that allows the user to define a way to check the data stored in a vector for a match <br /></td></tr>
|
|
<tr class="separator:ga4123cf094e58ae25daa9356b3a51f116"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga069428a2ccbbed066249d48f1b0bf1ef" id="r_ga069428a2ccbbed066249d48f1b0bf1ef"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef">ARC_Vector_DestroyDataFn</a>) (void *data)</td></tr>
|
|
<tr class="memdesc:ga069428a2ccbbed066249d48f1b0bf1ef"><td class="mdescLeft"> </td><td class="mdescRight">a callback that cleans up memory when it is removed from the vector <br /></td></tr>
|
|
<tr class="separator:ga069428a2ccbbed066249d48f1b0bf1ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gac8de583c096684695a7d862c581b78f6" id="r_gac8de583c096684695a7d862c581b78f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#gac8de583c096684695a7d862c581b78f6">ARC_Vector_Create</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> **vector, <a class="el" href="../../d2/d19/group__ARC__Vector.html#ga4123cf094e58ae25daa9356b3a51f116">ARC_Vector_CompareDataFn</a> *compareDataFn, <a class="el" href="../../d2/d19/group__ARC__Vector.html#ga069428a2ccbbed066249d48f1b0bf1ef">ARC_Vector_DestroyDataFn</a> *destroyDataFn)</td></tr>
|
|
<tr class="memdesc:gac8de583c096684695a7d862c581b78f6"><td class="mdescLeft"> </td><td class="mdescRight">creates an ARC_Vector which is an "expandable" array <br /></td></tr>
|
|
<tr class="separator:gac8de583c096684695a7d862c581b78f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga605bb525f6df05ec88742237e1911e47" id="r_ga605bb525f6df05ec88742237e1911e47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga605bb525f6df05ec88742237e1911e47">ARC_Vector_Destroy</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector)</td></tr>
|
|
<tr class="memdesc:ga605bb525f6df05ec88742237e1911e47"><td class="mdescLeft"> </td><td class="mdescRight">destroys an ARC_Vector <br /></td></tr>
|
|
<tr class="separator:ga605bb525f6df05ec88742237e1911e47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2a06c8c4c1fc1f99e08568ef92c186ae" id="r_ga2a06c8c4c1fc1f99e08568ef92c186ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga2a06c8c4c1fc1f99e08568ef92c186ae">ARC_Vector_Add</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, void *data)</td></tr>
|
|
<tr class="memdesc:ga2a06c8c4c1fc1f99e08568ef92c186ae"><td class="mdescLeft"> </td><td class="mdescRight">adds an item to an ARC_Vector <br /></td></tr>
|
|
<tr class="separator:ga2a06c8c4c1fc1f99e08568ef92c186ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga443185fcb80a2593b4b1f580a1b11133" id="r_ga443185fcb80a2593b4b1f580a1b11133"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga443185fcb80a2593b4b1f580a1b11133">ARC_Vector_Remove</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, void *data)</td></tr>
|
|
<tr class="memdesc:ga443185fcb80a2593b4b1f580a1b11133"><td class="mdescLeft"> </td><td class="mdescRight">removes an item from a matching item in an ARC_Vector <br /></td></tr>
|
|
<tr class="separator:ga443185fcb80a2593b4b1f580a1b11133"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab05c0f7ebefe73729d3e2c2e6e528d00" id="r_gab05c0f7ebefe73729d3e2c2e6e528d00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#gab05c0f7ebefe73729d3e2c2e6e528d00">ARC_Vector_RemoveIndex</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, uint32_t index)</td></tr>
|
|
<tr class="memdesc:gab05c0f7ebefe73729d3e2c2e6e528d00"><td class="mdescLeft"> </td><td class="mdescRight">removes an item from an ARC_Vector at an index <br /></td></tr>
|
|
<tr class="separator:gab05c0f7ebefe73729d3e2c2e6e528d00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac0f528744e3da5f3334d91f6ecf542ec" id="r_gac0f528744e3da5f3334d91f6ecf542ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#gac0f528744e3da5f3334d91f6ecf542ec">ARC_Vector_Clear</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector)</td></tr>
|
|
<tr class="memdesc:gac0f528744e3da5f3334d91f6ecf542ec"><td class="mdescLeft"> </td><td class="mdescRight">clears all items from a vector <br /></td></tr>
|
|
<tr class="separator:gac0f528744e3da5f3334d91f6ecf542ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0c72f76fed251ea51a8be057f9c89504" id="r_ga0c72f76fed251ea51a8be057f9c89504"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga0c72f76fed251ea51a8be057f9c89504">ARC_Vector_GetSize</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector)</td></tr>
|
|
<tr class="memdesc:ga0c72f76fed251ea51a8be057f9c89504"><td class="mdescLeft"> </td><td class="mdescRight">gets the current size of an ARC_Vector as an unsigned 32 bit integer <br /></td></tr>
|
|
<tr class="separator:ga0c72f76fed251ea51a8be057f9c89504"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1b01ba012d6fe295e8ce1446f9a6a3a0" id="r_ga1b01ba012d6fe295e8ce1446f9a6a3a0"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d19/group__ARC__Vector.html#ga1b01ba012d6fe295e8ce1446f9a6a3a0">ARC_Vector_Get</a> (<a class="el" href="../../d2/d19/group__ARC__Vector.html#ga23dfcf0229206051666a31f91c8c6e1b">ARC_Vector</a> *vector, uint32_t index)</td></tr>
|
|
<tr class="memdesc:ga1b01ba012d6fe295e8ce1446f9a6a3a0"><td class="mdescLeft"> </td><td class="mdescRight">gets an item from an ARC_Vector at a position index <br /></td></tr>
|
|
<tr class="separator:ga1b01ba012d6fe295e8ce1446f9a6a3a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>creates and outlines a dynamic array type and its functions </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="../../d6/d68/vector_8h_source.html">vector.h</a>.</p>
|
|
</div></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>
|