Code Review / o-du / phy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
add Doxygen documentation
[o-du/phy.git] / docs / API / namespace_block_float_compander_b_f_w.html
diff --git a/docs/API/namespace_block_float_compander_b_f_w.html b/docs/API/namespace_block_float_compander_b_f_w.html
new file mode 100644 (file)
index 0000000..ed629a4
--- /dev/null
+++ b/docs/API/namespace_block_float_compander_b_f_w.html
@@ -0,0 +1,172 @@
+<!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: BlockFloatCompanderBFW Namespace 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="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>
+<!-- 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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">BlockFloatCompanderBFW Namespace Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">CompressedData</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">ExpandedData</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:a45cc83687ca392534168cb8f4d64182f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander_b_f_w.html#a45cc83687ca392534168cb8f4d64182f">BlockFloatCompress_Basic</a> (const <a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">ExpandedData</a> &amp;dataIn, <a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">CompressedData</a> *dataOut)</td></tr>
+<tr class="memdesc:a45cc83687ca392534168cb8f4d64182f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference compression.  <a href="#a45cc83687ca392534168cb8f4d64182f">More...</a><br /></td></tr>
+<tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander_b_f_w.html#a5f4776cd07aac0ae2d9dbd02aaba3435">BlockFloatExpand_Basic</a> (const <a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">CompressedData</a> &amp;dataIn, <a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">ExpandedData</a> *dataOut)</td></tr>
+<tr class="memdesc:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference expansion.  <a href="#a5f4776cd07aac0ae2d9dbd02aaba3435">More...</a><br /></td></tr>
+<tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="a45cc83687ca392534168cb8f4d64182f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a45cc83687ca392534168cb8f4d64182f">&#9670;&nbsp;</a></span>BlockFloatCompress_Basic()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void BlockFloatCompress_Basic </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">ExpandedData</a> &amp;&#160;</td>
+          <td class="paramname"><em>dataIn</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">BlockFloatCompanderBFW::CompressedData</a> *&#160;</td>
+          <td class="paramname"><em>dataOut</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Reference compression. </p>
+<p>Find max abs value for this RB</p>
+<p>ARS data by exponent and pack bytes in Network order This uses a sliding buffer where one or more bytes are extracted after the insertion of each compressed sample </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__compression_8cpp_source.html#l00640">640</a> of file <a class="el" href="xran__compression_8cpp_source.html">xran_compression.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph.png" border="0" usemap="#namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph" alt=""/></div>
+<map name="namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph" id="namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph">
+<area shape="rect" id="node2" href="xran__compression_8cpp.html#aa027200fc051c80b515ee8aeadf44a0e" title="xranlib_compress_avx512_bfw" alt="" coords="197,13,399,39"/>
+<area shape="rect" id="node3" href="xran__cp__api_8c.html#a848d22f9f7e5f493782bf8a9bfdb8f3a" title="xran_cp_populate_section\l_ext_1" alt="" coords="447,5,620,47"/>
+<area shape="rect" id="node4" href="c__plane__tests_8cc.html#a11a0b914a08e5375cae792dc6db08c7a" title="TEST_P" alt="" coords="668,13,740,39"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a5f4776cd07aac0ae2d9dbd02aaba3435"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5f4776cd07aac0ae2d9dbd02aaba3435">&#9670;&nbsp;</a></span>BlockFloatExpand_Basic()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void BlockFloatExpand_Basic </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">CompressedData</a> &amp;&#160;</td>
+          <td class="paramname"><em>dataIn</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">BlockFloatCompanderBFW::ExpandedData</a> *&#160;</td>
+          <td class="paramname"><em>dataOut</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Reference expansion. </p>
+<p>byteBuffer currently has enough data in it to extract a sample Shift left first to set sign bit at MSB, then shift right to sign extend down to iqWidth. Finally recast to int16. </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__compression_8cpp_source.html#l00687">687</a> of file <a class="el" href="xran__compression_8cpp_source.html">xran_compression.cpp</a>.</p>
+
+</div>
+</div>
+</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>
O-RAN DU Physical Layer