Files
stk/doc/html/classTable.html
2013-09-29 23:33:56 +02:00

94 lines
4.6 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Table Class Reference</h1>STK table lookup class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Table_8h-source.html">Table.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Table::
<p><center><img src="classTable.gif" usemap="#Table_map" border="0"></center>
<map name="Table_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,43,24">
</map>
<a href="classTable-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Table::Table"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a0">Table</a> (char *fileName)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor loads the data from <em>fileName</em>.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Table::~Table"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a1">~Table</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Table::getLength"></a>
long&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a2">getLength</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the number of elements in the table.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Table::lastOut"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a3">lastOut</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a4">tick</a> (MY_FLOAT index)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the table value at position <em>index</em>.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Table::tick"></a>
MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classTable.html#a5">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Take <em>vectorSize</em> index positions and return the corresponding table values in <em>vector</em>.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK table lookup class.
<p>
This class loads a table of floating-point doubles, which are assumed to be in big-endian format. Linear interpolation is performed for fractional lookup indexes.
<p>
An <a class="el" href="classStkError.html">StkError</a> will be thrown if the table file is not found.
<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="Table::tick"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
MY_FLOAT Table::tick (
</b></td>
<td valign="bottom"><b>
MY_FLOAT <em>index</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the table value at position <em>index</em>.
<p>
Linear interpolation is performed if <em>index</em> is fractional. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Table_8h-source.html">Table.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>