add Doxygen documentation
[o-du/phy.git] / docs / API / struct_block_float_compander_1_1_compressed_data.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: CompressedData Struct 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 id="nav-path" class="navpath">
61   <ul>
62 <li class="navelem"><a class="el" href="namespace_block_float_compander.html">BlockFloatCompander</a></li><li class="navelem"><a class="el" href="struct_block_float_compander_1_1_compressed_data.html">CompressedData</a></li>  </ul>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="summary">
67 <a href="#pub-attribs">Data Fields</a>  </div>
68   <div class="headertitle">
69 <div class="title">CompressedData Struct Reference</div>  </div>
70 </div><!--header-->
71 <div class="contents">
72
73 <p><code>#include &lt;<a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>&gt;</code></p>
74 <div class="dynheader">
75 Collaboration diagram for CompressedData:</div>
76 <div class="dyncontent">
77 <div class="center"><img src="struct_block_float_compander_1_1_compressed_data__coll__graph.png" border="0" usemap="#_compressed_data_coll__map" alt="Collaboration graph"/></div>
78 </div>
79 <table class="memberdecls">
80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
81 Data Fields</h2></td></tr>
82 <tr class="memitem:a1ba10aad9e5d2d0c430ced60a4e5083e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_compressed_data.html#a1ba10aad9e5d2d0c430ced60a4e5083e">dataCompressedDataOut</a> [k_numSampsCompressed]</td></tr>
83 <tr class="memdesc:a1ba10aad9e5d2d0c430ced60a4e5083e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compressed data.  <a href="#a1ba10aad9e5d2d0c430ced60a4e5083e">More...</a><br /></td></tr>
84 <tr class="separator:a1ba10aad9e5d2d0c430ced60a4e5083e"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:ab2fd68d067a2e45c839584d0985a7953"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_compressed_data.html#ab2fd68d067a2e45c839584d0985a7953">dataCompressed</a></td></tr>
86 <tr class="separator:ab2fd68d067a2e45c839584d0985a7953"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:ad88e9475d4e269108bb716a1cf5f0d40"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_compressed_data.html#ad88e9475d4e269108bb716a1cf5f0d40">iqWidth</a></td></tr>
88 <tr class="memdesc:ad88e9475d4e269108bb716a1cf5f0d40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of mantissa including sign bit.  <a href="#ad88e9475d4e269108bb716a1cf5f0d40">More...</a><br /></td></tr>
89 <tr class="separator:ad88e9475d4e269108bb716a1cf5f0d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 </table>
91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92 <div class="textblock">
93 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00060">60</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
94 </div><h2 class="groupheader">Field Documentation</h2>
95 <a id="ab2fd68d067a2e45c839584d0985a7953"></a>
96 <h2 class="memtitle"><span class="permalink"><a href="#ab2fd68d067a2e45c839584d0985a7953">&#9670;&nbsp;</a></span>dataCompressed</h2>
97
98 <div class="memitem">
99 <div class="memproto">
100       <table class="memname">
101         <tr>
102           <td class="memname"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> uint8_t* dataCompressed</td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106
107 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00064">64</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
108
109 </div>
110 </div>
111 <a id="a1ba10aad9e5d2d0c430ced60a4e5083e"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#a1ba10aad9e5d2d0c430ced60a4e5083e">&#9670;&nbsp;</a></span>dataCompressedDataOut</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116       <table class="memname">
117         <tr>
118           <td class="memname"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> uint8_t dataCompressedDataOut[k_numSampsCompressed]</td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122
123 <p>Compressed data. </p>
124
125 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00063">63</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
126
127 </div>
128 </div>
129 <a id="ad88e9475d4e269108bb716a1cf5f0d40"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#ad88e9475d4e269108bb716a1cf5f0d40">&#9670;&nbsp;</a></span>iqWidth</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname">int iqWidth</td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 <p>Size of mantissa including sign bit. </p>
142
143 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00066">66</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
144
145 </div>
146 </div>
147 <hr/>The documentation for this struct was generated from the following file:<ul>
148 <li><a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a></li>
149 </ul>
150 </div><!-- contents -->
151 <!-- start footer part -->
152 <hr class="footer"/><address class="footer"><small>
153 Generated by &#160;<a href="http://www.doxygen.org/index.html">
154 <img class="footer" src="doxygen.png" alt="doxygen"/>
155 </a> 1.8.13
156 </small></address>
157 </body>
158 </html>