1 |
<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 data type |
13 |
(e.g. both are real number arrays or both are integer arrays), the same size |
14 |
(same amount of elements) and all elements of the two arrays are |
15 |
exactly the same. |
16 |
</p> |
17 |
|
18 |
<h3>Function Prototype</h3> |
19 |
<p/> |
20 |
<code lang="nksp"> |
21 |
array_equal(??array1??, ??array2??) |
22 |
</code> |
23 |
|
24 |
<h3>Arguments</h3> |
25 |
<table> |
26 |
<tr> |
27 |
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
28 |
</tr> |
29 |
<tr> |
30 |
<td><code>??array1??</code></td> |
31 |
<td>Array Variable</td> |
32 |
<td>First array variable to be compared.<br> |
33 |
[required]</td> |
34 |
</tr> |
35 |
<tr> |
36 |
<td><code>??array2??</code></td> |
37 |
<td>Array Variable</td> |
38 |
<td>Second array variable to be compared.<br> |
39 |
[required]</td> |
40 |
</tr> |
41 |
</table> |
42 |
|
43 |
<h3>Return Value</h3> |
44 |
<table> |
45 |
<tr> |
46 |
<th>Data Type</th> <th>Description</th> |
47 |
</tr> |
48 |
<tr> |
49 |
<td>Integer Number</td> |
50 |
<td>Boolean result of the array comparison.</td> |
51 |
</tr> |
52 |
</table> |
53 |
|
54 |
<h3>Examples</h3> |
55 |
<p>None yet.</p> |
56 |
|
57 |
<h3>See also</h3> |
58 |
<p><code>sort()</code>, <code>search()</code><p> |
59 |
|
60 |
<h3>Availability</h3> |
61 |
<p>Since LinuxSampler 2.0.0.svn52.<p> |
62 |
|
63 |
</body> |
64 |
</html> |