root/doc/html/classitpp_1_1Gold.html @ 353

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

doc

RevLine 
[353]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::Gold 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_1Gold.html">Gold</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Gold Class Reference<br>
72<small>
73[<a class="el" href="group__sequence.html">Sequences</a>]</small>
74</h1><!-- doxytag: class="itpp::Gold" --><a class="el" href="classitpp_1_1Gold.html" title="Gold Sequences.">Gold</a> Sequences. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="sequence_8h-source.html">sequence.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Gold-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#339ffa5ba7198a79c6a50055cc5e4e45">Gold</a> (int degree)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor.  <a href="#339ffa5ba7198a79c6a50055cc5e4e45"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4398c2520457b9f12f667eda12f04d6"></a><!-- doxytag: member="itpp::Gold::Gold" ref="a4398c2520457b9f12f667eda12f04d6" args="(const bvec &amp;mseq1_connections, const bvec &amp;mseq2_connections)" -->
88&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#a4398c2520457b9f12f667eda12f04d6">Gold</a> (const bvec &amp;mseq1_connections, const bvec &amp;mseq2_connections)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input connect_polynomials=1+g1*D+g2*D^2+...+gr*D^r in bvec format [g0,g1,...,gr]. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed2b116aa54ef11e539664ac2dbd99d9"></a><!-- doxytag: member="itpp::Gold::Gold" ref="ed2b116aa54ef11e539664ac2dbd99d9" args="(const ivec &amp;mseq1_connections, const ivec &amp;mseq2_connections)" -->
92&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#ed2b116aa54ef11e539664ac2dbd99d9">Gold</a> (const ivec &amp;mseq1_connections, const ivec &amp;mseq2_connections)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input connect_polynomials=1+g1*D+g2*D^2+...+gr*D^r in octal format. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7686ff53c1a732f711e985fdb2c0d779"></a><!-- doxytag: member="itpp::Gold::set_state" ref="7686ff53c1a732f711e985fdb2c0d779" args="(const bvec &amp;state1, const bvec &amp;state2)" -->
96void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#7686ff53c1a732f711e985fdb2c0d779">set_state</a> (const bvec &amp;state1, const bvec &amp;state2)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set state (contents in the shift registers) in bvec format. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29258de44b14bc2d0dff67d62b5b0e73"></a><!-- doxytag: member="itpp::Gold::set_state" ref="29258de44b14bc2d0dff67d62b5b0e73" args="(const ivec &amp;state1, const ivec &amp;state2)" -->
100void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#29258de44b14bc2d0dff67d62b5b0e73">set_state</a> (const ivec &amp;state1, const ivec &amp;state2)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set state (contents in the shift registers) in octal format. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bbcd0420d216bcdaff0f6e73d974e6e1"></a><!-- doxytag: member="itpp::Gold::shift" ref="bbcd0420d216bcdaff0f6e73d974e6e1" args="(void)" -->
104<a class="el" href="classitpp_1_1bin.html">bin</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#bbcd0420d216bcdaff0f6e73d974e6e1">shift</a> (void)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift one step and output binary symbol. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6bf4989414ecf37d84e5059ef8064694"></a><!-- doxytag: member="itpp::Gold::shift" ref="6bf4989414ecf37d84e5059ef8064694" args="(int no_shifts)" -->
108bvec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#6bf4989414ecf37d84e5059ef8064694">shift</a> (int no_shifts)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift no_shifts steps and output bvec. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="03c25591def454f8f37f3f4dd1061c9b"></a><!-- doxytag: member="itpp::Gold::get_sequence_length" ref="03c25591def454f8f37f3f4dd1061c9b" args="(void)" -->
112int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#03c25591def454f8f37f3f4dd1061c9b">get_sequence_length</a> (void)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the length (period) of a Gold-sequence. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Gold.html#d0b3acdae7420978a7a8114513a1e92d">get_family</a> (void)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the code family.  <a href="#d0b3acdae7420978a7a8114513a1e92d"></a><br></td></tr>
118</table>
119<hr><a name="_details"></a><h2>Detailed Description</h2>
120<a class="el" href="classitpp_1_1Gold.html" title="Gold Sequences.">Gold</a> Sequences. <hr><h2>Constructor &amp; Destructor Documentation</h2>
121<a class="anchor" name="339ffa5ba7198a79c6a50055cc5e4e45"></a><!-- doxytag: member="itpp::Gold::Gold" ref="339ffa5ba7198a79c6a50055cc5e4e45" args="(int degree)" -->
122<div class="memitem">
123<div class="memproto">
124      <table class="memname">
125        <tr>
126          <td class="memname">itpp::Gold::Gold           </td>
127          <td>(</td>
128          <td class="paramtype">int&nbsp;</td>
129          <td class="paramname"> <em>degree</em>          </td>
130          <td>&nbsp;)&nbsp;</td>
131          <td></td>
132        </tr>
133      </table>
134</div>
135<div class="memdoc">
136
137<p>
138Class constructor.
139<p>
140Automatic selection of a preferred pair of connections. Just give the degree <img class="formulaInl" alt="$N = 2^{deg} - 1$" src="form_309.png"> where <img class="formulaInl" alt="$deg = \{ 5, 7, 8, 9 \}$" src="form_310.png">. Only one pair is available for each degree.
141<p>References <a class="el" href="sequence_8h-source.html#l00126">itpp::LFSR::get_length()</a>, <a class="el" href="itassert_8h-source.html#l00126">it_error</a>, <a class="el" href="log__exp_8h-source.html#l00053">itpp::pow2i()</a>, and <a class="el" href="sequence_8cpp-source.html#l00047">itpp::LFSR::set_connections()</a>.</p>
142
143</div>
144</div><p>
145<hr><h2>Member Function Documentation</h2>
146<a class="anchor" name="d0b3acdae7420978a7a8114513a1e92d"></a><!-- doxytag: member="itpp::Gold::get_family" ref="d0b3acdae7420978a7a8114513a1e92d" args="(void)" -->
147<div class="memitem">
148<div class="memproto">
149      <table class="memname">
150        <tr>
151          <td class="memname"><a class="el" href="mat_8h.html#f90acd1af41bf2d1d8a4bb23662fff69">bmat</a> itpp::Gold::get_family           </td>
152          <td>(</td>
153          <td class="paramtype">void&nbsp;</td>
154          <td class="paramname">          </td>
155          <td>&nbsp;)&nbsp;</td>
156          <td></td>
157        </tr>
158      </table>
159</div>
160<div class="memdoc">
161
162<p>
163Returns the code family.
164<p>
165The <a class="el" href="classitpp_1_1Gold.html" title="Gold Sequences.">Gold</a> code family is defined by the two m-sequences (<em>mseq1</em> and <em>mseq2</em> ) and the sum of <em>mseq1</em> and all time shifts of <em>mseq2</em>. The return matric thus contain <em>N</em> + 2 rows and <em>N</em> columns, where <em>N</em> is the length of the m-sequences.
166<p>References <a class="el" href="group__convertfunc.html#g83db366182e10eb823bcd5cb0149adf3">itpp::dec2bin()</a>, <a class="el" href="sequence_8h-source.html#l00126">itpp::LFSR::get_length()</a>, <a class="el" href="sequence_8cpp-source.html#l00130">set_state()</a>, and <a class="el" href="sequence_8h-source.html#l00125">itpp::LFSR::shift()</a>.</p>
167
168</div>
169</div><p>
170<hr>The documentation for this class was generated from the following files:<ul>
171<li><a class="el" href="sequence_8h-source.html">sequence.h</a><li><a class="el" href="sequence_8cpp.html">sequence.cpp</a></ul>
172</div>
173<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
174<a href="http://www.doxygen.org/index.html">
175<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
176</body>
177</html>
Note: See TracBrowser for help on using the browser.