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



  <refnamediv>
    <refname>randomh</refname>
    <refpurpose>
      Generates random numbers with a user-defined limit and holds them for a period of time. 
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Generates random numbers with a user-defined limit and holds them for a period of time. 
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>randomh</command> kmin, kmax, acps</synopsis>

    <synopsis>kres <command>randomh</command> kmin, kmax, kcps</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kmin</emphasis> -- minimum range limit
    </para>

    <para>
      <emphasis>kmax</emphasis> -- maximum range limit
    </para>

    <para>
      <emphasis>kcps, acps</emphasis> -- rate of random break-point generation
    </para>

    <para>
      The <emphasis>randomh</emphasis> opcode is similar to <link linkend="randh"><citetitle>randh</citetitle></link> but allows the user to set arbitrary minimum and maximum values.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the randomh opcode. It uses the file <ulink url="examples/randomh.csd"><citetitle>randomh.csd</citetitle></ulink>.

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

      Its output should include lines like:
      <screen>
k1 = 220.000000
k1 = 414.232056
k1 = 284.095184
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="randh"><citetitle>randh</citetitle></link>,
      <link linkend="random"><citetitle>random</citetitle></link>,
      <link linkend="randomi"><citetitle>randomi</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>