diff options
Diffstat (limited to 'opcodes/vtabk.xml')
| -rw-r--r-- | opcodes/vtabk.xml | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/opcodes/vtabk.xml b/opcodes/vtabk.xml index 75b0768..6985a4b 100644 --- a/opcodes/vtabk.xml +++ b/opcodes/vtabk.xml @@ -9,17 +9,17 @@ <refnamediv> <refname>vtabk</refname> <refpurpose> - Read vectors (from tables -or arrays of vectors). - + Read vectors (from tables -or arrays of vectors). </refpurpose> </refnamediv> <refsect1> <title>Description</title> <para> - This opcode reads vectors from tables at k-rate. + This opcode reads vectors from tables at k-rate. </para> </refsect1> + <refsect1> <title>Syntax</title> <synopsis><command>vtabk</command> kndx, ifn, kout1 [, kout2, kout3, .... , koutN ]</synopsis> @@ -41,16 +41,13 @@ <emphasis>kout1...koutN</emphasis> - output vector elements </para> <para> - This opcode is useful in all cases in which one needs to access sets of values associated to unique indexes (for example, multi-channel samples, STFT bin frames, spectral formants, p-field based scores etc.) . The number of elements of each vector (length of the vector) is determined by the number of optional arguments on the right (kout1 , kout2, kout3, .... koutN). - </para> - <para> - Notice that no wrap nor limit mode is implemented. So, if an index attempt to access to a zone not allocated by the table, Csound will probably crash. However this drawback can be easily avoided by using wrap or limit opcodes applied to indexes before using vtable, in order to correct eventual out-of-range values. + This opcode is useful in all cases in which one needs to access sets of values associated to unique indexes (for example, multi-channel samples, STFT bin frames, spectral formants, p-field based scores etc.) . The number of elements of each vector (length of the vector) is determined by the number of optional arguments on the right (<emphasis>kout1</emphasis>, <emphasis>kout2</emphasis>, <emphasis>kout3</emphasis>, .... <emphasis>koutN</emphasis>). </para> <para> - Notice that <emphasis>vtabk</emphasis> output arguments are placed at the left of the opcode name, differently from usual (this style is already used in other opcodes using undefined lists of output arguments such as fin or trigseq). + Notice that no wrap nor limit mode is implemented. So, if an index attempt to access to a zone not allocated by the table, Csound will probably crash. However this drawback can be easily avoided by using wrap or limit opcodes applied to indexes before using <emphasis>vtabk</emphasis>, in order to correct eventual out-of-range values. </para> <para> - The <command>vtab</command> family is similar to <command>vtable</command>, but is much faster because interpolation is not available, table number cannot be changed after initialization, and only raw indexing is supported. + The <command>vtab</command> family is similar to <command>vtable</command>, but is much faster because interpolation is not available, table number cannot be changed after initialization, and only raw indexing is supported. </para> <note> <para> |