saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/docs/api/c/struct_ort_allocator.html

195 lines
11 KiB
HTML
Raw Normal View History

Initial C API documentation push (#9089)
2021-09-17 00:09:25 +00:00
<!-- 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">
<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.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OnnxRuntime: OrtAllocator 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>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-156955408-1"></script><script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-156955408-1'); </script> <script type="text/javascript" src="/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="/assets/js/just-the-docs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="projectlogo"><img alt="Logo" src="ONNX_Runtime_logo - Docs.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OnnxRuntime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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>
</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 */
$(document).ready(function(){initNavTree('struct_ort_allocator.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_ort_allocator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">OrtAllocator Struct Reference<div class="ingroups"><a class="el" href="group___global.html">Global</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Memory allocation interface.
<a href="struct_ort_allocator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="onnxruntime__c__api_8h_source.html">onnxruntime_c_api.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:a508b90a31a7aec4f3ccd3d875c750b64"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_allocator.html#a508b90a31a7aec4f3ccd3d875c750b64">version</a></td></tr>
<tr class="memdesc:a508b90a31a7aec4f3ccd3d875c750b64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Must be initialized to ORT_API_VERSION. <a href="struct_ort_allocator.html#a508b90a31a7aec4f3ccd3d875c750b64">More...</a><br /></td></tr>
<tr class="separator:a508b90a31a7aec4f3ccd3d875c750b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2a68a69192b9650d9e0f0c6aeca2835"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_allocator.html#aa2a68a69192b9650d9e0f0c6aeca2835">Alloc</a> )(struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_, size_t size)</td></tr>
<tr class="memdesc:aa2a68a69192b9650d9e0f0c6aeca2835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to an allocated block of <code>size</code> bytes. <a href="struct_ort_allocator.html#aa2a68a69192b9650d9e0f0c6aeca2835">More...</a><br /></td></tr>
<tr class="separator:aa2a68a69192b9650d9e0f0c6aeca2835"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18d7888327537d09c7d3411dff4ac86a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_allocator.html#a18d7888327537d09c7d3411dff4ac86a">Free</a> )(struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_, void *p)</td></tr>
<tr class="memdesc:a18d7888327537d09c7d3411dff4ac86a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a block of memory previously allocated with <a class="el" href="struct_ort_allocator.html#aa2a68a69192b9650d9e0f0c6aeca2835" title="Returns a pointer to an allocated block of size bytes.">OrtAllocator::Alloc</a>. <a href="struct_ort_allocator.html#a18d7888327537d09c7d3411dff4ac86a">More...</a><br /></td></tr>
<tr class="separator:a18d7888327537d09c7d3411dff4ac86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a494dba3878a087a806238922472a56d5"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ort_allocator.html#a494dba3878a087a806238922472a56d5">Info</a> )(const struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_)</td></tr>
<tr class="memdesc:a494dba3878a087a806238922472a56d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to an <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> that describes this allocator. <a href="struct_ort_allocator.html#a494dba3878a087a806238922472a56d5">More...</a><br /></td></tr>
<tr class="separator:a494dba3878a087a806238922472a56d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Memory allocation interface. </p>
<p >Structure of function pointers that defines a memory allocator. This can be created and filled in by the user for custom allocators.</p>
<p >When an allocator is passed to any function, be sure that the allocator object is not destroyed until the last allocated object using it is freed. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aa2a68a69192b9650d9e0f0c6aeca2835" name="aa2a68a69192b9650d9e0f0c6aeca2835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2a68a69192b9650d9e0f0c6aeca2835">&#9670;&nbsp;</a></span>Alloc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void *( * OrtAllocator::Alloc) (struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_, size_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to an allocated block of <code>size</code> bytes. </p>
</div>
</div>
<a id="a18d7888327537d09c7d3411dff4ac86a" name="a18d7888327537d09c7d3411dff4ac86a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18d7888327537d09c7d3411dff4ac86a">&#9670;&nbsp;</a></span>Free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void( * OrtAllocator::Free) (struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_, void *p)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a block of memory previously allocated with <a class="el" href="struct_ort_allocator.html#aa2a68a69192b9650d9e0f0c6aeca2835" title="Returns a pointer to an allocated block of size bytes.">OrtAllocator::Alloc</a>. </p>
</div>
</div>
<a id="a494dba3878a087a806238922472a56d5" name="a494dba3878a087a806238922472a56d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a494dba3878a087a806238922472a56d5">&#9670;&nbsp;</a></span>Info</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const struct <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> *( * OrtAllocator::Info) (const struct <a class="el" href="struct_ort_allocator.html">OrtAllocator</a> *this_)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a pointer to an <a class="el" href="group___global.html#ga088f45e429651ac29b4a9efb4d88571a">OrtMemoryInfo</a> that describes this allocator. </p>
</div>
</div>
<a id="a508b90a31a7aec4f3ccd3d875c750b64" name="a508b90a31a7aec4f3ccd3d875c750b64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a508b90a31a7aec4f3ccd3d875c750b64">&#9670;&nbsp;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t OrtAllocator::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Must be initialized to ORT_API_VERSION. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_ort_allocator.html">OrtAllocator</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue Copy permalink