root/doc/html/fix_8h.html @ 353

Revision 353, 8.0 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: fix.h File 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><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>fix.h File Reference</h1>Definitions of a fixed-point data type Fix. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="fix__base_8h-source.html">itpp/fixed/fix_base.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="fix__factory_8h-source.html">itpp/fixed/fix_factory.h</a>&gt;</code><br>
72
73<p>
74<a href="fix_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
75<tr><td></td></tr>
76<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Fix.html">itpp::Fix</a></td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fixed-point data type.  <a href="classitpp_1_1Fix.html#_details">More...</a><br></td></tr>
80<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf4093112bbb02b7c82af656adf439499"></a><!-- doxytag: member="fix.h::fixvec" ref="gf4093112bbb02b7c82af656adf439499" args="" -->
82typedef Vec&lt; Fix &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gf4093112bbb02b7c82af656adf439499">itpp::fixvec</a></td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Typedef for fixed-point vector type. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6edd9ee2e20c44f90a3bef4cebb07b1"></a><!-- doxytag: member="fix.h::fixmat" ref="ga6edd9ee2e20c44f90a3bef4cebb07b1" args="" -->
86typedef Mat&lt; Fix &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#ga6edd9ee2e20c44f90a3bef4cebb07b1">itpp::fixmat</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Typedef for fixed-point matrix type. <br></td></tr>
89<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb19d2a39cc57b3bd3763e9c99acc8199"></a><!-- doxytag: member="fix.h::assert_shifts" ref="gb19d2a39cc57b3bd3763e9c99acc8199" args="(const Fix &amp;x, const Fix &amp;y)" -->
91int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gb19d2a39cc57b3bd3763e9c99acc8199">itpp::assert_shifts</a> (const Fix &amp;x, const Fix &amp;y)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check that x.shift==y.shift OR x==0 OR y==0 and return the shift (for the non-zero argument). <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9fdd7dc11b39d9dfedbe5f57d904229"></a><!-- doxytag: member="fix.h::assert_shifts" ref="ga9fdd7dc11b39d9dfedbe5f57d904229" args="(const Fix &amp;x, int y)" -->
95int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#ga9fdd7dc11b39d9dfedbe5f57d904229">itpp::assert_shifts</a> (const Fix &amp;x, int y)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check that x.shift==0 OR x==0 OR y==0 and return x.shift. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbd223815e04b623a044d98fd366f3a0f"></a><!-- doxytag: member="fix.h::operator&gt;&gt;" ref="gbd223815e04b623a044d98fd366f3a0f" args="(std::istream &amp;is, Fix &amp;x)" -->
99std::istream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gbd223815e04b623a044d98fd366f3a0f">itpp::operator&gt;&gt;</a> (std::istream &amp;is, Fix &amp;x)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input bit representation and, optionally, the shift. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb0869667e0213f0278f50b990a907627"></a><!-- doxytag: member="fix.h::operator&lt;&lt;" ref="gb0869667e0213f0278f50b990a907627" args="(std::ostream &amp;os, const Fix &amp;x)" -->
103std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gb0869667e0213f0278f50b990a907627">itpp::operator&lt;&lt;</a> (std::ostream &amp;os, const Fix &amp;x)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output bit representation and, optionally, the shift. <br></td></tr>
106</table>
107<hr><a name="_details"></a><h2>Detailed Description</h2>
108Definitions of a fixed-point data type Fix.
109<p>
110<dl class="author" compact><dt><b>Author:</b></dt><dd>Johan Bergman</dd></dl>
111-------------------------------------------------------------------------<p>
112Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
113This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
114IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
115IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
116You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
117------------------------------------------------------------------------- </div>
118<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
119<a href="http://www.doxygen.org/index.html">
120<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
121</body>
122</html>
Note: See TracBrowser for help on using the browser.