reference/functions/nksp_random_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>random() function</title>
    <meta name="description" content="Random number generator function.">
  </head>
  <body>
    <h1>random()</h1>
    <p>
      Provides a pseudo random number generator. Each time this function
      is called, another random number will be returned.
    </p>
    
    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
random(??minimum??, ??maximum??)
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??minimum??</code></td>
        <td>Integer&nbsp;Number&nbsp;or<br>
            Real&nbsp;Number</td>
        <td>The smallest number of allowed value range (including this value).<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??maximum??</code></td>
        <td>Integer&nbsp;Number&nbsp;or<br>
            Real&nbsp;Number</td>
        <td>The highest number of allowed value range (including this value).<br>
            [required]</td>
      </tr>
    </table>

    <h3>Return Value</h3>
    <table>
      <tr>
        <th>Data Type</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>Integer Number</td>
        <td>Next random number within the requested value range.</td>
      </tr>
    </table>

    <h3>Remarks</h3>
    <p>
      This functions accepts any standard unit and finalness for its two arguments.
      However the unit types of the two arguments must be identical.
      The return value's unit type is identical to the two passed arguments' one,
      and the return value's finalness is the case if at least one of the two arguments
      has finalness.
    </p>

    <h3>Examples</h3>
    <p/>
    <code>
on init
  message("random(-5,5) = " & random(-5,5))
  message("random(-5,5) = " & random(-5,5))
  message("random(-5,5) = " & random(-5,5))
  message("random(-5,5) = " & random(-5,5))
end on
    </code>

  </body>
</html>
1	schoenebeck	2732	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>random() function</title>
5			<meta name="description" content="Random number generator function.">
6			</head>
7			<body>
8			<h1>random()</h1>
9			<p>
10			Provides a pseudo random number generator. Each time this function
11			is called, another random number will be returned.
12			</p>
13
14			<h3>Function Prototype</h3>
15			<p/>
16	schoenebeck	2742	<code lang="nksp">
17	schoenebeck	2732	random(??minimum??, ??maximum??)
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>??minimum??</code></td>
27	schoenebeck	3601	<td>Integer Number or<br>
28			Real Number</td>
29	schoenebeck	2732	<td>The smallest number of allowed value range (including this value).<br>
30			[required]</td>
31			</tr>
32			<tr>
33	schoenebeck	2759	<td><code>??maximum??</code></td>
34	schoenebeck	3601	<td>Integer Number or<br>
35			Real Number</td>
36	schoenebeck	2732	<td>The highest number of allowed value range (including this value).<br>
37			[required]</td>
38			</tr>
39			</table>
40	schoenebeck	3601
41	schoenebeck	2732	<h3>Return Value</h3>
42			<table>
43			<tr>
44	schoenebeck	3578	<th>Data Type</th>
45			<th>Description</th>
46	schoenebeck	2732	</tr>
47			<tr>
48	schoenebeck	3578	<td>Integer Number</td>
49	schoenebeck	2732	<td>Next random number within the requested value range.</td>
50			</tr>
51			</table>
52	schoenebeck	3601
53			<h3>Remarks</h3>
54			<p>
55			This functions accepts any standard unit and finalness for its two arguments.
56			However the unit types of the two arguments must be identical.
57			The return value's unit type is identical to the two passed arguments' one,
58			and the return value's finalness is the case if at least one of the two arguments
59			has finalness.
60			</p>
61
62	schoenebeck	2732	<h3>Examples</h3>
63			<p/>
64			<code>
65			on init
66			message("random(-5,5) = " & random(-5,5))
67			message("random(-5,5) = " & random(-5,5))
68			message("random(-5,5) = " & random(-5,5))
69			message("random(-5,5) = " & random(-5,5))
70			end on
71			</code>
72
73			</body>
74			</html>