summaryrefslogtreecommitdiff
path: root/opcodes/init.xml
blob: c066b67c8c1ddd9410ddda105365bb648c6ac7f8 (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
<refentry id="init">
<indexterm id="IndexInit"><primary>init</primary></indexterm>
  <refentryinfo><title>Instrument Control:Initialization and Reinitialization</title></refentryinfo>
  <refmeta>
    <refentrytitle>init</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>init</refname>
    <refpurpose>
       Puts the value of the i-time expression into a k- or a-rate variable.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>init</command> iarg</synopsis>
    <synopsis>ires <command>init</command> iarg</synopsis>
    <synopsis>kres <command>init</command> iarg</synopsis>
    <synopsis>ares, ...  <command>init</command> iarg, ...</synopsis>
    <synopsis>ires, ... <command>init</command> iarg, ...</synopsis>
    <synopsis>kres, ...<command>init</command> iarg, ...</synopsis>
  </refsect1>

  <refsect1>
    <title>Description</title>
    <para> 
      Put the value of the i-time expression into a k- or a-rate variable.
    </para> 
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      Puts the value of the i-time expression
      <emphasis>iarg</emphasis> into a k- or a-rate variable, i.e.,
      initialize the result. Note that <emphasis
      role="strong">init</emphasis> provides the only case of an
      init-time statement being permitted to write into a perf-time
      (k- or a-rate) result cell; the statement has no effect at
      perf-time.
    </para>
    <para>
      Since version 5.13 it is possible to initialise upto 24
      variables of the same class in one statement.  If there are more
      output variables than input expressions then the last one is
      repeated.  It is an error to have more inputs than outputs.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="assign"><citetitle>=</citetitle></link>,
      <link linkend="divz"><citetitle>divz</citetitle></link>,
      <link linkend="tival"><citetitle>tival</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      Init first appeared in the original Csound, but the extension to
      multiple values is by
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>University of Bath, and Codemist Ltd.</member>
        <member>Bath, UK</member>
        <member>February 2010</member>
      </simplelist>
    <para>New in version 5.13</para>
    </para>
  </refsect1>
</refentry>