1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>ceil() function</title> |
5 |
<meta name="description" content="Rounds the given real number up."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>ceil()</h1> |
9 |
<p> |
10 |
Rounds the passed <code lang="nksp">??number??</code> <b>up</b> to the |
11 |
nearest, higher integer and returns that rounded-up value as result |
12 |
(by preserving the passed Real Number's data type for the return value |
13 |
though). The originally passed <code>??number??</code> itself remains |
14 |
untouched by this function. |
15 |
</p> |
16 |
|
17 |
<h3>Function Prototype</h3> |
18 |
<p/> |
19 |
<code lang="nksp"> |
20 |
ceil(??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 Number</td> |
31 |
<td>The real number to be rounded up.<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 Number</td> |
43 |
<td>Rounded-up Real Number of the 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>floor()</code>, <code>round()</code>, <code>real_to_int()</code><p> |
58 |
|
59 |
<h3>Availability</h3> |
60 |
<p>Since LinuxSampler 2.1.1.svn14.<p> |
61 |
|
62 |
</body> |
63 |
</html> |