root/doc/html/misc_8h.html @ 353

Revision 353, 9.7 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: misc.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>misc.h File Reference</h1>Miscellaneous functions - header file. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;complex&gt;</code><br>
71<code>#include &lt;string&gt;</code><br>
72<code>#include &lt;limits&gt;</code><br>
73
74<p>
75<a href="misc_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
76<tr><td></td></tr>
77<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
78<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="9a105c6b4c93bb5f5f4e3362c91b0cae"></a><!-- doxytag: member="misc.h::operator&lt;&lt;" ref="9a105c6b4c93bb5f5f4e3362c91b0cae" args="(std::ostream &amp;os, const std::complex&lt; T &gt; &amp;x)" -->
79template&lt;class T &gt; </td></tr>
80<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacestd.html#9a105c6b4c93bb5f5f4e3362c91b0cae">std::operator&lt;&lt;</a> (std::ostream &amp;os, const std::complex&lt; T &gt; &amp;x)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output stream operator for complex numbers. <br></td></tr>
83<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="44ae44443d24a144841e821be635dbb7"></a><!-- doxytag: member="misc.h::operator&gt;&gt;" ref="44ae44443d24a144841e821be635dbb7" args="(std::istream &amp;is, std::complex&lt; T &gt; &amp;x)" -->
84template&lt;class T &gt; </td></tr>
85<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">std::istream &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacestd.html#44ae44443d24a144841e821be635dbb7">std::operator&gt;&gt;</a> (std::istream &amp;is, std::complex&lt; T &gt; &amp;x)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input stream operator for complex numbers. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gfa54458e53dce41d8404fe45376339a3"></a><!-- doxytag: member="misc.h::is_int" ref="gfa54458e53dce41d8404fe45376339a3" args="(double x)" -->
89bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscfunc.html#gfa54458e53dce41d8404fe45376339a3">itpp::is_int</a> (double x)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if x is an integer. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7fa3ce6e66b7a5cfd8a19afbaade3e07"></a><!-- doxytag: member="misc.h::is_even" ref="g7fa3ce6e66b7a5cfd8a19afbaade3e07" args="(int x)" -->
93bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscfunc.html#g7fa3ce6e66b7a5cfd8a19afbaade3e07">itpp::is_even</a> (int x)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if x is an even integer. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbb3627fd2889d7c0a0b0a732cdbee0df"></a><!-- doxytag: member="misc.h::itpp_version" ref="gbb3627fd2889d7c0a0b0a732cdbee0df" args="()" -->
97std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscfunc.html#gbb3627fd2889d7c0a0b0a732cdbee0df">itpp::itpp_version</a> ()</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns IT++ library version number, e.g. "3.7.1". <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8ba5eddf2ec659bc23fd59af00c90417"></a><!-- doxytag: member="misc.h::is_bigendian" ref="g8ba5eddf2ec659bc23fd59af00c90417" args="()" -->
101bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscfunc.html#g8ba5eddf2ec659bc23fd59af00c90417">itpp::is_bigendian</a> ()</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if machine endianness is BIG_ENDIAN. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd1f3444a5fd30325eb9dbe9f35544e6d"></a><!-- doxytag: member="misc.h::check_big_endianness" ref="gd1f3444a5fd30325eb9dbe9f35544e6d" args="()" -->
105bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__miscfunc.html#gd1f3444a5fd30325eb9dbe9f35544e6d">itpp::check_big_endianness</a> ()</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function is deprecated. Please use <a class="el" href="group__miscfunc.html#g8ba5eddf2ec659bc23fd59af00c90417" title="Returns true if machine endianness is BIG_ENDIAN.">is_bigendian()</a> instead. <br></td></tr>
108<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7851af29ec860ed8f5b6f2933c946115"></a><!-- doxytag: member="misc.h::pi" ref="7851af29ec860ed8f5b6f2933c946115" args="" -->
110const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#7851af29ec860ed8f5b6f2933c946115">itpp::pi</a> = 3.14159265358979323846</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant Pi. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c686fc6cb7a94a67dba12461bd4ece7"></a><!-- doxytag: member="misc.h::m_2pi" ref="3c686fc6cb7a94a67dba12461bd4ece7" args="" -->
114const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#3c686fc6cb7a94a67dba12461bd4ece7">itpp::m_2pi</a> = 2 * pi</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant 2*Pi. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa13f3602d96b2168009f3aa97180a57"></a><!-- doxytag: member="misc.h::eps" ref="aa13f3602d96b2168009f3aa97180a57" args="" -->
118const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#aa13f3602d96b2168009f3aa97180a57">itpp::eps</a> = std::numeric_limits&lt;double&gt;::epsilon()</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant eps. <br></td></tr>
121</table>
122<hr><a name="_details"></a><h2>Detailed Description</h2>
123Miscellaneous functions - header file.
124<p>
125<dl class="author" compact><dt><b>Author:</b></dt><dd>Tony Ottosson, Adam Piatyszek and Conrad Sanderson</dd></dl>
126-------------------------------------------------------------------------<p>
127Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
128This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
129IT++ 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>
130IT++ 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>
131You 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>
132------------------------------------------------------------------------- </div>
133<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
134<a href="http://www.doxygen.org/index.html">
135<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
136</body>
137</html>
Note: See TracBrowser for help on using the browser.