Difference between revisions of "Math.random"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[math]]<br/>
 +
 
=== Description ===
 
=== Description ===
 
This function is an interface to the simple pseudo-random generator function rand provided by ANSI C. (No guarantees can be given for its statistical properties.)  
 
This function is an interface to the simple pseudo-random generator function rand provided by ANSI C. (No guarantees can be given for its statistical properties.)  
 +
<syntaxhighlight lang="lua">
 +
(number) = math.random(n,u)
 +
</syntaxhighlight>
  
 +
When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].
  
When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].
+
=== Parameters ===
<source lang="lua">
 
(number) = math.random(n,u)
 
</source>
 
 
'''n''': (number) upper limit if only n provided, lower limit if u also provided '''optional'''<br/>
 
'''n''': (number) upper limit if only n provided, lower limit if u also provided '''optional'''<br/>
 
'''u''': (number) upper limit '''optional'''<br/>
 
'''u''': (number) upper limit '''optional'''<br/>
 +
 +
=== Return values ===
 
'''Returns''' (number) pseudo random number<br/>
 
'''Returns''' (number) pseudo random number<br/>
 +
 +
=== See Also ===
 +
'''[[Core.random]]'''
 +
 +
{{Math}}

Latest revision as of 14:31, 13 July 2023

Available since: Gideros 2011.6
Class: math

Description

This function is an interface to the simple pseudo-random generator function rand provided by ANSI C. (No guarantees can be given for its statistical properties.)

(number) = math.random(n,u)

When called without arguments, returns a uniform pseudo-random real number in the range [0,1). When called with an integer number m, math.random returns a uniform pseudo-random integer in the range [1, m]. When called with two integer numbers m and n, math.random returns a uniform pseudo-random integer in the range [m, n].

Parameters

n: (number) upper limit if only n provided, lower limit if u also provided optional
u: (number) upper limit optional

Return values

Returns (number) pseudo random number

See Also

Core.random