e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-16 22:31:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
doc/html/classFunction.html
View File

@@ -8,82 +8,74 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>Function Class Reference</h1><code>#include &lt;<a class="el" href="Function_8h-source.html">Function.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Function Class Reference</h1><!-- doxytag: class="Function" --><!-- doxytag: inherits="Stk" --><code>#include &lt;<a class="el" href="Function_8h-source.html">Function.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Function:
<p><center><img src="classFunction.png" usemap="#Function_map" border="0" alt=""></center>
<map name="Function_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="123,0,195,24">
<area href="classStk.html" alt="Stk" shape="rect" coords="82,0,154,24">
<area href="classBowTable.html" alt="BowTable" shape="rect" coords="0,112,72,136">
<area href="classJetTable.html" alt="JetTable" shape="rect" coords="82,112,154,136">
<area href="classReedTable.html" alt="ReedTable" shape="rect" coords="164,112,236,136">
<area href="classTable.html" alt="Table" shape="rect" coords="246,112,318,136">
</map>
<a href="classFunction-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK abstract function parent class.
<p>
This class provides common functionality for STK classes which implement tables or other types of input to output function mappings.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Function_8h-source.html#l00018">18</a> of file <a class="el" href="Function_8h-source.html">Function.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="Function::Function" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a0">Function</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="Function::Function" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFunction.html#a0">Function</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Function::~Function" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a1">~Function</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Function::~Function" ref="a1" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFunction.html#a1">~Function</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Function::lastOut" ></a>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a2">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Function::lastOut" ref="a2" args="() const " -->
virtual StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFunction.html#a2">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Function::tick" ></a>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a3">tick</a> (StkFloat input)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Function::tick" ref="a3" args="(StkFloat input)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFunction.html#a3">tick</a> (StkFloat input)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abstract tick function ... must be implemented in subclasses. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Function::tick" ></a>
virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a4">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take one sample input and compute one sample of output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFunction.html#a4">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take <em>vectorSize</em> inputs from <em>vector</em> and replace them with corresponding outputs. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFunction.html#a5">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the function and replace with corresponding outputs. </em> <a href="#a5"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the function and replace with corresponding outputs. <a href="#a4"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a5" doxytag="Function::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a4"></a><!-- doxytag: member="Function::tick" ref="a4" args="(StkFrames &amp;frames, unsigned int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Function::tick </td>
<td class="md" nowrap valign="top">virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Function::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -93,9 +85,7 @@ virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el
<p>
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the function and replace with corresponding outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
<p>
Reimplemented in <a class="el" href="classBowTable.html#a6">BowTable</a>, <a class="el" href="classJetTable.html#a4">JetTable</a>, <a class="el" href="classReedTable.html#a6">ReedTable</a>, and <a class="el" href="classTable.html#a5">Table</a>. </td>
The <code>channel</code> argument should be zero or greater (the first channel is specified by 0). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is equal to or greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -104,7 +94,7 @@ Reimplemented in <a class="el" href="classBowTable.html#a6">BowTable</a>, <a cla
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>