Mercurial > hg > aimc

annotate C++/api/html/CARFACCommon_8H.html @ 592:76c6b3fd0a05

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
First commit. Refer to the api [1] 'Philosophy of the implementation' for information on the approach used to implement CARFAC in C++. [1] aimc/C++/api/html/index.html
author flatmax
date Sat, 09 Feb 2013 23:53:48 +0000
parents
children 97976133eb4d
rev   line source
flatmax@592 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@592 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@592 3 <head>
flatmax@592 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@592 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@592 6 <title>CARFAC C++: CARFACCommon.H File Reference</title>
flatmax@592 7
flatmax@592 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@592 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@592 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@592 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@592 12 <script type="text/javascript" src="resize.js"></script>
flatmax@592 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@592 14 <script type="text/javascript">
flatmax@592 15 $(document).ready(initResizable);
flatmax@592 16 </script>
flatmax@592 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@592 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@592 19 <script type="text/javascript">
flatmax@592 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@592 21 </script>
flatmax@592 22
flatmax@592 23 </head>
flatmax@592 24 <body>
flatmax@592 25 <div id="top"><!-- do not remove this div! -->
flatmax@592 26
flatmax@592 27
flatmax@592 28 <div id="titlearea">
flatmax@592 29 <table cellspacing="0" cellpadding="0">
flatmax@592 30 <tbody>
flatmax@592 31 <tr style="height: 56px;">
flatmax@592 32
flatmax@592 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@592 34
flatmax@592 35
flatmax@592 36 <td style="padding-left: 0.5em;">
flatmax@592 37 <div id="projectname">CARFAC C++
flatmax@592 38
flatmax@592 39 </div>
flatmax@592 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@592 41 </td>
flatmax@592 42
flatmax@592 43
flatmax@592 44
flatmax@592 45 </tr>
flatmax@592 46 </tbody>
flatmax@592 47 </table>
flatmax@592 48 </div>
flatmax@592 49
flatmax@592 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@592 51 <script type="text/javascript">
flatmax@592 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@592 53 </script>
flatmax@592 54 <div id="navrow1" class="tabs">
flatmax@592 55 <ul class="tablist">
flatmax@592 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@592 57 <li><a href="annotated.html"><span>Classes</span></a></li>
flatmax@592 58 <li class="current"><a href="files.html"><span>Files</span></a></li>
flatmax@592 59 <li>
flatmax@592 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@592 61 <span class="left">
flatmax@592 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@592 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 65 alt=""/>
flatmax@592 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@592 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@592 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@592 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@592 70 </span><span class="right">
flatmax@592 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@592 72 </span>
flatmax@592 73 </div>
flatmax@592 74 </li>
flatmax@592 75 </ul>
flatmax@592 76 </div>
flatmax@592 77 <div id="navrow2" class="tabs2">
flatmax@592 78 <ul class="tablist">
flatmax@592 79 <li><a href="files.html"><span>File&#160;List</span></a></li>
flatmax@592 80 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
flatmax@592 81 </ul>
flatmax@592 82 </div>
flatmax@592 83 </div>
flatmax@592 84 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@592 85 <div id="nav-tree">
flatmax@592 86 <div id="nav-tree-contents">
flatmax@592 87 </div>
flatmax@592 88 </div>
flatmax@592 89 <div id="splitbar" style="-moz-user-select:none;"
flatmax@592 90 class="ui-resizable-handle">
flatmax@592 91 </div>
flatmax@592 92 </div>
flatmax@592 93 <script type="text/javascript">
flatmax@592 94 initNavTree('CARFACCommon_8H.html','');
flatmax@592 95 </script>
flatmax@592 96 <div id="doc-content">
flatmax@592 97 <div class="header">
flatmax@592 98 <div class="summary">
flatmax@592 99 <a href="#define-members">Defines</a> &#124;
flatmax@592 100 <a href="#typedef-members">Typedefs</a> </div>
flatmax@592 101 <div class="headertitle">
flatmax@592 102 <div class="title">CARFACCommon.H File Reference</div> </div>
flatmax@592 103 </div><!--header-->
flatmax@592 104 <div class="contents">
flatmax@592 105 <div class="textblock"><code>#include &lt;iostream&gt;</code><br/>
flatmax@592 106 <code>#include &lt;Eigen/Dense&gt;</code><br/>
flatmax@592 107 </div><div class="textblock"><div class="dynheader">
flatmax@592 108 Include dependency graph for CARFACCommon.H:</div>
flatmax@592 109 <div class="dyncontent">
flatmax@592 110 <div class="center"><img src="CARFACCommon_8H__incl.png" border="0" usemap="#CARFACCommon_8H" alt=""/></div>
flatmax@592 111 <map name="CARFACCommon_8H" id="CARFACCommon_8H">
flatmax@592 112 </map>
flatmax@592 113 </div>
flatmax@592 114 </div><div class="textblock"><div class="dynheader">
flatmax@592 115 This graph shows which files directly or indirectly include this file:</div>
flatmax@592 116 <div class="dyncontent">
flatmax@592 117 <div class="center"><img src="CARFACCommon_8H__dep__incl.png" border="0" usemap="#CARFACCommon_8Hdep" alt=""/></div>
flatmax@592 118 <map name="CARFACCommon_8Hdep" id="CARFACCommon_8Hdep">
flatmax@592 119 <area shape="rect" id="node3" href="Parameters_8H.html" title="Parameters.H" alt="" coords="280,83,381,112"/><area shape="rect" id="node5" href="CARParam_8H.html" title="CARParam.H" alt="" coords="343,160,444,189"/><area shape="rect" id="node35" href="AGCParam_8H.html" title="AGCParam.H" alt="" coords="95,160,196,189"/><area shape="rect" id="node40" href="IHCParam_8H.html" title="IHCParam.H" alt="" coords="220,160,319,189"/><area shape="rect" id="node45" href="Parameters_8C.html" title="Parameters.C" alt="" coords="468,160,569,189"/><area shape="rect" id="node7" href="EarComponent_8H.html" title="EarComponent.H" alt="" coords="147,237,269,267"/><area shape="rect" id="node33" href="CARParam_8C.html" title="CARParam.C" alt="" coords="416,237,517,267"/><area shape="rect" id="node9" href="AGC_8H.html" title="AGC.H" alt="" coords="45,315,109,344"/><area shape="rect" id="node21" href="CAR_8H.html" title="CAR.H" alt="" coords="133,315,197,344"/><area shape="rect" id="node26" href="IHC_8H.html" title="IHC.H" alt="" coords="221,315,280,344"/><area shape="rect" id="node31" href="EarComponent_8C.html" title="EarComponent.C" alt="" coords="304,315,427,344"/><area shape="rect" id="node11" href="AGC_8C.html" title="AGC.C" alt="" coords="5,392,69,421"/><area shape="rect" id="node13" href="Ear_8H.html" title="Ear.H" alt="" coords="93,392,149,421"/><area shape="rect" id="node15" href="Ear_8C.html" title="Ear.C" alt="" coords="52,469,108,499"/><area shape="rect" id="node17" href="Ears_8H.html" title="Ears.H" alt="" coords="132,469,193,499"/><area shape="rect" id="node19" href="Ears_8C.html" title="Ears.C" alt="" coords="132,547,193,576"/><area shape="rect" id="node23" href="CAR_8C.html" title="CAR.C" alt="" coords="173,392,237,421"/><area shape="rect" id="node29" href="IHC_8C.html" title="IHC.C" alt="" coords="261,392,320,421"/><area shape="rect" id="node38" href="AGCParam_8C.html" title="AGCParam.C" alt="" coords="21,237,123,267"/><area shape="rect" id="node43" href="IHCParam_8C.html" title="IHCParam.C" alt="" coords="293,237,392,267"/></map>
flatmax@592 120 </div>
flatmax@592 121 </div>
flatmax@592 122 <p><a href="CARFACCommon_8H_source.html">Go to the source code of this file.</a></p>
flatmax@592 123 <table class="memberdecls">
flatmax@592 124 <tr><td colspan="2"><h2><a name="define-members"></a>
flatmax@592 125 Defines</h2></td></tr>
flatmax@592 126 <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>&#160;&#160;&#160;4</td></tr>
flatmax@592 127 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of cascades in the <a class="el" href="classAGC.html">AGC</a>. <a href="#a62f6419e5a391863eb7d30a90462c239"></a><br/></td></tr>
flatmax@592 128 <tr><td colspan="2"><h2><a name="typedef-members"></a>
flatmax@592 129 Typedefs</h2></td></tr>
flatmax@592 130 <tr><td class="memItemLeft" align="right" valign="top">typedef float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a></td></tr>
flatmax@592 131 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The floating point type. <a href="#af081989b61cc5b60e85ad3d01e4af4f0"></a><br/></td></tr>
flatmax@592 132 </table>
flatmax@592 133 <hr/><h2>Define Documentation</h2>
flatmax@592 134 <a class="anchor" id="a62f6419e5a391863eb7d30a90462c239"></a><!-- doxytag: member="CARFACCommon.H::AGC_STAGE_COUNT" ref="a62f6419e5a391863eb7d30a90462c239" args="" -->
flatmax@592 135 <div class="memitem">
flatmax@592 136 <div class="memproto">
flatmax@592 137 <table class="memname">
flatmax@592 138 <tr>
flatmax@592 139 <td class="memname">#define <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>&#160;&#160;&#160;4</td>
flatmax@592 140 </tr>
flatmax@592 141 </table>
flatmax@592 142 </div>
flatmax@592 143 <div class="memdoc">
flatmax@592 144
flatmax@592 145 <p>The number of cascades in the <a class="el" href="classAGC.html">AGC</a>. </p>
flatmax@592 146
flatmax@592 147 </div>
flatmax@592 148 </div>
flatmax@592 149 <hr/><h2>Typedef Documentation</h2>
flatmax@592 150 <a class="anchor" id="af081989b61cc5b60e85ad3d01e4af4f0"></a><!-- doxytag: member="CARFACCommon.H::FP_TYPE" ref="af081989b61cc5b60e85ad3d01e4af4f0" args="" -->
flatmax@592 151 <div class="memitem">
flatmax@592 152 <div class="memproto">
flatmax@592 153 <table class="memname">
flatmax@592 154 <tr>
flatmax@592 155 <td class="memname">typedef float <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a></td>
flatmax@592 156 </tr>
flatmax@592 157 </table>
flatmax@592 158 </div>
flatmax@592 159 <div class="memdoc">
flatmax@592 160
flatmax@592 161 <p>The floating point type. </p>
flatmax@592 162
flatmax@592 163 </div>
flatmax@592 164 </div>
flatmax@592 165 </div><!-- contents -->
flatmax@592 166 </div>
flatmax@592 167 <!-- window showing the filter options -->
flatmax@592 168 <div id="MSearchSelectWindow"
flatmax@592 169 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 170 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 171 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@592 172 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Defines</a></div>
flatmax@592 173
flatmax@592 174 <!-- iframe showing the search results (closed by default) -->
flatmax@592 175 <div id="MSearchResultsWindow">
flatmax@592 176 <iframe src="javascript:void(0)" frameborder="0"
flatmax@592 177 name="MSearchResults" id="MSearchResults">
flatmax@592 178 </iframe>
flatmax@592 179 </div>
flatmax@592 180
flatmax@592 181 <div id="nav-path" class="navpath">
flatmax@592 182 <ul>
flatmax@592 183 <li class="navelem"><a class="el" href="CARFACCommon_8H.html">CARFACCommon.H</a> </li>
flatmax@592 184
flatmax@592 185 <li class="footer">Generated on Sun Feb 10 2013 10:47:45 for CARFAC C++ by
flatmax@592 186 <a href="http://www.doxygen.org/index.html">
flatmax@592 187 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@592 188 </ul>
flatmax@592 189 </div>
flatmax@592 190
flatmax@592 191
flatmax@592 192 </body>
flatmax@592 193 </html>