view trunk/C++/api/html/CARFACCommon_8H.html @ 597:359bcd461dd1

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 b4323584c9fa
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CARFAC C++: CARFACCommon.H File Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">CARFAC C++
   
   </div>
   <div id="projectbrief">C++ implementation of CARFAC</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('CARFACCommon_8H.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">CARFACCommon.H File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;iostream&gt;</code><br/>
<code>#include &lt;Eigen/Dense&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for CARFACCommon.H:</div>
<div class="dyncontent">
<div class="center"><img src="CARFACCommon_8H__incl.png" border="0" usemap="#CARFACCommon_8H" alt=""/></div>
<map name="CARFACCommon_8H" id="CARFACCommon_8H">
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="CARFACCommon_8H__dep__incl.png" border="0" usemap="#CARFACCommon_8Hdep" alt=""/></div>
<map name="CARFACCommon_8Hdep" id="CARFACCommon_8Hdep">
<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>
</div>
</div>
<p><a href="CARFACCommon_8H_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<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>
<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>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The floating point type.  <a href="#af081989b61cc5b60e85ad3d01e4af4f0"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a62f6419e5a391863eb7d30a90462c239"></a><!-- doxytag: member="CARFACCommon.H::AGC_STAGE_COUNT" ref="a62f6419e5a391863eb7d30a90462c239" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The number of cascades in the <a class="el" href="classAGC.html">AGC</a>. </p>

</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="af081989b61cc5b60e85ad3d01e4af4f0"></a><!-- doxytag: member="CARFACCommon.H::FP_TYPE" ref="af081989b61cc5b60e85ad3d01e4af4f0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef float <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The floating point type. </p>

</div>
</div>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="CARFACCommon_8H.html">CARFACCommon.H</a>      </li>

    <li class="footer">Generated on Sun Feb 10 2013 10:47:45 for CARFAC C++ by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>