Mercurial > hg > aimc

comparison C++/api/html/classAGC.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
comparison
equal deleted inserted replaced
591:2a69b38336c4 592:76c6b3fd0a05
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>CARFAC C++: AGC Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script>
13 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript">
15 $(document).ready(initResizable);
16 </script>
17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/search.js"></script>
19 <script type="text/javascript">
20 $(document).ready(function() { searchBox.OnSelectItem(0); });
21 </script>
22
23 </head>
24 <body>
25 <div id="top"><!-- do not remove this div! -->
26
27
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30 <tbody>
31 <tr style="height: 56px;">
32
33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
34
35
36 <td style="padding-left: 0.5em;">
37 <div id="projectname">CARFAC C++
38
39 </div>
40 <div id="projectbrief">C++ implementation of CARFAC</div>
41 </td>
42
43
44
45 </tr>
46 </tbody>
47 </table>
48 </div>
49
50 <!-- Generated by Doxygen 1.7.6.1 -->
51 <script type="text/javascript">
52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
53 </script>
54 <div id="navrow1" class="tabs">
55 <ul class="tablist">
56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
57 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58 <li><a href="files.html"><span>Files</span></a></li>
59 <li>
60 <div id="MSearchBox" class="MSearchBoxInactive">
61 <span class="left">
62 <img id="MSearchSelect" src="search/mag_sel.png"
63 onmouseover="return searchBox.OnSearchSelectShow()"
64 onmouseout="return searchBox.OnSearchSelectHide()"
65 alt=""/>
66 <input type="text" id="MSearchField" value="Search" accesskey="S"
67 onfocus="searchBox.OnSearchFieldFocus(true)"
68 onblur="searchBox.OnSearchFieldFocus(false)"
69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
70 </span><span class="right">
71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
72 </span>
73 </div>
74 </li>
75 </ul>
76 </div>
77 <div id="navrow2" class="tabs2">
78 <ul class="tablist">
79 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
83 </ul>
84 </div>
85 </div>
86 <div id="side-nav" class="ui-resizable side-nav-resizable">
87 <div id="nav-tree">
88 <div id="nav-tree-contents">
89 </div>
90 </div>
91 <div id="splitbar" style="-moz-user-select:none;"
92 class="ui-resizable-handle">
93 </div>
94 </div>
95 <script type="text/javascript">
96 initNavTree('classAGC.html','');
97 </script>
98 <div id="doc-content">
99 <div class="header">
100 <div class="summary">
101 <a href="#pub-methods">Public Member Functions</a> </div>
102 <div class="headertitle">
103 <div class="title">AGC Class Reference</div> </div>
104 </div><!--header-->
105 <div class="contents">
106 <!-- doxytag: class="AGC" --><!-- doxytag: inherits="EarComponent&lt; AGCCoeff, AGCParam, AGCState &gt;" -->
107 <p><code>#include &lt;<a class="el" href="AGC_8H_source.html">AGC.H</a>&gt;</code></p>
108 <div class="dynheader">
109 Inheritance diagram for AGC:</div>
110 <div class="dyncontent">
111 <div class="center"><img src="classAGC__inherit__graph.png" border="0" usemap="#AGC_inherit__map" alt="Inheritance graph"/></div>
112 <map name="AGC_inherit__map" id="AGC_inherit__map">
113 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; AGCCoeff, AGCParam, AGCState \&gt;" alt="" coords="5,5,341,35"/></map>
114 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
115 <div class="dynheader">
116 Collaboration diagram for AGC:</div>
117 <div class="dyncontent">
118 <div class="center"><img src="classAGC__coll__graph.png" border="0" usemap="#AGC_coll__map" alt="Collaboration graph"/></div>
119 <map name="AGC_coll__map" id="AGC_coll__map">
120 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; AGCCoeff, AGCParam, AGCState \&gt;" alt="" coords="5,181,341,211"/><area shape="rect" id="node4" href="classAGCCoeff.html" title="AGCCoeff" alt="" coords="25,85,108,115"/><area shape="rect" id="node6" href="classCoefficients.html" title="Coefficients" alt="" coords="21,5,112,35"/><area shape="rect" id="node8" href="classAGCState.html" title="AGCState" alt="" coords="132,85,215,115"/><area shape="rect" id="node10" href="classState.html" title="State" alt="" coords="147,5,200,35"/><area shape="rect" id="node12" href="classAGCParam.html" title="AGCParam" alt="" coords="239,85,327,115"/><area shape="rect" id="node14" href="classParameters.html" title="Parameters" alt="" coords="239,5,327,35"/></map>
121 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
122
123 <p><a href="classAGC-members.html">List of all members.</a></p>
124 <table class="memberdecls">
125 <tr><td colspan="2"><h2><a name="pub-methods"></a>
126 Public Member Functions</h2></td></tr>
127 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGC.html#ac33d47213dd3401652c0927cc58d757f">AGC</a> ()</td></tr>
128 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGC.html#aee97f09e9aa84d136f11422a977a26be">~AGC</a> ()</td></tr>
129 </table>
130 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
131 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
132 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
133 <p>Automatic Gain Control </p>
134 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
135 <a class="anchor" id="ac33d47213dd3401652c0927cc58d757f"></a><!-- doxytag: member="AGC::AGC" ref="ac33d47213dd3401652c0927cc58d757f" args="()" -->
136 <div class="memitem">
137 <div class="memproto">
138 <table class="memname">
139 <tr>
140 <td class="memname"><a class="el" href="classAGC.html#ac33d47213dd3401652c0927cc58d757f">AGC::AGC</a> </td>
141 <td>(</td>
142 <td class="paramname"></td><td>)</td>
143 <td></td>
144 </tr>
145 </table>
146 </div>
147 <div class="memdoc">
148 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
149 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
150
151 </div>
152 </div>
153 <a class="anchor" id="aee97f09e9aa84d136f11422a977a26be"></a><!-- doxytag: member="AGC::~AGC" ref="aee97f09e9aa84d136f11422a977a26be" args="()" -->
154 <div class="memitem">
155 <div class="memproto">
156 <table class="memname">
157 <tr>
158 <td class="memname"><a class="el" href="classAGC.html#aee97f09e9aa84d136f11422a977a26be">AGC::~AGC</a> </td>
159 <td>(</td>
160 <td class="paramname"></td><td>)</td>
161 <td><code> [virtual]</code></td>
162 </tr>
163 </table>
164 </div>
165 <div class="memdoc">
166
167 </div>
168 </div>
169 <hr/>The documentation for this class was generated from the following files:<ul>
170 <li><a class="el" href="AGC_8H_source.html">AGC.H</a></li>
171 <li><a class="el" href="AGC_8C.html">AGC.C</a></li>
172 </ul>
173 </div><!-- contents -->
174 </div>
175 <!-- window showing the filter options -->
176 <div id="MSearchSelectWindow"
177 onmouseover="return searchBox.OnSearchSelectShow()"
178 onmouseout="return searchBox.OnSearchSelectHide()"
179 onkeydown="return searchBox.OnSearchSelectKey(event)">
180 <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>
181
182 <!-- iframe showing the search results (closed by default) -->
183 <div id="MSearchResultsWindow">
184 <iframe src="javascript:void(0)" frameborder="0"
185 name="MSearchResults" id="MSearchResults">
186 </iframe>
187 </div>
188
189 <div id="nav-path" class="navpath">
190 <ul>
191 <li class="navelem"><a class="el" href="classAGC.html">AGC</a> </li>
192
193 <li class="footer">Generated on Sun Feb 10 2013 10:47:45 for CARFAC C++ by
194 <a href="http://www.doxygen.org/index.html">
195 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
196 </ul>
197 </div>
198
199
200 </body>
201 </html>