diff options
Diffstat (limited to 'opcodes/slicearray.xml')
-rw-r--r-- | opcodes/slicearray.xml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/opcodes/slicearray.xml b/opcodes/slicearray.xml new file mode 100644 index 0000000..9a56b82 --- /dev/null +++ b/opcodes/slicearray.xml @@ -0,0 +1,69 @@ + +<refentry id="slicearray"> +<indexterm id="IndexSlicearray"><primary>slicearray</primary></indexterm> + + <refentryinfo><title>Table Control:Table Queries</title></refentryinfo> + <refmeta> + <refentrytitle>slicearray</refentrytitle> + </refmeta> + + <refnamediv> + <refname>slicearray</refname> + <refpurpose> + Take a slice of a vector. + </refpurpose> + </refnamediv> + + <refsect1> + <title>Description</title> + <para> + Take a slice of a vector (one-dimensional k-rate array). + </para> + </refsect1> + + <refsect1> + <title>Syntax</title> + <synopsis>karray <command>slicearray</command> kinarray, istart, iend</synopsis> + </refsect1> + + <refsect1> + <title>Initialization</title> + <para> + <emphasis>istart</emphasis> -- index of the first part of the answer. + </para> + <para> + <emphasis>iend</emphasis> -- index of the first element of the answer. + </para> + </refsect1> + + <refsect1> + <title>Examples</title> + <para> + Here is an example of the slicearray opcode. It uses the file <ulink url="examples/slicearray.csd"><citetitle>slicearray.csd</citetitle></ulink>. + <example> + <title>Example of the slicearray 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/slicearray.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> +</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> |