summaryrefslogtreecommitdiff
path: root/opcodes/cauchyi.xml
blob: 6057503b6fcb4e3e5d48359e99c144d24946bec8 (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
<refentry id="cauchyi">
<indexterm id="IndexCauchyiXClass"><primary>x-class noise generators</primary></indexterm>

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

  <refnamediv>
    <refname>cauchyi</refname>
    <refpurpose>
      Cauchy distribution random number generator with
      interpolation.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Cauchy distribution random number generator with controlled
      interpolation between values. This is an x-class noise
      generator.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>cauchyi</command> klambda, xamp, xcps</synopsis>
    <synopsis>ires <command>cauchyi</command> klambda, xamp, xcps</synopsis>
    <synopsis>kres <command>cauchyi</command> klambda, xamp, xcps</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kalpha</emphasis> -- controls the spread from zero (big <emphasis>kalpha</emphasis> = big spread). Outputs both positive and negative 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>

    <para>
      <emphasis>xamp</emphasis> -- range over which random numbers are distributed.
    </para>

    <para>
      <emphasis>xcps</emphasis> -- the frequency which new random
      numbers are generated. 
    </para>

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

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="cauchy"><citetitle>cauchy</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>Bath</member>
        <member>May 2011</member>
        <member>New in version 5.14</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>