1 |
schoenebeck |
3601 |
<html> |
2 |
|
|
<head> |
3 |
|
|
<meta name="author" content="Christian Schoenebeck"> |
4 |
|
|
<title>log2() function</title> |
5 |
|
|
<meta name="description" content="Calculates the logarithm to base 2 of given number."> |
6 |
|
|
</head> |
7 |
|
|
<body> |
8 |
|
|
<h1>log2()</h1> |
9 |
|
|
<p> |
10 |
|
|
Calculates and returns logarithm to base 2 of the passed |
11 |
|
|
<code lang="nksp">??number??</code>. |
12 |
|
|
</p> |
13 |
|
|
|
14 |
|
|
<h3>Function Prototype</h3> |
15 |
|
|
<p/> |
16 |
|
|
<code lang="nksp"> |
17 |
|
|
log2(??number??) |
18 |
|
|
</code> |
19 |
|
|
|
20 |
|
|
<h3>Arguments</h3> |
21 |
|
|
<table> |
22 |
|
|
<tr> |
23 |
|
|
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
24 |
|
|
</tr> |
25 |
|
|
<tr> |
26 |
|
|
<td><code>??number??</code></td> |
27 |
|
|
<td>Real Number</td> |
28 |
|
|
<td>Input value.<br> |
29 |
|
|
[required]</td> |
30 |
|
|
</tr> |
31 |
|
|
</table> |
32 |
|
|
|
33 |
|
|
<h3>Return Value</h3> |
34 |
|
|
<table> |
35 |
|
|
<tr> |
36 |
|
|
<th>Data Type</th> <th>Description</th> |
37 |
|
|
</tr> |
38 |
|
|
<tr> |
39 |
|
|
<td>Real Number</td> |
40 |
|
|
<td>Logarithm to base 2 of originally passed <code>??number??</code>.</td> |
41 |
|
|
</tr> |
42 |
|
|
</table> |
43 |
|
|
|
44 |
|
|
<h3>Remarks</h3> |
45 |
|
|
<p> |
46 |
|
|
This functions accepts any standard unit and finalness for its argument <code>??number??</code>. |
47 |
|
|
The return value's standard unit and finalness is identical to the passed <code>??number??</code>'s one. |
48 |
|
|
</p> |
49 |
|
|
|
50 |
|
|
<h3>Examples</h3> |
51 |
|
|
<p>None yet.</p> |
52 |
|
|
|
53 |
|
|
<h3>See also</h3> |
54 |
|
|
<p><code>log()</code>, <code>log10()</code>, <code>round()</code>, <code>sqrt()</code>, <code>exp()</code>, <code>pow()</code>, <code>sin()</code><p> |
55 |
|
|
|
56 |
|
|
<h3>Availability</h3> |
57 |
|
|
<p>Since LinuxSampler 2.1.1.svn14.<p> |
58 |
|
|
|
59 |
schoenebeck |
3607 |
<note> |
60 |
|
|
This function exists only with NKSP, it is not available with KSP. |
61 |
|
|
</note> |
62 |
|
|
|
63 |
schoenebeck |
3601 |
</body> |
64 |
|
|
</html> |