libosmocore-doc 0.9.0-7 / usr / share / doc / libosmocore / core / html / structosmo__conv__code.html

This file is indexed.

/usr/share/doc/libosmocore/core/html/structosmo__conv__code.html is in libosmocore-doc 0.9.0-7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!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>libosmocore: osmo_conv_code 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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">libosmocore
   &#160;<span id="projectnumber">0.9.0</span>
   </div>
   <div id="projectbrief">Osmocom core library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structosmo__conv__code.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">osmo_conv_code Struct Reference<div class="ingroups"><a class="el" href="group__conv.html">Convolutional encoding and decoding routines</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>structure describing a given convolutional code  
 <a href="structosmo__conv__code.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="conv_8h_source.html">conv.h</a>&gt;</code></p>
<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:a5867f142a7bcac29877c8fadd0fe6642"><td class="memItemLeft" align="right" valign="top"><a id="a5867f142a7bcac29877c8fadd0fe6642"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#a5867f142a7bcac29877c8fadd0fe6642">N</a></td></tr>
<tr class="memdesc:a5867f142a7bcac29877c8fadd0fe6642"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse of code rate. <br /></td></tr>
<tr class="separator:a5867f142a7bcac29877c8fadd0fe6642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4ccdcc30c6e8b8da51d3114f9efb4b1"><td class="memItemLeft" align="right" valign="top"><a id="ac4ccdcc30c6e8b8da51d3114f9efb4b1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#ac4ccdcc30c6e8b8da51d3114f9efb4b1">K</a></td></tr>
<tr class="memdesc:ac4ccdcc30c6e8b8da51d3114f9efb4b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constraint length. <br /></td></tr>
<tr class="separator:ac4ccdcc30c6e8b8da51d3114f9efb4b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a204fd8fe2393cb0addfa7cf2575d3e7c"><td class="memItemLeft" align="right" valign="top"><a id="a204fd8fe2393cb0addfa7cf2575d3e7c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#a204fd8fe2393cb0addfa7cf2575d3e7c">len</a></td></tr>
<tr class="memdesc:a204fd8fe2393cb0addfa7cf2575d3e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><h1>of data bits</h1>
<br /></td></tr>
<tr class="separator:a204fd8fe2393cb0addfa7cf2575d3e7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa024e6740f580b70e83f37b8cc7ac642"><td class="memItemLeft" align="right" valign="top"><a id="aa024e6740f580b70e83f37b8cc7ac642"></a>
enum <a class="el" href="group__conv.html#gaf0fd132530ce2b394bad052c7242590e">osmo_conv_term</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#aa024e6740f580b70e83f37b8cc7ac642">term</a></td></tr>
<tr class="memdesc:aa024e6740f580b70e83f37b8cc7ac642"><td class="mdescLeft">&#160;</td><td class="mdescRight">Termination type. <br /></td></tr>
<tr class="separator:aa024e6740f580b70e83f37b8cc7ac642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a433ea7a5d933a69d3e1ada68541da1ca"><td class="memItemLeft" align="right" valign="top"><a id="a433ea7a5d933a69d3e1ada68541da1ca"></a>
const uint8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#a433ea7a5d933a69d3e1ada68541da1ca">next_output</a> )[2]</td></tr>
<tr class="memdesc:a433ea7a5d933a69d3e1ada68541da1ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Next output array. <br /></td></tr>
<tr class="separator:a433ea7a5d933a69d3e1ada68541da1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad72a9be2805d8d3991fb62e9e470c628"><td class="memItemLeft" align="right" valign="top"><a id="ad72a9be2805d8d3991fb62e9e470c628"></a>
const uint8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#ad72a9be2805d8d3991fb62e9e470c628">next_state</a> )[2]</td></tr>
<tr class="memdesc:ad72a9be2805d8d3991fb62e9e470c628"><td class="mdescLeft">&#160;</td><td class="mdescRight">Next state array. <br /></td></tr>
<tr class="separator:ad72a9be2805d8d3991fb62e9e470c628"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad33a7333e2e298c1cfb17c85f9f04bf8"><td class="memItemLeft" align="right" valign="top"><a id="ad33a7333e2e298c1cfb17c85f9f04bf8"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#ad33a7333e2e298c1cfb17c85f9f04bf8">next_term_output</a></td></tr>
<tr class="memdesc:ad33a7333e2e298c1cfb17c85f9f04bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush termination output. <br /></td></tr>
<tr class="separator:ad33a7333e2e298c1cfb17c85f9f04bf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4746a836dc1fa382232934abd6b57590"><td class="memItemLeft" align="right" valign="top"><a id="a4746a836dc1fa382232934abd6b57590"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#a4746a836dc1fa382232934abd6b57590">next_term_state</a></td></tr>
<tr class="memdesc:a4746a836dc1fa382232934abd6b57590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush termination state. <br /></td></tr>
<tr class="separator:a4746a836dc1fa382232934abd6b57590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5f7e2e09375acddbe45ba32f8f5f6bb"><td class="memItemLeft" align="right" valign="top"><a id="aa5f7e2e09375acddbe45ba32f8f5f6bb"></a>
const int *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__conv__code.html#aa5f7e2e09375acddbe45ba32f8f5f6bb">puncture</a></td></tr>
<tr class="memdesc:aa5f7e2e09375acddbe45ba32f8f5f6bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Punctured bits indexes. <br /></td></tr>
<tr class="separator:aa5f7e2e09375acddbe45ba32f8f5f6bb"><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>structure describing a given convolutional code </p>
<p>The only required fields are N,K and the next_output/next_state arrays. The other can be left to default value of zero depending on what the code does. If 'len' is left at 0 then only the low level API can be used. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/osmocom/core/<a class="el" href="conv_8h_source.html">conv.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structosmo__conv__code.html">osmo_conv_code</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.