summaryrefslogtreecommitdiff
path: root/opcodes/maxarray.xml
blob: 5913823e2aa20868fb90bdbb88e683bfcf042378 (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
<refentry id="maxarray">
<indexterm id="IndexMaxarray"><primary>maxarray</primary></indexterm>
  <refentryinfo><title>Array Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>maxarray</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>maxarray</refname>

    <refpurpose>
      returns the maximum value in an array.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      The <emphasis>maxarray</emphasis> opcode returns the maximum value
      in a k-rate array.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>kmax <command>maxarray</command> karray</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kmax</emphasis> --  variable for result.
    </para>
    <para>
      <emphasis>karray</emphasis> --  array for reading.
    </para>

  </refsect1>

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="minarray"><citetitle>minarray</citetitle></link>, 
      <link linkend="sumarray"><citetitle>sumarray</citetitle></link>, 
      <link linkend="scalearray"><citetitle>scalearray</citetitle></link>, 
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>October 2011</member>
      </simplelist>
    </para>

    <para>New in Csound version 5.14</para>
    <para>Revised in Csound version 6.00 to work on multidimensional arrays</para>
  </refsect1>
</refentry>