summaryrefslogtreecommitdiff
path: root/opcodes/urd.xml
blob: 780c4b65c3b364ac8cbec14b1782479a04782d23 (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
<refentry id="urd">
<indexterm id="IndexUrd"><primary>urd</primary></indexterm>
  <refentryinfo><title>Signal Generators:Random (Noise) Generators</title></refentryinfo>
  <refmeta>
    <refentrytitle>urd</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>urd</refname>
    <refpurpose>
      A discrete user-defined-distribution random generator that can be used as a function.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      A discrete user-defined-distribution random generator that can be used as a function.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>aout = <command>urd</command>(ktableNum)</synopsis>

    <synopsis>iout = <command>urd</command>(itableNum)</synopsis>

    <synopsis>kout = <command>urd</command>(ktableNum)</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>itableNum</emphasis> -- number of table containing the random-distribution function.  Such table is generated by the user. See <link linkend="GEN40">GEN40</link>, <link linkend="GEN41">GEN41</link>, and <link linkend="GEN42">GEN42</link>. The table length does not need to be a power of 2
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ktableNum</emphasis> -- number of table containing the random-distribution function.  Such table is generated by the user. See <link linkend="GEN40">GEN40</link>, <link linkend="GEN41">GEN41</link>, and <link linkend="GEN42">GEN42</link>. The table length does not need to be a power of 2
    </para>

    <para>
      <emphasis>urd</emphasis> is the same opcode as <link linkend="duserrnd"><citetitle>duserrnd</citetitle></link>, but can be used in function fashion. 
    </para>

    <para>
      For a tutorial about random distribution histograms and functions see:

      <itemizedlist>
        <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>
      </itemizedlist>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="cuserrnd"><citetitle>cuserrnd</citetitle></link>,
      <link linkend="duserrnd"><citetitle>duserrnd</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in Version 4.16</para>
  </refsect1>
</refentry>