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

Annotation of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_array_equal_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3236 - (hide annotations) (download) (as text)
Sun May 28 16:30:21 2017 UTC (3 years, 1 month ago) by schoenebeck
File MIME type: text/html
File size: 1677 byte(s)
- NKSP: minor cosmetics for array_equal() function.

1 schoenebeck 3223 <html>
2     <head>
3     <meta name="author" content="Christian Schoenebeck">
4     <title>array_equal() function</title>
5     <meta name="description" content="Check whether two arrays are equal.">
6     </head>
7     <body>
8     <h1>array_equal()</h1>
9     <p>
10     Compares the two arrays passed to this function and returns true
11     if the arrays are identical, otherwise it returns false (<code lang="nksp">0</code>).
12     The arrays are considered to be identical if they have the same size
13     (same amount of elements) and all elements of the two arrays are
14     exactly the same.
15     </p>
16    
17     <h3>Function Prototype</h3>
18     <p/>
19     <code lang="nksp">
20 schoenebeck 3236 array_equal(??array1??, ??array2??)
21 schoenebeck 3223 </code>
22    
23     <h3>Arguments</h3>
24     <table>
25     <tr>
26     <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
27     </tr>
28     <tr>
29 schoenebeck 3236 <td><code>??array1??</code></td>
30 schoenebeck 3223 <td>Integer Array Variable</td>
31     <td>First integer array variable to be compared.<br>
32     [required]</td>
33     </tr>
34     <tr>
35 schoenebeck 3236 <td><code>??array2??</code></td>
36 schoenebeck 3223 <td>Integer Array Variable</td>
37     <td>Second integer array variable to be compared.<br>
38     [required]</td>
39     </tr>
40     </table>
41    
42     <h3>Return Value</h3>
43     <table>
44     <tr>
45     <th>Description</th> <th>Data Type</th>
46     </tr>
47     <tr>
48     <td>Boolean result of the array comparison.</td>
49     <td>Integer Number</td>
50     </tr>
51     </table>
52    
53     <h3>Examples</h3>
54     <p>None yet.</p>
55    
56     <h3>See also</h3>
57     <p><code>sort()</code>, <code>search()</code><p>
58    
59     <h3>Availability</h3>
60     <p>Since LinuxSampler 2.0.0.svn52.<p>
61    
62     </body>
63     </html>

  ViewVC Help
Powered by ViewVC