diff options
| author | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
|---|---|---|
| committer | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
| commit | ae050524109f1ce827962665436ef7430f2ac479 (patch) | |
| tree | a087fe0c77570971dd7979f2757426c24e91afc7 /23.02/classarmnn_1_1_cl_context_serializer.xhtml | |
| parent | 8d2ca734165a068478df7cffa46185680b05cd20 (diff) | |
| download | armnn-ae050524109f1ce827962665436ef7430f2ac479.tar.gz | |
IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub.
* Updating Doxygen documentation for 23.02 release.
Signed-off-by: David Monahan <david.monahan@arm.com>
Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82
Diffstat (limited to '23.02/classarmnn_1_1_cl_context_serializer.xhtml')
| -rw-r--r-- | 23.02/classarmnn_1_1_cl_context_serializer.xhtml | 73 |
1 files changed, 49 insertions, 24 deletions
diff --git a/23.02/classarmnn_1_1_cl_context_serializer.xhtml b/23.02/classarmnn_1_1_cl_context_serializer.xhtml index 36c58553b7..9fe1b6100f 100644 --- a/23.02/classarmnn_1_1_cl_context_serializer.xhtml +++ b/23.02/classarmnn_1_1_cl_context_serializer.xhtml @@ -8,7 +8,7 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="generator" content="Doxygen 1.8.17"/> <meta name="robots" content="NOINDEX, NOFOLLOW" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ArmNN: ClContextSerializer Class Reference</title> @@ -19,9 +19,6 @@ <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); -</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> @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); -</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +</script> +<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="stylesheet.css" rel="stylesheet" type="text/css"/> </head> @@ -51,18 +49,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -76,7 +77,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('classarmnn_1_1_cl_context_serializer.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classarmnn_1_1_cl_context_serializer.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -111,10 +114,10 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a98565c90862c879b731128512377efb6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a98565c90862c879b731128512377efb6">~ClContextSerializer</a> ()=default</td></tr> <tr class="separator:a98565c90862c879b731128512377efb6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94">Serialize</a> (const arm_compute::CLCompileContext &clCompileContext)</td></tr> -<tr class="memdesc:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="mdescLeft"> </td><td class="mdescRight">Serializes the CLCompileContext built-in programs. <a href="#a4a280cb5af0dc71c4dd665e2d12c4c94">More...</a><br /></td></tr> +<tr class="memdesc:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="mdescLeft"> </td><td class="mdescRight">Serializes the CLCompileContext built-in programs. <a href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94">More...</a><br /></td></tr> <tr class="separator:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a049d34980f9dd0a518f9781822a718c4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4">SaveSerializedToStream</a> (std::ostream &stream)</td></tr> -<tr class="memdesc:a049d34980f9dd0a518f9781822a718c4"><td class="mdescLeft"> </td><td class="mdescRight">Serializes the ClContext to the stream. <a href="#a049d34980f9dd0a518f9781822a718c4">More...</a><br /></td></tr> +<tr class="memdesc:a049d34980f9dd0a518f9781822a718c4"><td class="mdescLeft"> </td><td class="mdescRight">Serializes the ClContext to the stream. <a href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4">More...</a><br /></td></tr> <tr class="separator:a049d34980f9dd0a518f9781822a718c4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> @@ -198,11 +201,12 @@ Public Member Functions</h2></td></tr> <dl class="section return"><dt>Returns</dt><dd>true if ClContext is Serialized to the Stream, false otherwise </dd></dl> <p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.xhtml#l00049">49</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.xhtml">ClContextSerializer.cpp</a>.</p> - -<p class="reference">References <a class="el" href="_numeric_cast_8hpp_source.xhtml#l00035">armnn::numeric_cast()</a>.</p> - -<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00066">ClWorkloadFactory::AfterWorkloadsCreated()</a>.</p> -<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Write to a stream</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">auto</span> bytesToWrite = <a class="code" href="namespacearmnn.xhtml#a375ca3cff9f1b005d1412dc5f3cf5b6e">armnn::numeric_cast</a><std::streamsize>(m_FlatBufferBuilder.GetSize());</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  stream.write(reinterpret_cast<const char*>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> !stream.bad();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a375ca3cff9f1b005d1412dc5f3cf5b6e"><div class="ttname"><a href="namespacearmnn.xhtml#a375ca3cff9f1b005d1412dc5f3cf5b6e">armnn::numeric_cast</a></div><div class="ttdeci">std::enable_if_t< std::is_unsigned< Source >::value &&std::is_unsigned< Dest >::value, Dest > numeric_cast(Source source)</div><div class="ttdef"><b>Definition:</b> <a href="_numeric_cast_8hpp_source.xhtml#l00035">NumericCast.hpp:35</a></div></div> +<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Write to a stream</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">auto</span> bytesToWrite = armnn::numeric_cast<std::streamsize>(m_FlatBufferBuilder.GetSize());</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  stream.write(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">></span>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> !stream.bad();</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div> </div><!-- fragment --> </div> </div> @@ -231,15 +235,33 @@ Public Member Functions</h2></td></tr> </dl> <p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.xhtml#l00023">23</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.xhtml">ClContextSerializer.cpp</a>.</p> - +<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Get map of built programs from clCompileContext</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::map<std::string, cl::Program> builtProgramsMap = clCompileContext.get_built_programs();</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span> (builtProgramsMap.empty())</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(warning) << <span class="stringliteral">"There are no built programs to be serialised."</span>;</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span>;</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Create Flatbuffer CL Programs</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::vector<flatbuffers::Offset<armnn::Program>> clPrograms;</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>& program : builtProgramsMap)</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::vector<std::vector<uint8_t>> binaries = program.second.getInfo<CL_PROGRAM_BINARIES>();</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  clPrograms.push_back(<a class="code" href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">CreateProgram</a>(m_FlatBufferBuilder,</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  m_FlatBufferBuilder.CreateString(program.first),</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  m_FlatBufferBuilder.CreateVector(binaries[0])));</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Create Flatbuffer CLContext</span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">auto</span> clContext = <a class="code" href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">CreateClContext</a>(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  m_FlatBufferBuilder.Finish(clContext);</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div> +</div><!-- fragment --> <p class="reference">References <a class="el" href="_logging_8hpp_source.xhtml#l00212">ARMNN_LOG</a>, <a class="el" href="_cl_context_schema__generated_8h_source.xhtml#l00057">armnn::CreateClContext()</a>, <a class="el" href="_cl_context_schema__generated_8h_source.xhtml#l00118">armnn::CreateProgram()</a>, and <a class="el" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::warning</a>.</p> -<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00066">ClWorkloadFactory::AfterWorkloadsCreated()</a>.</p> -<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Get map of built programs from clCompileContext</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::map<std::string, cl::Program> builtProgramsMap = clCompileContext.get_built_programs();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span> (builtProgramsMap.empty())</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(<a class="code" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">warning</a>) << <span class="stringliteral">"There are no built programs to be serialised."</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Create Flatbuffer CL Programs</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::vector<flatbuffers::Offset<armnn::Program>> clPrograms;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>& program : builtProgramsMap)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::vector<std::vector<uint8_t>> binaries = program.second.getInfo<CL_PROGRAM_BINARIES>();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  clPrograms.push_back(<a class="code" href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">CreateProgram</a>(m_FlatBufferBuilder,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  m_FlatBufferBuilder.CreateString(program.first),</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  m_FlatBufferBuilder.CreateVector(binaries[0])));</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Create Flatbuffer CLContext</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">auto</span> clContext = <a class="code" href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">CreateClContext</a>(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  m_FlatBufferBuilder.Finish(clContext);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a0f37510801ba4f2500e4e9558c81f93c"><div class="ttname"><a href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">armnn::CreateProgram</a></div><div class="ttdeci">flatbuffers::Offset< Program > CreateProgram(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::String > name=0, flatbuffers::Offset< flatbuffers::Vector< uint8_t >> binary=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00118">ClContextSchema_generated.h:118</a></div></div> -<div class="ttc" id="_logging_8hpp_xhtml_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.xhtml#l00212">Logging.hpp:212</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml_a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd"><div class="ttname"><a href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::BoostLogSeverityMapping::warning</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml_ac845f99ae84c2fcf016b676769da7c51"><div class="ttname"><a href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">armnn::CreateClContext</a></div><div class="ttdeci">flatbuffers::Offset< ClContext > CreateClContext(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::Vector< flatbuffers::Offset< armnn::Program >>> programs=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00057">ClContextSchema_generated.h:57</a></div></div> -</div><!-- fragment --> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> @@ -248,13 +270,16 @@ Public Member Functions</h2></td></tr> </ul> </div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="anamespacearmnn_xhtml_a0f37510801ba4f2500e4e9558c81f93c"><div class="ttname"><a href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">armnn::CreateProgram</a></div><div class="ttdeci">flatbuffers::Offset< Program > CreateProgram(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::String > name=0, flatbuffers::Offset< flatbuffers::Vector< uint8_t >> binary=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00118">ClContextSchema_generated.h:118</a></div></div> +<div class="ttc" id="anamespacearmnn_xhtml_ac845f99ae84c2fcf016b676769da7c51"><div class="ttname"><a href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">armnn::CreateClContext</a></div><div class="ttdeci">flatbuffers::Offset< ClContext > CreateClContext(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::Vector< flatbuffers::Offset< armnn::Program >>> programs=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00057">ClContextSchema_generated.h:57</a></div></div> +<div class="ttc" id="a_logging_8hpp_xhtml_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.xhtml#l00212">Logging.hpp:212</a></div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml">ClContextSerializer</a></li> - <li class="footer">Generated on Fri Feb 24 2023 10:24:29 for ArmNN by + <li class="footer">Generated on Wed Mar 22 2023 15:53:04 for ArmNN by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |