Mercurial > hg > aimc

annotate C++/api/html/classEarComponent.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++: EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt; Class Template 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
flatmax@592 58 <li><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="annotated.html"><span>Class&#160;List</span></a></li>
flatmax@592 80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
flatmax@592 81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
flatmax@592 82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
flatmax@592 83 </ul>
flatmax@592 84 </div>
flatmax@592 85 </div>
flatmax@592 86 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@592 87 <div id="nav-tree">
flatmax@592 88 <div id="nav-tree-contents">
flatmax@592 89 </div>
flatmax@592 90 </div>
flatmax@592 91 <div id="splitbar" style="-moz-user-select:none;"
flatmax@592 92 class="ui-resizable-handle">
flatmax@592 93 </div>
flatmax@592 94 </div>
flatmax@592 95 <script type="text/javascript">
flatmax@592 96 initNavTree('classEarComponent.html','');
flatmax@592 97 </script>
flatmax@592 98 <div id="doc-content">
flatmax@592 99 <div class="header">
flatmax@592 100 <div class="summary">
flatmax@592 101 <a href="#pub-methods">Public Member Functions</a> &#124;
flatmax@592 102 <a href="#pro-attribs">Protected Attributes</a> </div>
flatmax@592 103 <div class="headertitle">
flatmax@592 104 <div class="title">EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt; Class Template Reference</div> </div>
flatmax@592 105 </div><!--header-->
flatmax@592 106 <div class="contents">
flatmax@592 107 <!-- doxytag: class="EarComponent" -->
flatmax@592 108 <p><code>#include &lt;<a class="el" href="EarComponent_8H_source.html">EarComponent.H</a>&gt;</code></p>
flatmax@592 109 <div class="dynheader">
flatmax@592 110 Collaboration diagram for EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;:</div>
flatmax@592 111 <div class="dyncontent">
flatmax@592 112 <div class="center"><img src="classEarComponent__coll__graph.png" border="0" usemap="#EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map" alt="Collaboration graph"/></div>
flatmax@592 113 <map name="EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map" id="EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map">
flatmax@592 114 </map>
flatmax@592 115 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@592 116
flatmax@592 117 <p><a href="classEarComponent-members.html">List of all members.</a></p>
flatmax@592 118 <table class="memberdecls">
flatmax@592 119 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@592 120 Public Member Functions</h2></td></tr>
flatmax@592 121 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#afde50640ddf67626e8e62926d491269d">EarComponent</a> ()</td></tr>
flatmax@592 122 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a0eaf3faf1ec50098fa5b3cdb21ffea6e">~EarComponent</a> ()</td></tr>
flatmax@592 123 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
flatmax@592 124 Protected Attributes</h2></td></tr>
flatmax@592 125 <tr><td class="memItemLeft" align="right" valign="top">COEFFTYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a43461ed3bac1bd735ea6ddee5dda2594">coeff</a></td></tr>
flatmax@592 126 <tr><td class="memItemLeft" align="right" valign="top">PARAMTYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#af409ffb12bafa60c09f319fa6edd48b9">param</a></td></tr>
flatmax@592 127 <tr><td class="memItemLeft" align="right" valign="top">STATETYPE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a4ea8ae90cda6efc8b1b79550545a9210">state</a></td></tr>
flatmax@592 128 </table>
flatmax@592 129 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@592 130 <div class="textblock"><h3>template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt;<br/>
flatmax@592 131 class EarComponent&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;</h3>
flatmax@592 132
flatmax@592 133 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@592 134 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@592 135 <p>This class is inherited by the <a class="el" href="classCAR.html">CAR</a>, <a class="el" href="classAGC.html">AGC</a> and <a class="el" href="classIHC.html">IHC</a> classes. This class groups <a class="el" href="classParameters.html">Parameters</a>, Coefficient and <a class="el" href="classState.html">State</a> classes. </p>
flatmax@592 136 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@592 137 <a class="anchor" id="afde50640ddf67626e8e62926d491269d"></a><!-- doxytag: member="EarComponent::EarComponent" ref="afde50640ddf67626e8e62926d491269d" args="()" -->
flatmax@592 138 <div class="memitem">
flatmax@592 139 <div class="memproto">
flatmax@592 140 <div class="memtemplate">
flatmax@592 141 template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt; </div>
flatmax@592 142 <table class="memname">
flatmax@592 143 <tr>
flatmax@592 144 <td class="memname"><a class="el" href="classEarComponent.html">EarComponent</a>&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;::<a class="el" href="classEarComponent.html">EarComponent</a> </td>
flatmax@592 145 <td>(</td>
flatmax@592 146 <td class="paramname"></td><td>)</td>
flatmax@592 147 <td><code> [inline]</code></td>
flatmax@592 148 </tr>
flatmax@592 149 </table>
flatmax@592 150 </div>
flatmax@592 151 <div class="memdoc">
flatmax@592 152
flatmax@592 153 </div>
flatmax@592 154 </div>
flatmax@592 155 <a class="anchor" id="a0eaf3faf1ec50098fa5b3cdb21ffea6e"></a><!-- doxytag: member="EarComponent::~EarComponent" ref="a0eaf3faf1ec50098fa5b3cdb21ffea6e" args="()" -->
flatmax@592 156 <div class="memitem">
flatmax@592 157 <div class="memproto">
flatmax@592 158 <div class="memtemplate">
flatmax@592 159 template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt; </div>
flatmax@592 160 <table class="memname">
flatmax@592 161 <tr>
flatmax@592 162 <td class="memname">virtual <a class="el" href="classEarComponent.html">EarComponent</a>&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;::~<a class="el" href="classEarComponent.html">EarComponent</a> </td>
flatmax@592 163 <td>(</td>
flatmax@592 164 <td class="paramname"></td><td>)</td>
flatmax@592 165 <td><code> [inline, virtual]</code></td>
flatmax@592 166 </tr>
flatmax@592 167 </table>
flatmax@592 168 </div>
flatmax@592 169 <div class="memdoc">
flatmax@592 170
flatmax@592 171 </div>
flatmax@592 172 </div>
flatmax@592 173 <hr/><h2>Member Data Documentation</h2>
flatmax@592 174 <a class="anchor" id="a43461ed3bac1bd735ea6ddee5dda2594"></a><!-- doxytag: member="EarComponent::coeff" ref="a43461ed3bac1bd735ea6ddee5dda2594" args="" -->
flatmax@592 175 <div class="memitem">
flatmax@592 176 <div class="memproto">
flatmax@592 177 <div class="memtemplate">
flatmax@592 178 template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt; </div>
flatmax@592 179 <table class="memname">
flatmax@592 180 <tr>
flatmax@592 181 <td class="memname">COEFFTYPE <a class="el" href="classEarComponent.html">EarComponent</a>&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;::<a class="el" href="classEarComponent.html#a43461ed3bac1bd735ea6ddee5dda2594">coeff</a><code> [protected]</code></td>
flatmax@592 182 </tr>
flatmax@592 183 </table>
flatmax@592 184 </div>
flatmax@592 185 <div class="memdoc">
flatmax@592 186
flatmax@592 187 </div>
flatmax@592 188 </div>
flatmax@592 189 <a class="anchor" id="af409ffb12bafa60c09f319fa6edd48b9"></a><!-- doxytag: member="EarComponent::param" ref="af409ffb12bafa60c09f319fa6edd48b9" args="" -->
flatmax@592 190 <div class="memitem">
flatmax@592 191 <div class="memproto">
flatmax@592 192 <div class="memtemplate">
flatmax@592 193 template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt; </div>
flatmax@592 194 <table class="memname">
flatmax@592 195 <tr>
flatmax@592 196 <td class="memname">PARAMTYPE <a class="el" href="classEarComponent.html">EarComponent</a>&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;::<a class="el" href="classEarComponent.html#af409ffb12bafa60c09f319fa6edd48b9">param</a><code> [protected]</code></td>
flatmax@592 197 </tr>
flatmax@592 198 </table>
flatmax@592 199 </div>
flatmax@592 200 <div class="memdoc">
flatmax@592 201
flatmax@592 202 </div>
flatmax@592 203 </div>
flatmax@592 204 <a class="anchor" id="a4ea8ae90cda6efc8b1b79550545a9210"></a><!-- doxytag: member="EarComponent::state" ref="a4ea8ae90cda6efc8b1b79550545a9210" args="" -->
flatmax@592 205 <div class="memitem">
flatmax@592 206 <div class="memproto">
flatmax@592 207 <div class="memtemplate">
flatmax@592 208 template&lt;class COEFFTYPE, class PARAMTYPE, class STATETYPE&gt; </div>
flatmax@592 209 <table class="memname">
flatmax@592 210 <tr>
flatmax@592 211 <td class="memname">STATETYPE <a class="el" href="classEarComponent.html">EarComponent</a>&lt; COEFFTYPE, PARAMTYPE, STATETYPE &gt;::<a class="el" href="classEarComponent.html#a4ea8ae90cda6efc8b1b79550545a9210">state</a><code> [protected]</code></td>
flatmax@592 212 </tr>
flatmax@592 213 </table>
flatmax@592 214 </div>
flatmax@592 215 <div class="memdoc">
flatmax@592 216
flatmax@592 217 </div>
flatmax@592 218 </div>
flatmax@592 219 <hr/>The documentation for this class was generated from the following file:<ul>
flatmax@592 220 <li><a class="el" href="EarComponent_8H_source.html">EarComponent.H</a></li>
flatmax@592 221 </ul>
flatmax@592 222 </div><!-- contents -->
flatmax@592 223 </div>
flatmax@592 224 <!-- window showing the filter options -->
flatmax@592 225 <div id="MSearchSelectWindow"
flatmax@592 226 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 227 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 228 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@592 229 <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 230
flatmax@592 231 <!-- iframe showing the search results (closed by default) -->
flatmax@592 232 <div id="MSearchResultsWindow">
flatmax@592 233 <iframe src="javascript:void(0)" frameborder="0"
flatmax@592 234 name="MSearchResults" id="MSearchResults">
flatmax@592 235 </iframe>
flatmax@592 236 </div>
flatmax@592 237
flatmax@592 238 <div id="nav-path" class="navpath">
flatmax@592 239 <ul>
flatmax@592 240 <li class="navelem"><a class="el" href="classEarComponent.html">EarComponent</a> </li>
flatmax@592 241
flatmax@592 242 <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by
flatmax@592 243 <a href="http://www.doxygen.org/index.html">
flatmax@592 244 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@592 245 </ul>
flatmax@592 246 </div>
flatmax@592 247
flatmax@592 248
flatmax@592 249 </body>
flatmax@592 250 </html>