e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-17 06:41:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
doc/html/classNoise.html
View File

@@ -9,18 +9,24 @@
<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>Noise Class Reference</h1>STK noise generator.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Noise_8h-source.html">Noise.h</a>&gt;</code>
<h1>Noise Class Reference</h1><code>#include &lt;<a class="el" href="Noise_8h-source.html">Noise.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Noise:
<p><center><img src="classNoise.png" usemap="#Noise_map" border="0" alt=""></center>
<map name="Noise_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,66,24">
<area href="classSubNoise.html" alt="SubNoise" shape="rect" coords="0,112,66,136">
<area href="classGenerator.html" alt="Generator" shape="rect" coords="0,56,69,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,69,24">
<area href="classSubNoise.html" alt="SubNoise" shape="rect" coords="0,168,69,192">
</map>
<a href="classNoise-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classNoise-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK noise generator.
<p>
Generic random number generation using the C rand() function. The quality of the rand() function varies from one OS to another.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="Noise_8h-source.html#l00018">18</a> of file <a class="el" href="Noise_8h-source.html">Noise.h</a>.<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="Noise::Noise" ></a>
@@ -38,27 +44,18 @@ virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="cla
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Seed the random number generator with a specific seed value. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Noise::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classNoise.html#a4">tick</a> ()</td></tr>
virtual StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classNoise.html#a4">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a random number between -1.0 and 1.0 using rand(). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Noise::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classNoise.html#a5">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
virtual StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classNoise.html#a5">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return <em>vectorSize</em> random numbers between -1.0 and 1.0 in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Noise::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classNoise.html#a6">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <em>vectorSize</em> outputs and return them in <em>vector</em>. <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="classNoise.html#a6">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">Return the last computed value. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a6"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK noise generator.
<p>
Generic random number generation using the C rand() function. The quality of the rand() function varies from one OS to another.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="Noise_8h-source.html#l00018">18</a> of file <a class="el" href="Noise_8h-source.html">Noise.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a1" doxytag="Noise::Noise" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
@@ -122,12 +119,56 @@ Seed the random number generator with a specific seed value.
If no seed is provided or the seed value is zero, the random number generator is seeded with the current system time. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="Noise::tick" ></a><p>
<table class="mdTable" width="100%" 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; Noise::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>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></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>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed 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 from <a class="el" href="classGenerator.html#a5">Generator</a>.
<p>
Reimplemented in <a class="el" href="classSubNoise.html#a6">SubNoise</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Noise_8h-source.html">Noise.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><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>
</table>