diff C++/api/html/functions.html @ 592:76c6b3fd0a05

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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/C++/api/html/functions.html	Sat Feb 09 23:53:48 2013 +0000
@@ -0,0 +1,433 @@
+<!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++: Class Members</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><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="annotated.html"><span>Class&#160;List</span></a></li>
+      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
+      <li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow3" class="tabs2">
+    <ul class="tablist">
+      <li class="current"><a href="functions.html"><span>All</span></a></li>
+      <li><a href="functions_func.html"><span>Functions</span></a></li>
+      <li><a href="functions_vars.html"><span>Variables</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow4" class="tabs3">
+    <ul class="tablist">
+      <li><a href="#index_a"><span>a</span></a></li>
+      <li><a href="#index_c"><span>c</span></a></li>
+      <li><a href="#index_d"><span>d</span></a></li>
+      <li><a href="#index_e"><span>e</span></a></li>
+      <li><a href="#index_f"><span>f</span></a></li>
+      <li><a href="#index_h"><span>h</span></a></li>
+      <li><a href="#index_i"><span>i</span></a></li>
+      <li><a href="#index_j"><span>j</span></a></li>
+      <li><a href="#index_m"><span>m</span></a></li>
+      <li><a href="#index_n"><span>n</span></a></li>
+      <li><a href="#index_o"><span>o</span></a></li>
+      <li><a href="#index_p"><span>p</span></a></li>
+      <li><a href="#index_s"><span>s</span></a></li>
+      <li><a href="#index_t"><span>t</span></a></li>
+      <li><a href="#index_v"><span>v</span></a></li>
+      <li><a href="#index_z"><span>z</span></a></li>
+      <li><a href="#index_0x7e"><span>~</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('functions.html','');
+</script>
+<div id="doc-content">
+<div class="contents">
+<div class="textblock">Here is a list of all class members with links to the classes they belong to:</div>
+
+<h3><a class="anchor" id="index_a"></a>- a -</h3><ul>
+<li>ac_corner_Hz
+: <a class="el" href="classIHCParam.html#af2edbea861df9e71c3ab097a1ea20be7">IHCParam</a>
+</li>
+<li>AGC()
+: <a class="el" href="classAGC.html#ac33d47213dd3401652c0927cc58d757f">AGC</a>
+</li>
+<li>agc
+: <a class="el" href="classEar.html#a464fb557a2852865fc29242900ee1306">Ear</a>
+</li>
+<li>AGC1_scales
+: <a class="el" href="classAGCParam.html#adf027a80d6669e72d735fff7d41801d7">AGCParam</a>
+</li>
+<li>AGC2_scales
+: <a class="el" href="classAGCParam.html#aca67e2871ee79cc96807d347acd55fe4">AGCParam</a>
+</li>
+<li>AGC_mix_coeff
+: <a class="el" href="classAGCParam.html#a968c25ad0327d2db3ebd287d661001b4">AGCParam</a>
+</li>
+<li>AGC_stage_gain
+: <a class="el" href="classAGCParam.html#a6a436005102557783fe4a0d30d3dcc51">AGCParam</a>
+</li>
+<li>AGCCoeff()
+: <a class="el" href="classAGCCoeff.html#a54c5836bc35c77d2d92411433e7db13b">AGCCoeff</a>
+</li>
+<li>AGCParam()
+: <a class="el" href="classAGCParam.html#aa822c90ba8da467c7bf31d85bf9b6f97">AGCParam</a>
+</li>
+<li>AGCState()
+: <a class="el" href="classAGCState.html#afa14ff7a1fc5a9d166be9d92faba62c4">AGCState</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
+<li>car
+: <a class="el" href="classEar.html#a59243a8664d2c7d8bd3e5153e7f55e78">Ear</a>
+</li>
+<li>CAR()
+: <a class="el" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR</a>
+</li>
+<li>CARCoeff()
+: <a class="el" href="classCARCoeff.html#ad5af264c24fe76bad741cacc6dcfad1d">CARCoeff</a>
+</li>
+<li>CARParam()
+: <a class="el" href="classCARParam.html#ae51711029751deb3eb3c5138f046ef8e">CARParam</a>
+</li>
+<li>CARState()
+: <a class="el" href="classCARState.html#ac74ab825871d5f34961fbcd72ad8b1a4">CARState</a>
+</li>
+<li>coeff
+: <a class="el" href="classEarComponent.html#a43461ed3bac1bd735ea6ddee5dda2594">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</a>
+</li>
+<li>Coefficients()
+: <a class="el" href="classCoefficients.html#afcf103e3ccf3fdcd875d0f24a5c85c9c">Coefficients</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
+<li>decimation
+: <a class="el" href="classAGCParam.html#ac7fc293748c6e7d59b91998253a68657">AGCParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_e"></a>- e -</h3><ul>
+<li>Ear()
+: <a class="el" href="classEar.html#a58d5147ee3eb694d0b2e94897dd7bf57">Ear</a>
+</li>
+<li>EarComponent()
+: <a class="el" href="classEarComponent.html#afde50640ddf67626e8e62926d491269d">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</a>
+</li>
+<li>Ears()
+: <a class="el" href="classEars.html#aee2169861ba01223604daf60b98fb95a">Ears</a>
+</li>
+<li>ERB_break_freq
+: <a class="el" href="classCARParam.html#a2a8d58983bb2562c7bb54d6f571a5265">CARParam</a>
+</li>
+<li>ERB_per_step
+: <a class="el" href="classCARParam.html#a0fb27aee54d472914e03569ba40512b7">CARParam</a>
+</li>
+<li>ERB_Q
+: <a class="el" href="classCARParam.html#a6af2a4247b1a0bb380176787d379418c">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
+<li>first_pole_theta
+: <a class="el" href="classCARParam.html#aec231a32b03a3c0603900a105ae67aca">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
+<li>high_f_damping_compression
+: <a class="el" href="classCARParam.html#a3a34b743bcdbba47a865386d08dd664e">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
+<li>ihc
+: <a class="el" href="classEar.html#ac11c4afecd6ca8353fa7d2ed4689bbf6">Ear</a>
+</li>
+<li>IHC()
+: <a class="el" href="classIHC.html#a4d945e7ba33cbfcd1bae41aef694850b">IHC</a>
+</li>
+<li>IHCCoeff()
+: <a class="el" href="classIHCCoeff.html#afa765791c8d84c75b5e3576b2fc8115b">IHCCoeff</a>
+</li>
+<li>IHCParam()
+: <a class="el" href="classIHCParam.html#aaa6f7e7799eccad40739b963a114ef02">IHCParam</a>
+</li>
+<li>IHCState()
+: <a class="el" href="classIHCState.html#a96105dcb1c0798bb249dd087f566abcb">IHCState</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_j"></a>- j -</h3><ul>
+<li>just_hwr
+: <a class="el" href="classIHCParam.html#a91ccfc182580c7af8035eee45e8f2639">IHCParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
+<li>max_zeta
+: <a class="el" href="classCARParam.html#a976b4d422b852bfa877ad9f47ccdcc86">CARParam</a>
+</li>
+<li>min_pole_Hz
+: <a class="el" href="classCARParam.html#ae30ba07457c2f7d7a9393cb7d2730af4">CARParam</a>
+</li>
+<li>min_zeta
+: <a class="el" href="classCARParam.html#a1f7a8aa68d475fc85ffbcb9d9daf62ee">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_n"></a>- n -</h3><ul>
+<li>n_stages
+: <a class="el" href="classAGCParam.html#a6cb476c916e99e227ddcfec68be66b3a">AGCParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_o"></a>- o -</h3><ul>
+<li>one_cap
+: <a class="el" href="classIHCParam.html#ac174f6cffad7fc45502c12a931f09cb6">IHCParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
+<li>param
+: <a class="el" href="classEarComponent.html#af409ffb12bafa60c09f319fa6edd48b9">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</a>
+</li>
+<li>Parameters()
+: <a class="el" href="classParameters.html#af4d94ee360ac0157d9065f78797fe9a1">Parameters</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
+<li>State()
+: <a class="el" href="classState.html#ab91bb1dd5aa6260ab2a456581daf9ec2">State</a>
+</li>
+<li>state
+: <a class="el" href="classEarComponent.html#a4ea8ae90cda6efc8b1b79550545a9210">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
+<li>tau1_in
+: <a class="el" href="classIHCParam.html#a694a674b8b53bd18a8c626b4f0882a57">IHCParam</a>
+</li>
+<li>tau1_out
+: <a class="el" href="classIHCParam.html#a375cbe06ed95b05b423aaa85fab0137d">IHCParam</a>
+</li>
+<li>tau2_in
+: <a class="el" href="classIHCParam.html#ac03d3313623218fe2e996277e1813f00">IHCParam</a>
+</li>
+<li>tau2_out
+: <a class="el" href="classIHCParam.html#af0b0d82a843dd34eb8599da44e2457d8">IHCParam</a>
+</li>
+<li>tau_in
+: <a class="el" href="classIHCParam.html#a45bfc257c1d54e481c9e9da5f7d6cb5c">IHCParam</a>
+</li>
+<li>tau_lpf
+: <a class="el" href="classIHCParam.html#a078a427d06ecaa2b16113b6150780408">IHCParam</a>
+</li>
+<li>tau_out
+: <a class="el" href="classIHCParam.html#ab7e995ed4516c93d5a763b051d92ceec">IHCParam</a>
+</li>
+<li>time_constants
+: <a class="el" href="classAGCParam.html#ae8073d3c194a9134cf736a564d4774fa">AGCParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_v"></a>- v -</h3><ul>
+<li>v_offset
+: <a class="el" href="classCARParam.html#a275dff2443b1b58affcb9c5081f493eb">CARParam</a>
+</li>
+<li>velocity_scale
+: <a class="el" href="classCARParam.html#ae11cef3c3e8c19f1e1b6e6557962c600">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_z"></a>- z -</h3><ul>
+<li>zero_ratio
+: <a class="el" href="classCARParam.html#a7b01801df1b6e4c75abeabea9b1bb6ec">CARParam</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_0x7e"></a>- ~ -</h3><ul>
+<li>~AGC()
+: <a class="el" href="classAGC.html#aee97f09e9aa84d136f11422a977a26be">AGC</a>
+</li>
+<li>~AGCCoeff()
+: <a class="el" href="classAGCCoeff.html#a9a0b91c1b76821a051fe5150eee5f677">AGCCoeff</a>
+</li>
+<li>~AGCParam()
+: <a class="el" href="classAGCParam.html#a40249c83afc2cffec3c0fe8bb9cb9997">AGCParam</a>
+</li>
+<li>~AGCState()
+: <a class="el" href="classAGCState.html#add516d9a131cbc94d9204499dc2aae9d">AGCState</a>
+</li>
+<li>~CAR()
+: <a class="el" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">CAR</a>
+</li>
+<li>~CARCoeff()
+: <a class="el" href="classCARCoeff.html#ae6e76dc2758eb843781b57bbff6bff66">CARCoeff</a>
+</li>
+<li>~CARParam()
+: <a class="el" href="classCARParam.html#a96ab5ca0d828c34a84022b214dced443">CARParam</a>
+</li>
+<li>~CARState()
+: <a class="el" href="classCARState.html#a7e2426e7df86159995ac1bee593c99ca">CARState</a>
+</li>
+<li>~Coefficients()
+: <a class="el" href="classCoefficients.html#aac4dae815408f52dce7e9c4ec1c6bdc9">Coefficients</a>
+</li>
+<li>~Ear()
+: <a class="el" href="classEar.html#aadc3da8092733631bcdde1bfa3f3734a">Ear</a>
+</li>
+<li>~EarComponent()
+: <a class="el" href="classEarComponent.html#a0eaf3faf1ec50098fa5b3cdb21ffea6e">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</a>
+</li>
+<li>~Ears()
+: <a class="el" href="classEars.html#a8b6155732c6e851e5cbb0ccfe2942b36">Ears</a>
+</li>
+<li>~IHC()
+: <a class="el" href="classIHC.html#adfa0faea6a25b9c013cb1592916a4940">IHC</a>
+</li>
+<li>~IHCCoeff()
+: <a class="el" href="classIHCCoeff.html#ac17ae84f8e198bcc625e88984fb6b169">IHCCoeff</a>
+</li>
+<li>~IHCParam()
+: <a class="el" href="classIHCParam.html#a9b7674dd50b124f4e0af34c86413c1d0">IHCParam</a>
+</li>
+<li>~IHCState()
+: <a class="el" href="classIHCState.html#adeac66fdb1f403834f9447e4a6616139">IHCState</a>
+</li>
+<li>~Parameters()
+: <a class="el" href="classParameters.html#a640a1a349975a8cb023696f25e563a5c">Parameters</a>
+</li>
+<li>~State()
+: <a class="el" href="classState.html#afab438d92b90dc18d194dbd9c9c8bab3">State</a>
+</li>
+</ul>
+</div><!-- contents -->
+<!-- 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>
+  <div id="nav-path" class="navpath">
+    <ul>
+
+    <li class="footer">Generated on Sun Feb 10 2013 10:47:46 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>