/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_sort_function.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_sort_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3223 - (show annotations) (download) (as text)
Fri May 26 19:14:44 2017 UTC (3 years, 7 months ago) by schoenebeck
File MIME type: text/html
File size: 1545 byte(s)
* NKSP: Added built-in functions array_equal(), search() and sort().

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>sort() function</title>
5 <meta name="description" content="Sort the given array.">
6 </head>
7 <body>
8 <h1>sort()</h1>
9 <p>
10 Sorts the values in the given array.
11 </p>
12
13 <h3>Function Prototype</h3>
14 <p/>
15 <code lang="nksp">
16 sort(??array??, [??descending??])
17 </code>
18
19 <h3>Arguments</h3>
20 <table>
21 <tr>
22 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
23 </tr>
24 <tr>
25 <td><code>??array??</code></td>
26 <td>Integer Array Variable</td>
27 <td>The integer array variable to be sorted.<br>
28 [required]</td>
29 </tr>
30 <tr>
31 <td><code>??descending??</code></td>
32 <td>Integer Number</td>
33 <td>Defines in which order the array shall be sorted.<br>
34 <b>0</b>: The values are sorted in ascending order.<br>
35 <b>1</b>: The values are sorted in descending order.<br>
36 [optional, default: <b>0</b>]</td>
37 </tr>
38 </table>
39
40 <h3>Return Value</h3>
41 <p>None.</p>
42
43 <h3>Examples</h3>
44 <p>None yet.</p>
45
46 <h3>See also</h3>
47 <p><code>search()</code>, <code>array_equal()</code><p>
48
49 <h3>Availability</h3>
50 <p>Since LinuxSampler 2.0.0.svn52.<p>
51
52 <note>
53 Dynamic, optional arguments are only supported by NKSP. If you want to
54 retain compatibility to KSP, then you should always pass a parameter
55 for the 2nd argument of this function.
56 </note>
57
58 </body>
59 </html>

  ViewVC Help
Powered by ViewVC