add Doxygen documentation
[o-du/phy.git] / docs / API / structcompression__params_1_1u__law.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::u_law 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="unioncompression__params.html">compression_params</a></li><li class="navelem"><a class="el" href="structcompression__params_1_1u__law.html">u_law</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">compression_params::u_law Struct Reference</div>  </div>
70 </div><!--header-->
71 <div class="contents">
72
73 <p><code>#include &lt;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&gt;</code></p>
74 <div class="dynheader">
75 Collaboration diagram for compression_params::u_law:</div>
76 <div class="dyncontent">
77 <div class="center"><img src="structcompression__params_1_1u__law__coll__graph.png" border="0" usemap="#compression__params_1_1u__law_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:a6de249d83bc31f90fb2c3882cbe2e54d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1u__law.html#a6de249d83bc31f90fb2c3882cbe2e54d">compShift</a>:4</td></tr>
83 <tr class="separator:a6de249d83bc31f90fb2c3882cbe2e54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:af01aa0d561630d65396393219f4b3ed2"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1u__law.html#af01aa0d561630d65396393219f4b3ed2">compBitWidth</a>:4</td></tr>
85 <tr class="separator:af01aa0d561630d65396393219f4b3ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 </table>
87 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
88 <div class="textblock">
89 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00118">118</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
90 </div><h2 class="groupheader">Field Documentation</h2>
91 <a id="af01aa0d561630d65396393219f4b3ed2"></a>
92 <h2 class="memtitle"><span class="permalink"><a href="#af01aa0d561630d65396393219f4b3ed2">&#9670;&nbsp;</a></span>compBitWidth</h2>
93
94 <div class="memitem">
95 <div class="memproto">
96       <table class="memname">
97         <tr>
98           <td class="memname">uint8_t compBitWidth</td>
99         </tr>
100       </table>
101 </div><div class="memdoc">
102
103 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00120">120</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
104
105 </div>
106 </div>
107 <a id="a6de249d83bc31f90fb2c3882cbe2e54d"></a>
108 <h2 class="memtitle"><span class="permalink"><a href="#a6de249d83bc31f90fb2c3882cbe2e54d">&#9670;&nbsp;</a></span>compShift</h2>
109
110 <div class="memitem">
111 <div class="memproto">
112       <table class="memname">
113         <tr>
114           <td class="memname">uint8_t compShift</td>
115         </tr>
116       </table>
117 </div><div class="memdoc">
118
119 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00119">119</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
120
121 </div>
122 </div>
123 <hr/>The documentation for this struct was generated from the following file:<ul>
124 <li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a></li>
125 </ul>
126 </div><!-- contents -->
127 <!-- start footer part -->
128 <hr class="footer"/><address class="footer"><small>
129 Generated by &#160;<a href="http://www.doxygen.org/index.html">
130 <img class="footer" src="doxygen.png" alt="doxygen"/>
131 </a> 1.8.13
132 </small></address>
133 </body>
134 </html>