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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3601 - (hide annotations) (download) (as text)
Mon Sep 16 16:03:36 2019 UTC (4 years, 7 months ago) by schoenebeck
File MIME type: text/html
File size: 1756 byte(s)
* NKSP: Added recently added built-in functions to reference docs.
* NKSP: Added info about std units and finalness to existing functions.
* NKSP: Added recently added built-in constants ~NI_MATH_E and ~NI_MATH_PI.

1 schoenebeck 3601 <html>
2     <head>
3     <meta name="author" content="Christian Schoenebeck">
4     <title>pow() function</title>
5     <meta name="description" content="Calculates given base raised by given power.">
6     </head>
7     <body>
8     <h1>pow()</h1>
9     <p>
10     Calculates and returns passed <code lang="nksp">??base??</code> being
11     raised by passed <code lang="nksp">??power??</code>.
12     </p>
13    
14     <h3>Function Prototype</h3>
15     <p/>
16     <code lang="nksp">
17     pow(??base??, ??power??)
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>??base??</code></td>
27     <td>Real&nbsp;Number</td>
28     <td>Basis to be raised.<br>
29     [required]</td>
30     </tr>
31     <tr>
32     <td><code>??power??</code></td>
33     <td>Real&nbsp;Number</td>
34     <td><code>??base??</code> will be raised by this power.<br>
35     [required]</td>
36     </tr>
37     </table>
38    
39     <h3>Return Value</h3>
40     <table>
41     <tr>
42     <th>Data Type</th> <th>Description</th>
43     </tr>
44     <tr>
45     <td>Real&nbsp;Number</td>
46     <td><code>??base??</code> raised by passed <code>??power??</code>.</td>
47     </tr>
48     </table>
49    
50     <h3>Remarks</h3>
51     <p>
52     This functions accepts any standard unit and finalness for its argument <code>??base??</code>.
53     The return value's standard unit and finalness is identical to the passed <code>??base??</code>'s one.
54     </p>
55    
56     <h3>Examples</h3>
57     <p>None yet.</p>
58    
59     <h3>See also</h3>
60     <p><code>round()</code>, <code>log()</code>, <code>sqrt()</code>, <code>exp()</code>, <code>sin()</code><p>
61    
62     <h3>Availability</h3>
63     <p>Since LinuxSampler 2.1.1.svn14.<p>
64    
65     </body>
66     </html>

  ViewVC Help
Powered by ViewVC