root/doc/html/classitpp_1_1BSC.html @ 354

Revision 353, 6.9 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::BSC Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1BSC.html">BSC</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::BSC Class Reference<br>
72<small>
73[<a class="el" href="group__channels.html">Channel Modeling</a>]</small>
74</h1><!-- doxytag: class="itpp::BSC" -->A Binary Symetric Channel with crossover probability p. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="channel_8h-source.html">channel.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1BSC-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61e6df95aca3e3f2635241008c3a3e76"></a><!-- doxytag: member="itpp::BSC::BSC" ref="61e6df95aca3e3f2635241008c3a3e76" args="(double in_p=0.0)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BSC.html#61e6df95aca3e3f2635241008c3a3e76">BSC</a> (double in_p=0.0)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. Sets the error probability to p. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b3b56bdc8a33f2f4c6c1db3575fd15f"></a><!-- doxytag: member="itpp::BSC::set_prob" ref="3b3b56bdc8a33f2f4c6c1db3575fd15f" args="(double in_p)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BSC.html#3b3b56bdc8a33f2f4c6c1db3575fd15f">set_prob</a> (double in_p)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set crossover (bit error) probability. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c51f64316dfba97560a689a63d9e4ff9"></a><!-- doxytag: member="itpp::BSC::get_prob" ref="c51f64316dfba97560a689a63d9e4ff9" args="() const " -->
93double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BSC.html#c51f64316dfba97560a689a63d9e4ff9">get_prob</a> () const </td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get crossover (bit error) probability. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c6a2209d88e5f39275a6ac2a56bd19e"></a><!-- doxytag: member="itpp::BSC::operator()" ref="8c6a2209d88e5f39275a6ac2a56bd19e" args="(const bvec &amp;input)" -->
97bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BSC.html#8c6a2209d88e5f39275a6ac2a56bd19e">operator()</a> (const bvec &amp;input)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Feed <em>input</em> through the <a class="el" href="classitpp_1_1BSC.html" title="A Binary Symetric Channel with crossover probability p.">BSC</a> channel. <br></td></tr>
100</table>
101<hr><a name="_details"></a><h2>Detailed Description</h2>
102A Binary Symetric Channel with crossover probability p.
103<p>
104Input and output are of type <em>bvec</em> with 0 and 1. Example: <div class="fragment"><pre class="fragment"><span class="preprocessor">  #include &lt;<a class="code" href="itcomm_8h.html" title="Include file for the IT++ communications module.">itpp/itcomm.h</a>&gt;</span>
105  <span class="keyword">using namespace </span>itpp;
106
107  <span class="keywordtype">int</span> main() {
108 Initiate the <a class="code" href="classitpp_1_1BSC.html#61e6df95aca3e3f2635241008c3a3e76" title="Class constructor. Sets the error probability to p.">BSC</a> with <a class="code" href="group__matrix__functions.html#gc9576b3da83bec579bacbfd2cfd71b3e" title="Vector cross product. Vectors need to be of size 3.">cross</a>-over probability 0.1
109    <a class="code" href="classitpp_1_1BSC.html#61e6df95aca3e3f2635241008c3a3e76" title="Class constructor. Sets the error probability to p.">BSC</a> bsc(0.1);
110
111    bvec transmitted_bits = <a class="code" href="group__randgen.html#g5aa06887cf1fd3301b040987924068f0" title="Generates a random bit (equally likely 0s and 1s).">randb</a>(100);
112    bvec received_bits = bsc(transmitted_bits);
113  }
114</pre></div> <hr>The documentation for this class was generated from the following files:<ul>
115<li><a class="el" href="channel_8h-source.html">channel.h</a><li><a class="el" href="channel_8cpp.html">channel.cpp</a></ul>
116</div>
117<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
118<a href="http://www.doxygen.org/index.html">
119<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
120</body>
121</html>
Note: See TracBrowser for help on using the browser.