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 / struct_block_float_compander_1_1_expanded_data.html
diff --git a/docs/API/struct_block_float_compander_1_1_expanded_data.html b/docs/API/struct_block_float_compander_1_1_expanded_data.html
new file mode 100644 (file)
index 0000000..6ba0cfc
--- /dev/null
+++ b/docs/API/struct_block_float_compander_1_1_expanded_data.html
@@ -0,0 +1,158 @@
+<!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: ExpandedData Struct 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 id="nav-path" class="navpath">
+  <ul>
+<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_expanded_data.html">ExpandedData</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<div class="title">ExpandedData Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for ExpandedData:</div>
+<div class="dyncontent">
+<div class="center"><img src="struct_block_float_compander_1_1_expanded_data__coll__graph.png" border="0" usemap="#_expanded_data_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:a7bc8fb83339162111a65afae4adeb8a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_expanded_data.html#a7bc8fb83339162111a65afae4adeb8a6">dataExpandedIn</a> [k_numSampsExpanded]</td></tr>
+<tr class="memdesc:a7bc8fb83339162111a65afae4adeb8a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expanded data or input data to compressor.  <a href="#a7bc8fb83339162111a65afae4adeb8a6">More...</a><br /></td></tr>
+<tr class="separator:a7bc8fb83339162111a65afae4adeb8a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a24d9d1d1b013179affb41be0424b8360"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> int16_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_expanded_data.html#a24d9d1d1b013179affb41be0424b8360">dataExpanded</a></td></tr>
+<tr class="separator:a24d9d1d1b013179affb41be0424b8360"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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_expanded_data.html#ad88e9475d4e269108bb716a1cf5f0d40">iqWidth</a></td></tr>
+<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>
+<tr class="separator:ad88e9475d4e269108bb716a1cf5f0d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00069">69</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a24d9d1d1b013179affb41be0424b8360"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a24d9d1d1b013179affb41be0424b8360">&#9670;&nbsp;</a></span>dataExpanded</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> int16_t* dataExpanded</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00073">73</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a7bc8fb83339162111a65afae4adeb8a6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7bc8fb83339162111a65afae4adeb8a6">&#9670;&nbsp;</a></span>dataExpandedIn</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a> int16_t dataExpandedIn[k_numSampsExpanded]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Expanded data or input data to compressor. </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00072">72</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ad88e9475d4e269108bb716a1cf5f0d40"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad88e9475d4e269108bb716a1cf5f0d40">&#9670;&nbsp;</a></span>iqWidth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int iqWidth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Size of mantissa including sign bit. </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00076">76</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a></li>
+</ul>
+</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