summaryrefslogtreecommitdiff
path: root/scoregens/genexp.xml
blob: e472e3f0b95a35411aad61676d63b0673c3eb68e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<refentry id="GENexp">
      <indexterm id="IndexGENexp"><primary>GENexp</primary></indexterm>
  <refmeta>
    <refentrytitle>GENexp</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>"exp"</refname>
    <refpurpose>
      Generate a table with values on the exp function.
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
Creates an ftable with values of the exp function ....
    </para>
  </refsect1>
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>f</command> # time size "exp" start end rescale</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>size</emphasis> -- number of points in the table. Must
      be a power of 2 or power-of-2 plus 1 (see <link
      linkend="f"><citetitle>f statement</citetitle></link>).
    </para>

    <para>
      <emphasis>start, end</emphasis> -- first and last value to be stored.  The points stored are uniformly spaced between these to the table size
    </para>
    <para>
      <emphasis>rescale</emphasis> -- if not zero the table is not rescaled
    </para>

  </refsect1>
  
  <refsect1>
    <title>Examples</title>
    <para>
      Here is a simple example of the <emphasis>GENexp</emphasis> routine. It uses the
      file <ulink
      url="examples/genexp.csd"><citetitle>genexp.csd</citetitle></ulink>.
      It will generate a simple exp shaped output wave.

      <example>
        <title>A simple example of the GENexp routine.</title>
        <para>
          See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.
        </para>
        <xi:include href="examples-xml/genexp.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
     <title>See Also</title>
     <para>
       <link linkend="GENexp"><citetitle>GENexp</citetitle></link> and
       <link linkend="GENsone"><citetitle>GENsone</citetitle></link>.
     </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Written by &namevictor;</para>
  </refsect1>
</refentry>