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


 
  <refnamediv>
    <refname>seed</refname>

    <refpurpose>
      Sets the global seed value.
          </refpurpose> 
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Sets the global seed value for all <emphasis>x-class noise generators</emphasis>, as well as other opcodes that use a random call, such as <link linkend="grain"><citetitle>grain</citetitle></link>.
    </para>
    <note>
      <title>Please Note</title>
      <para><link linkend="rand"><citetitle>rand</citetitle></link>, <link linkend="randh"><citetitle>randh</citetitle></link>, <link linkend="randi"><citetitle>randi</citetitle></link>, <link linkend="rnd"><citetitle>rnd(x)</citetitle></link> and <link linkend="birnd"><citetitle>birnd(x)</citetitle></link> are not affected by seed.</para>
    </note>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>seed</command> ival</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      Use of <emphasis>seed</emphasis> will provide predictable results from an orchestra using with random generators, when required from multiple performances.
    </para>

    <para>
      When specifying a seed value, <emphasis>ival</emphasis> should be an integer between 0 and 2<superscript>32</superscript>. If <emphasis>ival</emphasis> = 0, the value of <emphasis>ival</emphasis> will be derived from the system clock.
    </para>
  </refsect1>
</refentry>