Mercurial > hg > aimc

annotate trunk/C++/api/html/CARCoeff_8H_source.html @ 599:b4323584c9fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated the documentation
author flatmax
date Wed, 20 Feb 2013 22:34:13 +0000
parents 359bcd461dd1
children
rev   line source
flatmax@597 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@597 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@597 3 <head>
flatmax@597 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@597 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@597 6 <title>CARFAC C++: CARCoeff.H Source File</title>
flatmax@597 7
flatmax@597 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@597 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@597 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@597 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@597 12 <script type="text/javascript" src="resize.js"></script>
flatmax@597 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@597 14 <script type="text/javascript">
flatmax@597 15 $(document).ready(initResizable);
flatmax@597 16 </script>
flatmax@597 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@597 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@597 19 <script type="text/javascript">
flatmax@597 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@597 21 </script>
flatmax@597 22
flatmax@597 23 </head>
flatmax@597 24 <body>
flatmax@597 25 <div id="top"><!-- do not remove this div! -->
flatmax@597 26
flatmax@597 27
flatmax@597 28 <div id="titlearea">
flatmax@597 29 <table cellspacing="0" cellpadding="0">
flatmax@597 30 <tbody>
flatmax@597 31 <tr style="height: 56px;">
flatmax@597 32
flatmax@597 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@597 34
flatmax@597 35
flatmax@597 36 <td style="padding-left: 0.5em;">
flatmax@597 37 <div id="projectname">CARFAC C++
flatmax@597 38
flatmax@597 39 </div>
flatmax@597 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@597 41 </td>
flatmax@597 42
flatmax@597 43
flatmax@597 44
flatmax@597 45 </tr>
flatmax@597 46 </tbody>
flatmax@597 47 </table>
flatmax@597 48 </div>
flatmax@597 49
flatmax@597 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@597 51 <script type="text/javascript">
flatmax@597 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@597 53 </script>
flatmax@597 54 <div id="navrow1" class="tabs">
flatmax@597 55 <ul class="tablist">
flatmax@597 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@597 57 <li><a href="annotated.html"><span>Classes</span></a></li>
flatmax@597 58 <li class="current"><a href="files.html"><span>Files</span></a></li>
flatmax@597 59 <li>
flatmax@597 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@597 61 <span class="left">
flatmax@597 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@597 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 65 alt=""/>
flatmax@597 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@597 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@597 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@597 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@597 70 </span><span class="right">
flatmax@597 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@597 72 </span>
flatmax@597 73 </div>
flatmax@597 74 </li>
flatmax@597 75 </ul>
flatmax@597 76 </div>
flatmax@597 77 <div id="navrow2" class="tabs2">
flatmax@597 78 <ul class="tablist">
flatmax@597 79 <li><a href="files.html"><span>File&#160;List</span></a></li>
flatmax@597 80 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
flatmax@597 81 </ul>
flatmax@597 82 </div>
flatmax@597 83 </div>
flatmax@597 84 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@597 85 <div id="nav-tree">
flatmax@597 86 <div id="nav-tree-contents">
flatmax@597 87 </div>
flatmax@597 88 </div>
flatmax@597 89 <div id="splitbar" style="-moz-user-select:none;"
flatmax@597 90 class="ui-resizable-handle">
flatmax@597 91 </div>
flatmax@597 92 </div>
flatmax@597 93 <script type="text/javascript">
flatmax@597 94 initNavTree('CARCoeff_8H.html','');
flatmax@597 95 </script>
flatmax@597 96 <div id="doc-content">
flatmax@597 97 <div class="header">
flatmax@597 98 <div class="headertitle">
flatmax@597 99 <div class="title">CARCoeff.H</div> </div>
flatmax@597 100 </div><!--header-->
flatmax@597 101 <div class="contents">
flatmax@597 102 <a href="CARCoeff_8H.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright 2013 Matt R. Flax &lt;flatmax\@&gt; All Rights Reserved.</span>
flatmax@599 103 <a name="l00002"></a>00002 <span class="comment">// Author Matt Flax &lt;flatmax@&gt;</span>
flatmax@597 104 <a name="l00003"></a>00003 <span class="comment">//</span>
flatmax@597 105 <a name="l00004"></a>00004 <span class="comment">// This C++ file is part of an implementation of Lyon&#39;s cochlear model:</span>
flatmax@597 106 <a name="l00005"></a>00005 <span class="comment">// &quot;Cascade of Asymmetric Resonators with Fast-Acting Compression&quot;</span>
flatmax@597 107 <a name="l00006"></a>00006 <span class="comment">// to supplement Lyon&#39;s upcoming book &quot;Human and Machine Hearing&quot;</span>
flatmax@597 108 <a name="l00007"></a>00007 <span class="comment">//</span>
flatmax@597 109 <a name="l00008"></a>00008 <span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
flatmax@597 110 <a name="l00009"></a>00009 <span class="comment">// you may not use this file except in compliance with the License.</span>
flatmax@597 111 <a name="l00010"></a>00010 <span class="comment">// You may obtain a copy of the License at</span>
flatmax@597 112 <a name="l00011"></a>00011 <span class="comment">//</span>
flatmax@597 113 <a name="l00012"></a>00012 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
flatmax@597 114 <a name="l00013"></a>00013 <span class="comment">//</span>
flatmax@597 115 <a name="l00014"></a>00014 <span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
flatmax@597 116 <a name="l00015"></a>00015 <span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
flatmax@597 117 <a name="l00016"></a>00016 <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
flatmax@597 118 <a name="l00017"></a>00017 <span class="comment">// See the License for the specific language governing permissions and</span>
flatmax@597 119 <a name="l00018"></a>00018 <span class="comment">// limitations under the License.</span>
flatmax@597 120 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef CARCOEFFS_H_</span>
flatmax@597 121 <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define CARCOEFFS_H_</span>
flatmax@597 122 <a name="l00021"></a>00021 <span class="preprocessor"></span>
flatmax@597 123 <a name="l00022"></a>00022 <span class="preprocessor">#include &quot;<a class="code" href="Coefficients_8H.html">Coefficients.H</a>&quot;</span>
flatmax@597 124 <a name="l00023"></a>00023
flatmax@599 125 <a name="l00024"></a>00024 <span class="keyword">class </span><a class="code" href="classCAR.html">CAR</a>; <span class="comment">// required for decleration as a friend</span>
flatmax@599 126 <a name="l00025"></a>00025
flatmax@599 127 <a name="l00032"></a><a class="code" href="classCARCoeff.html">00032</a> <span class="keyword">class </span><a class="code" href="classCARCoeff.html">CARCoeff</a> : <span class="keyword">public</span> <a class="code" href="classCoefficients.html">Coefficients</a> {
flatmax@599 128 <a name="l00033"></a><a class="code" href="classCARCoeff.html#acb8f8059ee713d13e4653e70ff22ad16">00033</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#acb8f8059ee713d13e4653e70ff22ad16" title="Dick, whats this ?">r1_coeffs</a>;
flatmax@599 129 <a name="l00034"></a><a class="code" href="classCARCoeff.html#a2afe815f09bdac1af53244b55365f211">00034</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#a2afe815f09bdac1af53244b55365f211" title="Dick, whats this ?">a0_coeffs</a>;
flatmax@599 130 <a name="l00035"></a><a class="code" href="classCARCoeff.html#ab3490241c1adfc3168d8a4c12d01c092">00035</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#ab3490241c1adfc3168d8a4c12d01c092" title="Dick, whats this ?">c0_coeffs</a>;
flatmax@599 131 <a name="l00036"></a><a class="code" href="classCARCoeff.html#a03d63906917a37988f490c3457044f92">00036</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#a03d63906917a37988f490c3457044f92" title="Dick, whats this ?">h_coeffs</a>;
flatmax@599 132 <a name="l00037"></a><a class="code" href="classCARCoeff.html#a237c9626e6f94557003d278626b59d74">00037</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#a237c9626e6f94557003d278626b59d74" title="Dick, whats this ?">g0_coeffs</a>;
flatmax@599 133 <a name="l00038"></a><a class="code" href="classCARCoeff.html#a02caa6298db68be987d78634e5ce2d06">00038</a> Matrix&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCARCoeff.html#a02caa6298db68be987d78634e5ce2d06" title="Dick, whats this ?">zr_coeffs</a>;
flatmax@599 134 <a name="l00039"></a>00039
flatmax@599 135 <a name="l00040"></a>00040 <span class="keyword">public</span>:
flatmax@599 136 <a name="l00041"></a>00041 <a class="code" href="classCARCoeff.html#ad5af264c24fe76bad741cacc6dcfad1d" title="Constructor.">CARCoeff</a>();
flatmax@599 137 <a name="l00042"></a>00042 <span class="keyword">virtual</span> <a class="code" href="classCARCoeff.html#ae6e76dc2758eb843781b57bbff6bff66" title="Destructor.">~CARCoeff</a>();
flatmax@599 138 <a name="l00043"></a>00043
flatmax@599 139 <a name="l00044"></a><a class="code" href="classCARCoeff.html#a090b35b339c09320d7dae48a06832261">00044</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCAR.html">CAR</a>;
flatmax@599 140 <a name="l00045"></a>00045 };
flatmax@599 141 <a name="l00046"></a>00046
flatmax@599 142 <a name="l00047"></a>00047 <span class="preprocessor">#endif // CARCOEFFS_H_</span>
flatmax@597 143 </pre></div></div><!-- contents -->
flatmax@597 144 </div>
flatmax@597 145 <!-- window showing the filter options -->
flatmax@597 146 <div id="MSearchSelectWindow"
flatmax@597 147 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 148 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 149 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@599 150 <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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>
flatmax@597 151
flatmax@597 152 <!-- iframe showing the search results (closed by default) -->
flatmax@597 153 <div id="MSearchResultsWindow">
flatmax@597 154 <iframe src="javascript:void(0)" frameborder="0"
flatmax@597 155 name="MSearchResults" id="MSearchResults">
flatmax@597 156 </iframe>
flatmax@597 157 </div>
flatmax@597 158
flatmax@597 159 <div id="nav-path" class="navpath">
flatmax@597 160 <ul>
flatmax@597 161 <li class="navelem"><a class="el" href="CARCoeff_8H.html">CARCoeff.H</a> </li>
flatmax@597 162
flatmax@599 163 <li class="footer">Generated on Thu Feb 21 2013 09:31:11 for CARFAC C++ by
flatmax@597 164 <a href="http://www.doxygen.org/index.html">
flatmax@597 165 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@597 166 </ul>
flatmax@597 167 </div>
flatmax@597 168
flatmax@597 169
flatmax@597 170 </body>
flatmax@597 171 </html>