add Doxygen documentation
[o-du/phy.git] / docs / API / functions_i.html
diff --git a/docs/API/functions_i.html b/docs/API/functions_i.html
new file mode 100644 (file)
index 0000000..8b03545
--- /dev/null
@@ -0,0 +1,219 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: Data Fields</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 style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- 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="contents">
+<div class="textblock">Here is a list of all struct and union fields with links to the structures/unions they belong to:</div>
+
+<h3><a id="index_i"></a>- i -</h3><ul>
+<li>i_sample
+: <a class="el" href="structrb__map.html#ac65eb6aaf536c0ee06118898dd5bd82d">rb_map</a>
+</li>
+<li>id
+: <a class="el" href="structxran__io__cfg.html#a1e6927fa1486224044e568f9c370519b">xran_io_cfg</a>
+, <a class="el" href="structxran__io__loop__cfg.html#a1e6927fa1486224044e568f9c370519b">xran_io_loop_cfg</a>
+, <a class="el" href="structxran__section__info.html#a4fc3a0c58dfbd1e68224521185cb9384">xran_section_info</a>
+</li>
+<li>im
+: <a class="el" href="struct_c_o_m_p_l_e_x32.html#a967065f052e06d0e239b9bc56e0cc317">COMPLEX32</a>
+, <a class="el" href="structcomplex__double.html#a994624d52dcfaad836adf3f92a8d6b7d">complex_double</a>
+, <a class="el" href="structcomplex__float.html#a967065f052e06d0e239b9bc56e0cc317">complex_float</a>
+, <a class="el" href="structcomplex__half.html#a6d310439e7665c7a3ebee8be034a56d2">complex_half</a>
+, <a class="el" href="structcomplex__int16__t.html#a0a0dbf17332859821db9cbe7b4bc7183">complex_int16_t</a>
+, <a class="el" href="structcomplex__int32__t.html#affac5cb482b316df6c36ee03670fff9a">complex_int32_t</a>
+</li>
+<li>indirect_pool
+: <a class="el" href="structxran__device__ctx.html#a6708e76366bccd72d10a3161e485e0f4">xran_device_ctx</a>
+</li>
+<li>info
+: <a class="el" href="structxran__section__gen__info.html#a6ccd48a36736101737e9b419d7a3cc85">xran_section_gen_info</a>
+</li>
+<li>Init()
+: <a class="el" href="classxran_lib_wraper.html#a200da4e2209141f12cafef2380cb801a">xranLibWraper</a>
+</li>
+<li>init_test()
+: <a class="el" href="class_kernel_tests.html#abf28e5ea54fab2b0685972fe6e75560a">KernelTests</a>
+</li>
+<li>insert()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a3558f3419aa799071e6ce6114da3d2ec">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>instance_id
+: <a class="el" href="struct___runtime_config.html#a7c41b87d5f4518f22797b56e183c6d81">_RuntimeConfig</a>
+</li>
+<li>io_cfg
+: <a class="el" href="structxran__ethdi__ctx.html#a84a901e82e979ec87118ff865b311a1f">xran_ethdi_ctx</a>
+, <a class="el" href="structxran__fh__init.html#a8a5462b0059073e90d42f8bfa066d566">xran_fh_init</a>
+</li>
+<li>io_core
+: <a class="el" href="struct___runtime_config.html#a32d3d485cc059e8003d9d99f0707f2e1">_RuntimeConfig</a>
+</li>
+<li>iq_bfw_buffer_size_dl
+: <a class="el" href="classxran_lib_wraper.html#ad1ab6e8c4efe2805b76180b34ce4c019">xranLibWraper</a>
+</li>
+<li>iq_bfw_buffer_size_ul
+: <a class="el" href="classxran_lib_wraper.html#a8b3edaed699562559db744c8e2aa36b1">xranLibWraper</a>
+</li>
+<li>iq_buff_len
+: <a class="el" href="structxran__cp__rbmap__list.html#a4743b4bb624ddabc85672184430d9d70">xran_cp_rbmap_list</a>
+</li>
+<li>iq_buff_offset
+: <a class="el" href="structxran__cp__rbmap__list.html#abde12917f82ac21d3b35f788384b69d4">xran_cp_rbmap_list</a>
+</li>
+<li>iq_buffer_len
+: <a class="el" href="structxran__section__desc.html#ae55ac9499e5406559ad2ff0376dd0a68">xran_section_desc</a>
+</li>
+<li>iq_buffer_offset
+: <a class="el" href="structxran__section__desc.html#a4d1fb35f3f2d9f3556fbd1761a167255">xran_section_desc</a>
+</li>
+<li>iq_offset
+: <a class="el" href="class_u__plane_check.html#ad3c8fd8da54a8693b6ea41565af2ad19">U_planeCheck</a>
+, <a class="el" href="class_u__plane_perf.html#ad3c8fd8da54a8693b6ea41565af2ad19">U_planePerf</a>
+</li>
+<li>iqOrder
+: <a class="el" href="structxran__ru__config.html#ad1b1309ca2645e24fa201f8decae1988">xran_ru_config</a>
+</li>
+<li>iqswap
+: <a class="el" href="struct___runtime_config.html#ad08d1758ebedc3f28561b3f4d1c51645">_RuntimeConfig</a>
+</li>
+<li>iqWidth
+: <a class="el" href="struct_block_float_compander_1_1_compressed_data.html#ad88e9475d4e269108bb716a1cf5f0d40">CompressedData</a>
+, <a class="el" href="struct_block_float_compander_1_1_expanded_data.html#ad88e9475d4e269108bb716a1cf5f0d40">ExpandedData</a>
+, <a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html#ad88e9475d4e269108bb716a1cf5f0d40">CompressedData</a>
+, <a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html#ad88e9475d4e269108bb716a1cf5f0d40">ExpandedData</a>
+, <a class="el" href="structxran__cp__header__params.html#a1520b1ef6131bff6c14b88d849c266c5">xran_cp_header_params</a>
+, <a class="el" href="structxran__cp__rbmap__list.html#a1520b1ef6131bff6c14b88d849c266c5">xran_cp_rbmap_list</a>
+, <a class="el" href="structxran__prb__elm.html#a36f5a0cedd274c3ec55f81535f06e0de">xran_prb_elm</a>
+, <a class="el" href="structxran__ru__config.html#a1520b1ef6131bff6c14b88d849c266c5">xran_ru_config</a>
+, <a class="el" href="structxran__section__info.html#a1520b1ef6131bff6c14b88d849c266c5">xran_section_info</a>
+, <a class="el" href="structxranlib__compress__request.html#a36f5a0cedd274c3ec55f81535f06e0de">xranlib_compress_request</a>
+, <a class="el" href="structxranlib__decompress__request.html#a36f5a0cedd274c3ec55f81535f06e0de">xranlib_decompress_request</a>
+</li>
+<li>is_array()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a286a1af9e72e4e41a359b6d01a7b9be9">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_boolean()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a3f27b4908e7f73e1028bf681f0e25258">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_cpenable()
+: <a class="el" href="classxran_lib_wraper.html#a5855fc30031ba49b7375526f7cda0ff7">xranLibWraper</a>
+</li>
+<li>is_discarded()
+: <a class="el" href="classnlohmann_1_1basic__json.html#aa3755192d05bc50d680919b259b69305">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_dynamicsection()
+: <a class="el" href="classxran_lib_wraper.html#a1d92eb426fc3269a180f07289f738d1a">xranLibWraper</a>
+</li>
+<li>is_null()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a5343c52ade262b120e6cdafb516f1f65">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_number()
+: <a class="el" href="classnlohmann_1_1basic__json.html#ac752edf4fd63784b587cd7116a407392">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_number_float()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a8bcacf4b2549df21e7e3d6d5882bc26f">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_number_integer()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a8719f77e4b63e026597607704740f89a">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_number_unsigned()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a1899915ea90604c5bf3204c2a270d44e">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_object()
+: <a class="el" href="classnlohmann_1_1basic__json.html#ad6a2a9425ea3806424417c2e7dcdbc01">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_prachenable()
+: <a class="el" href="classxran_lib_wraper.html#a5b5d9e46f23728cf8901e177fbf1e32b">xranLibWraper</a>
+</li>
+<li>is_primitive()
+: <a class="el" href="classnlohmann_1_1basic__json.html#ae5e7e83e05bf011781326a00fdf7a733">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_running()
+: <a class="el" href="classxran_lib_wraper.html#a61da580fc69a74f3ef17956ba5fd88a0">xranLibWraper</a>
+</li>
+<li>is_string()
+: <a class="el" href="classnlohmann_1_1basic__json.html#adef80b7704d7b8d8ed6bcf3c69fe9568">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>is_structured()
+: <a class="el" href="classnlohmann_1_1basic__json.html#abc946f8df0445e62162a6633a444ae79">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>isPRACHslot
+: <a class="el" href="structxran__prach__cp__config.html#a3b00fdd9e145b9c7be29aa35c6f94fe1">xran_prach_cp_config</a>
+</li>
+<li>iter_impl()
+: <a class="el" href="classnlohmann_1_1basic__json_1_1iter__impl.html#a4d3a3cd2792cdef6cd69694681ba5976">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::iter_impl&lt; U &gt;</a>
+</li>
+<li>iterator
+: <a class="el" href="classnlohmann_1_1basic__json.html#a241034c44708fd20925e6ae18efcfb56">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>iterator_category
+: <a class="el" href="classnlohmann_1_1basic__json_1_1iter__impl.html#a13fe24ca0865b19fbff05ff095c4ffea">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;::iter_impl&lt; U &gt;</a>
+</li>
+<li>iterator_wrapper()
+: <a class="el" href="classnlohmann_1_1basic__json.html#ace1114c14ae7995319c4248e5fb77f39">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>