summaryrefslogtreecommitdiff
path: root/opcodes/array.xml
blob: a61424690d82c654998cb06360450cd33779c59f (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
<refentry id="array">
<indexterm id="IndexArray"><primary>array</primary></indexterm>

  <refentryinfo><title>Table Control:Table Queries</title></refentryinfo>
  <refmeta>
    <refentrytitle>array</refentrytitle>
  </refmeta>

   <refnamediv>
    <refname>array</refname>
    <refpurpose>
      Generate a vector with initial values.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Generate a vector (one-dimensional k-rate array) with initial values.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
      <synopsis>karray[] <command>array</command> ival1, ival2,.....ivaln</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ival1,...ivaln</emphasis> -- values to place in the vector.
    </para>
  </refsect1>

 <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the array opcode. It uses the file <ulink url="examples/array.csd"><citetitle>array.csd</citetitle></ulink>.
      <example>
        <title>Example of the array 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/array.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="vectorial"><citetitle></citetitle>Vectorial opcodes</link>
      <link linkend="fillarray"><citetitle></citetitle>fillarray</link>
</para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>Codemist Ltd</member>
        <member>2013</member>
      </simplelist>
    </para>
    <para>New in version 6.00</para>
  </refsect1>
</refentry>