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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3602 - (hide annotations) (download) (as text)
Mon Sep 16 16:16:09 2019 UTC (14 months, 2 weeks ago) by schoenebeck
File MIME type: text/html
File size: 1705 byte(s)
- NKSP: Mention "pi" constant where appropriate.

1 schoenebeck 3601 <html>
2     <head>
3     <meta name="author" content="Christian Schoenebeck">
4     <title>cos() function</title>
5     <meta name="description" content="Cosine function.">
6     </head>
7     <body>
8     <h1>cos()</h1>
9     <p>
10     Calculates and returns the cosine of the passed
11     <code lang="nksp">??number??</code>.
12     </p>
13 schoenebeck 3602 <note>
14     The natural constant &pi; ("pi") is also available as built-in constant <code>~NI_MATH_PI</code>.
15     </note>
16 schoenebeck 3601
17     <h3>Function Prototype</h3>
18     <p/>
19     <code lang="nksp">
20     cos(??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>Cosine 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>
58     <code>sin()</code>, <code>tan()</code>, <code>asin()</code>, <code>acos()</code>, <code>atan()</code>,
59     <code>round()</code>, <code>log()</code>, <code>exp()</code>, <code>pow()</code>
60     <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