root/doc/html/classitpp_1_1BLERC.html @ 354

Revision 353, 8.2 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::BLERC 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_1BLERC.html">BLERC</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::BLERC Class Reference</h1><!-- doxytag: class="itpp::BLERC" -->Class for counting block error rates. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="error__counters_8h-source.html">error_counters.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1BLERC-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae8e8046a54bf84744752d4ca323fa39"></a><!-- doxytag: member="itpp::BLERC::BLERC" ref="ae8e8046a54bf84744752d4ca323fa39" args="(void)" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#ae8e8046a54bf84744752d4ca323fa39">BLERC</a> (void)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6f1f53cae71dc2b60c93229173c9bad"></a><!-- doxytag: member="itpp::BLERC::BLERC" ref="f6f1f53cae71dc2b60c93229173c9bad" args="(int blocksize)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#f6f1f53cae71dc2b60c93229173c9bad">BLERC</a> (int blocksize)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialised constructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43db2b81f9aada3bb4b0d644fa188f5e"></a><!-- doxytag: member="itpp::BLERC::set_blocksize" ref="43db2b81f9aada3bb4b0d644fa188f5e" args="(int inblocksize, bool clear=true)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#43db2b81f9aada3bb4b0d644fa188f5e">set_blocksize</a> (int inblocksize, bool clear=true)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the block size. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be58d4abce92b4b53ad614a28aac20e7"></a><!-- doxytag: member="itpp::BLERC::count" ref="be58d4abce92b4b53ad614a28aac20e7" args="(const bvec &amp;in1, const bvec &amp;in2)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#be58d4abce92b4b53ad614a28aac20e7">count</a> (const bvec &amp;in1, const bvec &amp;in2)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the number of block errors between <em>in1</em> and <em>in2</em>. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="764cc0d98a05349b8d2451be40fa3656"></a><!-- doxytag: member="itpp::BLERC::clear" ref="764cc0d98a05349b8d2451be40fa3656" args="()" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#764cc0d98a05349b8d2451be40fa3656">clear</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the block error counter. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be4f66d6b704069019220229a04cf776"></a><!-- doxytag: member="itpp::BLERC::get_errors" ref="be4f66d6b704069019220229a04cf776" args="() const " -->
102double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#be4f66d6b704069019220229a04cf776">get_errors</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of block errors. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43c524f8ba837346f91e1903be5bf5a8"></a><!-- doxytag: member="itpp::BLERC::get_corrects" ref="43c524f8ba837346f91e1903be5bf5a8" args="() const " -->
106double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#43c524f8ba837346f91e1903be5bf5a8">get_corrects</a> () const </td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of correct blocks. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="425cf6d769cec33cd27c9bc135888585"></a><!-- doxytag: member="itpp::BLERC::get_total_blocks" ref="425cf6d769cec33cd27c9bc135888585" args="() const " -->
110double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#425cf6d769cec33cd27c9bc135888585">get_total_blocks</a> () const </td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the total number of block processed. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="724ae26011a5389735bf7974775ff3ad"></a><!-- doxytag: member="itpp::BLERC::get_errorrate" ref="724ae26011a5389735bf7974775ff3ad" args="() const " -->
114double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1BLERC.html#724ae26011a5389735bf7974775ff3ad">get_errorrate</a> () const </td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the block error rate. <br></td></tr>
117</table>
118<hr><a name="_details"></a><h2>Detailed Description</h2>
119Class for counting block error rates.
120<p>
121Use this class to count block errors in binary vectors. <hr>The documentation for this class was generated from the following files:<ul>
122<li><a class="el" href="error__counters_8h-source.html">error_counters.h</a><li><a class="el" href="error__counters_8cpp.html">error_counters.cpp</a></ul>
123</div>
124<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
125<a href="http://www.doxygen.org/index.html">
126<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
127</body>
128</html>
Note: See TracBrowser for help on using the browser.