root/doc/html/fix__base_8h.html @ 353

Revision 353, 11.3 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_base.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_base.h File Reference</h1>Definitions of a base class for fixed-point data types. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="itcompat_8h-source.html">itpp/base/itcompat.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="misc__stat_8h-source.html">itpp/stat/misc_stat.h</a>&gt;</code><br>
72
73<p>
74<a href="fix__base_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__Base.html">itpp::Fix_Base</a></td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base class for fixed-point data types.  <a href="classitpp_1_1Fix__Base.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="gf3f12ba9f1a5ce9d50ef18fa3b65b5c3"></a><!-- doxytag: member="fix_base.h::fixrep" ref="gf3f12ba9f1a5ce9d50ef18fa3b65b5c3" args="" -->
82typedef int64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gf3f12ba9f1a5ce9d50ef18fa3b65b5c3">itpp::fixrep</a></td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Representation for fixed-point data types. <br></td></tr>
85<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g3a204def662e60bf9bb54d27db09450d">itpp::e_mode</a> { <a class="el" href="group__fixed.html#gg3a204def662e60bf9bb54d27db09450df4bddf5c0c77795974633939360e6e4a">itpp::TC</a>,
87<a class="el" href="group__fixed.html#gg3a204def662e60bf9bb54d27db09450d1d95a58e7c118ad0647ea7003a0117e3">itpp::US</a>
88 }</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sign encoding modes (aligned with SystemC).  <a href="group__fixed.html#g3a204def662e60bf9bb54d27db09450d">More...</a><br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g18d0ad4d7280177b761737a7b8b5c45d">itpp::o_mode</a> { <br>
92&nbsp;&nbsp;<a class="el" href="group__fixed.html#gg18d0ad4d7280177b761737a7b8b5c45d813f45e186a9d13fb81daea4bb065407">itpp::SAT</a>,
93<a class="el" href="group__fixed.html#gg18d0ad4d7280177b761737a7b8b5c45d6770446653ad59cf91cd0772b5ccbea5">itpp::SAT_ZERO</a>,
94<a class="el" href="group__fixed.html#gg18d0ad4d7280177b761737a7b8b5c45de24196c3a35b0922dc4b4a2217e176c8">itpp::SAT_SYM</a>,
95<a class="el" href="group__fixed.html#gg18d0ad4d7280177b761737a7b8b5c45da7ea797d8579a3e2dc82f792e16e946b">itpp::WRAP</a>,
96<br>
97&nbsp;&nbsp;<a class="el" href="group__fixed.html#gg18d0ad4d7280177b761737a7b8b5c45d9c39a7bb5f71dd0545224571e447b3b5">itpp::WRAP_SM</a>
98<br>
99 }</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overflow modes (aligned with SystemC).  <a href="group__fixed.html#g18d0ad4d7280177b761737a7b8b5c45d">More...</a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#ga644362f0b3d795ce8521326e20fed11">itpp::q_mode</a> { <br>
103&nbsp;&nbsp;<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed110db15b318ce562dba85c264687e9952b">itpp::RND</a>,
104<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed11a03622a4542173bb96b26b254cb2c11b">itpp::RND_ZERO</a>,
105<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed119f96aea79da0366c6ffb3408b6f1f922">itpp::RND_MIN_INF</a>,
106<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed1152aa6516a2be1b81a8af609685b023eb">itpp::RND_INF</a>,
107<br>
108&nbsp;&nbsp;<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed119498ed77d69cfb8ead939d8f546d80ed">itpp::RND_CONV</a>,
109<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed11e7a9a32c4edc1f185a9c278e424a8727">itpp::RND_CONV_ODD</a>,
110<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed110566af00cff42134b7f719254d07bec1">itpp::TRN</a>,
111<a class="el" href="group__fixed.html#gga644362f0b3d795ce8521326e20fed11085b9673eab1122e25d981d597daad27">itpp::TRN_ZERO</a>
112<br>
113 }</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization modes (aligned with SystemC).  <a href="group__fixed.html#ga644362f0b3d795ce8521326e20fed11">More...</a><br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#gb8f9923897b39fd81e902f3874d8cfa6">itpp::output_mode</a> { <a class="el" href="group__fixed.html#ggb8f9923897b39fd81e902f3874d8cfa63dee74675bc68511cbdba29e929b5d2e">itpp::OUTPUT_FIX</a>,
117<a class="el" href="group__fixed.html#ggb8f9923897b39fd81e902f3874d8cfa650a937efd0d92ee9cc3d2f2c123dfea4">itpp::OUTPUT_FIX_SHIFT</a>,
118<a class="el" href="group__fixed.html#ggb8f9923897b39fd81e902f3874d8cfa648d1c123d8954d51dd438f6e052f7096">itpp::OUTPUT_FLOAT</a>,
119<a class="el" href="group__fixed.html#ggb8f9923897b39fd81e902f3874d8cfa6d5a3fdf98d9a3fc1e0e5810e3811fe67">itpp::OUTPUT_FLOAT_SHIFT</a>
120 }</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output modes.  <a href="group__fixed.html#gb8f9923897b39fd81e902f3874d8cfa6">More...</a><br></td></tr>
123<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g46e967850e616363aeabd2cda5bcc159"></a><!-- doxytag: member="fix_base.h::operator&lt;&lt;" ref="g46e967850e616363aeabd2cda5bcc159" args="(std::ostream &amp;os, const output_mode &amp;o)" -->
125std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g46e967850e616363aeabd2cda5bcc159">itpp::operator&lt;&lt;</a> (std::ostream &amp;os, const output_mode &amp;o)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set output mode. <br></td></tr>
128<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g16660ef1accee4eb3c95d2807c0d7c9c"></a><!-- doxytag: member="fix_base.h::MAX_WORDLEN" ref="g16660ef1accee4eb3c95d2807c0d7c9c" args="" -->
130const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g16660ef1accee4eb3c95d2807c0d7c9c">itpp::MAX_WORDLEN</a> = 64</td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max word length. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g6c2ab04b8f8e426c8d4fb1d23c756318">itpp::UINT64_POW2</a> [64]</td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Table for fast multiplication or division by 2^n.  <a href="group__fixed.html#g6c2ab04b8f8e426c8d4fb1d23c756318"></a><br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g338980796829ae82ef35b6643a31d441"></a><!-- doxytag: member="fix_base.h::DOUBLE_POW2" ref="g338980796829ae82ef35b6643a31d441" args="[128]" -->
137const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fixed.html#g338980796829ae82ef35b6643a31d441">itpp::DOUBLE_POW2</a> [128]</td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Table for fast multiplication by 2^(n-64). <br></td></tr>
140</table>
141<hr><a name="_details"></a><h2>Detailed Description</h2>
142Definitions of a base class for fixed-point data types.
143<p>
144<dl class="author" compact><dt><b>Author:</b></dt><dd>Johan Bergman</dd></dl>
145-------------------------------------------------------------------------<p>
146Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
147This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
148IT++ 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>
149IT++ 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>
150You 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>
151------------------------------------------------------------------------- </div>
152<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
153<a href="http://www.doxygen.org/index.html">
154<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
155</body>
156</html>
Note: See TracBrowser for help on using the browser.