add Doxygen documentation
[o-du/phy.git] / docs / API / unioncompression__params.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: compression_params Union 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="#pub-attribs">Data Fields</a>  </div>
65   <div class="headertitle">
66 <div class="title">compression_params Union Reference</div>  </div>
67 </div><!--header-->
68 <div class="contents">
69
70 <p><code>#include &lt;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&gt;</code></p>
71 <div class="dynheader">
72 Collaboration diagram for compression_params:</div>
73 <div class="dyncontent">
74 <div class="center"><img src="unioncompression__params__coll__graph.png" border="0" usemap="#compression__params_coll__map" alt="Collaboration graph"/></div>
75 <map name="compression__params_coll__map" id="compression__params_coll__map">
76 <area shape="rect" id="node2" href="structcompression__params_1_1u__law.html" title="{u_law\n|+ compShift\l+ compBitWidth\l|}" alt="" coords="5,5,121,97"/>
77 <area shape="rect" id="node3" href="structcompression__params_1_1block__fl__point.html" title="{block_fl_point\n|+ exponent\l+ reserved\l|}" alt="" coords="145,5,248,97"/>
78 <area shape="rect" id="node4" href="structcompression__params_1_1block__scaling.html" title="{block_scaling\n|+ sblockScaler\l|}" alt="" coords="273,13,382,90"/>
79 </map>
80 </div>
81 <table class="memberdecls">
82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
83 Data Structures</h2></td></tr>
84 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1block__fl__point.html">block_fl_point</a></td></tr>
85 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1block__scaling.html">block_scaling</a></td></tr>
87 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1u__law.html">u_law</a></td></tr>
89 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 </table><table class="memberdecls">
91 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
92 Data Fields</h2></td></tr>
93 <tr class="memitem:a1cd49a68b116fdcbab85bc9140594918"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcompression__params_1_1block__fl__point.html">compression_params::block_fl_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncompression__params.html#a1cd49a68b116fdcbab85bc9140594918">blockFlPoint</a></td></tr>
94 <tr class="separator:a1cd49a68b116fdcbab85bc9140594918"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:a4cd9171274a8d8229ca026d1d6b1d133"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcompression__params_1_1block__scaling.html">compression_params::block_scaling</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncompression__params.html#a4cd9171274a8d8229ca026d1d6b1d133">blockScaling</a></td></tr>
96 <tr class="separator:a4cd9171274a8d8229ca026d1d6b1d133"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:aa01efd88da34f7d6c784886bc3f69298"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcompression__params_1_1u__law.html">compression_params::u_law</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncompression__params.html#aa01efd88da34f7d6c784886bc3f69298">uLaw</a></td></tr>
98 <tr class="separator:aa01efd88da34f7d6c784886bc3f69298"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 </table>
100 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
101 <div class="textblock">
102 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00110">110</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
103 </div><h2 class="groupheader">Field Documentation</h2>
104 <a id="a1cd49a68b116fdcbab85bc9140594918"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#a1cd49a68b116fdcbab85bc9140594918">&#9670;&nbsp;</a></span>blockFlPoint</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109       <table class="memname">
110         <tr>
111           <td class="memname">struct <a class="el" href="structcompression__params_1_1block__fl__point.html">compression_params::block_fl_point</a>  blockFlPoint</td>
112         </tr>
113       </table>
114 </div><div class="memdoc">
115
116 </div>
117 </div>
118 <a id="a4cd9171274a8d8229ca026d1d6b1d133"></a>
119 <h2 class="memtitle"><span class="permalink"><a href="#a4cd9171274a8d8229ca026d1d6b1d133">&#9670;&nbsp;</a></span>blockScaling</h2>
120
121 <div class="memitem">
122 <div class="memproto">
123       <table class="memname">
124         <tr>
125           <td class="memname">struct <a class="el" href="structcompression__params_1_1block__scaling.html">compression_params::block_scaling</a>  blockScaling</td>
126         </tr>
127       </table>
128 </div><div class="memdoc">
129
130 </div>
131 </div>
132 <a id="aa01efd88da34f7d6c784886bc3f69298"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#aa01efd88da34f7d6c784886bc3f69298">&#9670;&nbsp;</a></span>uLaw</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137       <table class="memname">
138         <tr>
139           <td class="memname">struct <a class="el" href="structcompression__params_1_1u__law.html">compression_params::u_law</a>  uLaw</td>
140         </tr>
141       </table>
142 </div><div class="memdoc">
143
144 </div>
145 </div>
146 <hr/>The documentation for this union was generated from the following file:<ul>
147 <li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a></li>
148 </ul>
149 </div><!-- contents -->
150 <!-- start footer part -->
151 <hr class="footer"/><address class="footer"><small>
152 Generated by &#160;<a href="http://www.doxygen.org/index.html">
153 <img class="footer" src="doxygen.png" alt="doxygen"/>
154 </a> 1.8.13
155 </small></address>
156 </body>
157 </html>