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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3609 - (show annotations) (download) (as text)
Tue Sep 24 12:28:52 2019 UTC (13 months ago) by schoenebeck
File MIME type: text/html
File size: 1681 byte(s)
- More minor NKSP reference corrections.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>log() function</title>
5 <meta name="description" content="Calculates the natural logarithm of given number.">
6 </head>
7 <body>
8 <h1>log()</h1>
9 <p>
10 Calculates and returns the natural logarithm of the passed
11 <code lang="nksp">??number??</code>.
12 </p>
13 <note>
14 That base e is also available as built-in constant <code>~NI_MATH_E</code>.
15 </note>
16
17 <h3>Function Prototype</h3>
18 <p/>
19 <code lang="nksp">
20 log(??number??)
21 </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 <td><code>??number??</code></td>
30 <td>Real&nbsp;Number</td>
31 <td>Input value.<br>
32 [required]</td>
33 </tr>
34 </table>
35
36 <h3>Return Value</h3>
37 <table>
38 <tr>
39 <th>Data Type</th> <th>Description</th>
40 </tr>
41 <tr>
42 <td>Real&nbsp;Number</td>
43 <td>Natural logarithm of originally passed <code>??number??</code>.</td>
44 </tr>
45 </table>
46
47 <h3>Remarks</h3>
48 <p>
49 This functions accepts any standard unit and finalness for its argument <code>??number??</code>.
50 The return value's standard unit and finalness is identical to the passed <code>??number??</code>'s one.
51 </p>
52
53 <h3>Examples</h3>
54 <p>None yet.</p>
55
56 <h3>See also</h3>
57 <p><code>log2()</code>, <code>log10()</code>, <code>round()</code>, <code>sqrt()</code>, <code>exp()</code>, <code>pow()</code>, <code>sin()</code><p>
58
59 <h3>Availability</h3>
60 <p>Since LinuxSampler 2.1.1.svn14.<p>
61
62 </body>
63 </html>

  ViewVC Help
Powered by ViewVC