add Doxygen documentation
[o-du/phy.git] / docs / API / namespace_block_float_compander_b_f_w.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: BlockFloatCompanderBFW Namespace Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 </div><!-- top -->
61 <div class="header">
62   <div class="summary">
63 <a href="#nested-classes">Data Structures</a> &#124;
64 <a href="#func-members">Functions</a>  </div>
65   <div class="headertitle">
66 <div class="title">BlockFloatCompanderBFW Namespace Reference</div>  </div>
67 </div><!--header-->
68 <div class="contents">
69 <table class="memberdecls">
70 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
71 Data Structures</h2></td></tr>
72 <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>
73 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <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>
75 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 </table><table class="memberdecls">
77 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
78 Functions</h2></td></tr>
79 <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>
80 <tr class="memdesc:a45cc83687ca392534168cb8f4d64182f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference compression.  <a href="#a45cc83687ca392534168cb8f4d64182f">More...</a><br /></td></tr>
81 <tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <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>
83 <tr class="memdesc:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference expansion.  <a href="#a5f4776cd07aac0ae2d9dbd02aaba3435">More...</a><br /></td></tr>
84 <tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 </table>
86 <h2 class="groupheader">Function Documentation</h2>
87 <a id="a45cc83687ca392534168cb8f4d64182f"></a>
88 <h2 class="memtitle"><span class="permalink"><a href="#a45cc83687ca392534168cb8f4d64182f">&#9670;&nbsp;</a></span>BlockFloatCompress_Basic()</h2>
89
90 <div class="memitem">
91 <div class="memproto">
92       <table class="memname">
93         <tr>
94           <td class="memname">void BlockFloatCompress_Basic </td>
95           <td>(</td>
96           <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>
97           <td class="paramname"><em>dataIn</em>, </td>
98         </tr>
99         <tr>
100           <td class="paramkey"></td>
101           <td></td>
102           <td class="paramtype"><a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">BlockFloatCompanderBFW::CompressedData</a> *&#160;</td>
103           <td class="paramname"><em>dataOut</em>&#160;</td>
104         </tr>
105         <tr>
106           <td></td>
107           <td>)</td>
108           <td></td><td></td>
109         </tr>
110       </table>
111 </div><div class="memdoc">
112
113 <p>Reference compression. </p>
114 <p>Find max abs value for this RB</p>
115 <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>
116
117 <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>
118 <div class="dynheader">
119 Here is the caller graph for this function:</div>
120 <div class="dyncontent">
121 <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>
122 <map name="namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph" id="namespace_block_float_compander_b_f_w_a45cc83687ca392534168cb8f4d64182f_icgraph">
123 <area shape="rect" id="node2" href="xran__compression_8cpp.html#aa027200fc051c80b515ee8aeadf44a0e" title="xranlib_compress_avx512_bfw" alt="" coords="197,13,399,39"/>
124 <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"/>
125 <area shape="rect" id="node4" href="c__plane__tests_8cc.html#a11a0b914a08e5375cae792dc6db08c7a" title="TEST_P" alt="" coords="668,13,740,39"/>
126 </map>
127 </div>
128
129 </div>
130 </div>
131 <a id="a5f4776cd07aac0ae2d9dbd02aaba3435"></a>
132 <h2 class="memtitle"><span class="permalink"><a href="#a5f4776cd07aac0ae2d9dbd02aaba3435">&#9670;&nbsp;</a></span>BlockFloatExpand_Basic()</h2>
133
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname">void BlockFloatExpand_Basic </td>
139           <td>(</td>
140           <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>
141           <td class="paramname"><em>dataIn</em>, </td>
142         </tr>
143         <tr>
144           <td class="paramkey"></td>
145           <td></td>
146           <td class="paramtype"><a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">BlockFloatCompanderBFW::ExpandedData</a> *&#160;</td>
147           <td class="paramname"><em>dataOut</em>&#160;</td>
148         </tr>
149         <tr>
150           <td></td>
151           <td>)</td>
152           <td></td><td></td>
153         </tr>
154       </table>
155 </div><div class="memdoc">
156
157 <p>Reference expansion. </p>
158 <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>
159
160 <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>
161
162 </div>
163 </div>
164 </div><!-- contents -->
165 <!-- start footer part -->
166 <hr class="footer"/><address class="footer"><small>
167 Generated by &#160;<a href="http://www.doxygen.org/index.html">
168 <img class="footer" src="doxygen.png" alt="doxygen"/>
169 </a> 1.8.13
170 </small></address>
171 </body>
172 </html>