Mercurial > hg > aimc

annotate trunk/C++/api/html/classCAR.html @ 597:359bcd461dd1

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 b4323584c9fa
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++: CAR Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
flatmax@597 58 <li><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="annotated.html"><span>Class&#160;List</span></a></li>
flatmax@597 80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
flatmax@597 81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
flatmax@597 82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
flatmax@597 83 </ul>
flatmax@597 84 </div>
flatmax@597 85 </div>
flatmax@597 86 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@597 87 <div id="nav-tree">
flatmax@597 88 <div id="nav-tree-contents">
flatmax@597 89 </div>
flatmax@597 90 </div>
flatmax@597 91 <div id="splitbar" style="-moz-user-select:none;"
flatmax@597 92 class="ui-resizable-handle">
flatmax@597 93 </div>
flatmax@597 94 </div>
flatmax@597 95 <script type="text/javascript">
flatmax@597 96 initNavTree('classCAR.html','');
flatmax@597 97 </script>
flatmax@597 98 <div id="doc-content">
flatmax@597 99 <div class="header">
flatmax@597 100 <div class="summary">
flatmax@597 101 <a href="#pub-methods">Public Member Functions</a> </div>
flatmax@597 102 <div class="headertitle">
flatmax@597 103 <div class="title">CAR Class Reference</div> </div>
flatmax@597 104 </div><!--header-->
flatmax@597 105 <div class="contents">
flatmax@597 106 <!-- doxytag: class="CAR" --><!-- doxytag: inherits="EarComponent&lt; CARCoeff, CARParam, CARState &gt;" -->
flatmax@597 107 <p><code>#include &lt;<a class="el" href="CAR_8H_source.html">CAR.H</a>&gt;</code></p>
flatmax@597 108 <div class="dynheader">
flatmax@597 109 Inheritance diagram for CAR:</div>
flatmax@597 110 <div class="dyncontent">
flatmax@597 111 <div class="center"><img src="classCAR__inherit__graph.png" border="0" usemap="#CAR_inherit__map" alt="Inheritance graph"/></div>
flatmax@597 112 <map name="CAR_inherit__map" id="CAR_inherit__map">
flatmax@597 113 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; CARCoeff, CARParam, CARState \&gt;" alt="" coords="5,5,341,35"/></map>
flatmax@597 114 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@597 115 <div class="dynheader">
flatmax@597 116 Collaboration diagram for CAR:</div>
flatmax@597 117 <div class="dyncontent">
flatmax@597 118 <div class="center"><img src="classCAR__coll__graph.png" border="0" usemap="#CAR_coll__map" alt="Collaboration graph"/></div>
flatmax@597 119 <map name="CAR_coll__map" id="CAR_coll__map">
flatmax@597 120 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; CARCoeff, CARParam, CARState \&gt;" alt="" coords="5,181,341,211"/><area shape="rect" id="node4" href="classCARState.html" title="CARState" alt="" coords="23,85,105,115"/><area shape="rect" id="node6" href="classState.html" title="State" alt="" coords="37,5,91,35"/><area shape="rect" id="node8" href="classCARParam.html" title="CARParam" alt="" coords="129,85,217,115"/><area shape="rect" id="node10" href="classParameters.html" title="Parameters" alt="" coords="128,5,216,35"/><area shape="rect" id="node12" href="classCARCoeff.html" title="CARCoeff" alt="" coords="243,85,325,115"/><area shape="rect" id="node14" href="classCoefficients.html" title="Coefficients" alt="" coords="240,5,331,35"/></map>
flatmax@597 121 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@597 122
flatmax@597 123 <p><a href="classCAR-members.html">List of all members.</a></p>
flatmax@597 124 <table class="memberdecls">
flatmax@597 125 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@597 126 Public Member Functions</h2></td></tr>
flatmax@597 127 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR</a> ()</td></tr>
flatmax@597 128 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">~CAR</a> ()</td></tr>
flatmax@597 129 </table>
flatmax@597 130 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@597 131 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 132 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@597 133 <p>Cascade of asymmetric resonators (<a class="el" href="classCAR.html">CAR</a>). </p>
flatmax@597 134 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@597 135 <a class="anchor" id="a7c80d0ba9d83caf4cf129b251e41e65c"></a><!-- doxytag: member="CAR::CAR" ref="a7c80d0ba9d83caf4cf129b251e41e65c" args="()" -->
flatmax@597 136 <div class="memitem">
flatmax@597 137 <div class="memproto">
flatmax@597 138 <table class="memname">
flatmax@597 139 <tr>
flatmax@597 140 <td class="memname"><a class="el" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR::CAR</a> </td>
flatmax@597 141 <td>(</td>
flatmax@597 142 <td class="paramname"></td><td>)</td>
flatmax@597 143 <td></td>
flatmax@597 144 </tr>
flatmax@597 145 </table>
flatmax@597 146 </div>
flatmax@597 147 <div class="memdoc">
flatmax@597 148 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 149 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
flatmax@597 150
flatmax@597 151 </div>
flatmax@597 152 </div>
flatmax@597 153 <a class="anchor" id="ac3174919d88d3be0118fcb0fdab84b56"></a><!-- doxytag: member="CAR::~CAR" ref="ac3174919d88d3be0118fcb0fdab84b56" args="()" -->
flatmax@597 154 <div class="memitem">
flatmax@597 155 <div class="memproto">
flatmax@597 156 <table class="memname">
flatmax@597 157 <tr>
flatmax@597 158 <td class="memname"><a class="el" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">CAR::~CAR</a> </td>
flatmax@597 159 <td>(</td>
flatmax@597 160 <td class="paramname"></td><td>)</td>
flatmax@597 161 <td><code> [virtual]</code></td>
flatmax@597 162 </tr>
flatmax@597 163 </table>
flatmax@597 164 </div>
flatmax@597 165 <div class="memdoc">
flatmax@597 166
flatmax@597 167 </div>
flatmax@597 168 </div>
flatmax@597 169 <hr/>The documentation for this class was generated from the following files:<ul>
flatmax@597 170 <li><a class="el" href="CAR_8H_source.html">CAR.H</a></li>
flatmax@597 171 <li><a class="el" href="CAR_8C.html">CAR.C</a></li>
flatmax@597 172 </ul>
flatmax@597 173 </div><!-- contents -->
flatmax@597 174 </div>
flatmax@597 175 <!-- window showing the filter options -->
flatmax@597 176 <div id="MSearchSelectWindow"
flatmax@597 177 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 178 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 179 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@597 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>
flatmax@597 181
flatmax@597 182 <!-- iframe showing the search results (closed by default) -->
flatmax@597 183 <div id="MSearchResultsWindow">
flatmax@597 184 <iframe src="javascript:void(0)" frameborder="0"
flatmax@597 185 name="MSearchResults" id="MSearchResults">
flatmax@597 186 </iframe>
flatmax@597 187 </div>
flatmax@597 188
flatmax@597 189 <div id="nav-path" class="navpath">
flatmax@597 190 <ul>
flatmax@597 191 <li class="navelem"><a class="el" href="classCAR.html">CAR</a> </li>
flatmax@597 192
flatmax@597 193 <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by
flatmax@597 194 <a href="http://www.doxygen.org/index.html">
flatmax@597 195 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@597 196 </ul>
flatmax@597 197 </div>
flatmax@597 198
flatmax@597 199
flatmax@597 200 </body>
flatmax@597 201 </html>