asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #72091 from MewPurPur/fix-nearest-po2

Browse source 
Improve documentation of `nearest_po2()`
This commit is contained in:
Rémi Verschelde 2023-08-07 14:42:49 +02:00
commit 3fa5a15a2c
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/classes/@GlobalScope.xml
View file

@ -739,8 +739,7 @@
<return type="int" /> <return type="int" />
<param index="0" name="value" type="int" /> <param index="0" name="value" type="int" />
<description> <description>
Returns the nearest equal or larger power of 2 for the integer [param value]. Returns the smallest integer power of 2 that is greater than or equal to [param value].
In other words, returns the smallest value [code]a[/code] where [code]a = pow(2, n)[/code] such that [code]value &lt;= a[/code] for some non-negative integer [code]n[/code].
[codeblock] [codeblock]
nearest_po2(3) # Returns 4 nearest_po2(3) # Returns 4
nearest_po2(4) # Returns 4 nearest_po2(4) # Returns 4
@ -749,7 +748,7 @@
nearest_po2(0) # Returns 0 (this may not be expected) nearest_po2(0) # Returns 0 (this may not be expected)
nearest_po2(-1) # Returns 0 (this may not be expected) nearest_po2(-1) # Returns 0 (this may not be expected)
[/codeblock] [/codeblock]
[b]Warning:[/b] Due to the way it is implemented, this function returns [code]0[/code] rather than [code]1[/code] for negative values of [param value] (in reality, 1 is the smallest integer power of 2). [b]Warning:[/b] Due to its implementation, this method returns [code]0[/code] rather than [code]1[/code] for values less than or equal to [code]0[/code], with an exception for [param value] being the smallest negative 64-bit integer ([code]-9223372036854775808[/code]) in which case the [param value] is returned unchanged.
</description> </description>
</method> </method>
<method name="pingpong"> <method name="pingpong">