summaryrefslogtreecommitdiff
path: root/opcodes/linrand.xml
blob: dd1627a57f9dcc2b48c715b292e9f5fb6b08a4ba (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<refentry id="linrand">
<indexterm id="IndexLinrandXClass"><primary>x-class noise generators</primary></indexterm>

<indexterm id="IndexLinrand"><primary>linrand</primary></indexterm>
  <refentryinfo><title>Signal Generators:Random (Noise) Generators</title></refentryinfo>
  <refmeta>
    <refentrytitle>linrand</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>linrand</refname>
    <refpurpose>
      Linear distribution random number generator (positive values only).
                </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Linear distribution random number generator (positive values only). This is an x-class noise generator.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>linrand</command> krange</synopsis>

    <synopsis>ires <command>linrand</command> krange</synopsis>

    <synopsis>kres <command>linrand</command> krange</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>krange</emphasis> -- the range of the random numbers (0 - <emphasis>krange</emphasis>). Outputs only positive numbers.
    </para>

    <para>
      For more detailed explanation of these distributions, see:
      <orderedlist>
        <listitem>
          <para>C. Dodge - T.A. Jerse 1985. Computer music. Schirmer books. pp.265 - 286</para>
        </listitem>

        <listitem>
          <para>D. Lorrain. A panoply of stochastic cannons. In C. Roads, ed. 1989. Music machine . Cambridge, Massachusetts: MIT press, pp. 351 - 379.</para>
        </listitem>
      </orderedlist>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the linrand opcode. It uses the file <ulink url="examples/linrand.csd"><citetitle>linrand.csd</citetitle></ulink>.

      <example>
        <title>Example of the linrand opcode.</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/linrand.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>

      Its output should include a line like this:
      <screen>
instr 1:  i1 = 0.394
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="seed"><citetitle>seed</citetitle></link>,
      <link linkend="betarand"><citetitle>betarand</citetitle></link>,
      <link linkend="bexprnd"><citetitle>bexprnd</citetitle></link>,
      <link linkend="cauchy"><citetitle>cauchy</citetitle></link>,
      <link linkend="exprand"><citetitle>exprand</citetitle></link>,
      <link linkend="gauss"><citetitle>gauss</citetitle></link>,
      <link linkend="pcauchy"><citetitle>pcauchy</citetitle></link>,
      <link linkend="poisson"><citetitle>poisson</citetitle></link>,
      <link linkend="trirand"><citetitle>trirand</citetitle></link>,
      <link linkend="unirand"><citetitle>unirand</citetitle></link>,
      <link linkend="weibull"><citetitle>weibull</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &nameparis;</member>
        <member>MIT, Cambridge</member>
        <member>1995</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>