Difference between revisions of "Math.ldexp"

Revision as of 09:49, 14 November 2022

Available since: Gideros 2011.6
Class: math

Used to multiply a floating point value v1 by the number 2 raised to the v2 power. This is called a load exponent. v2 should be an integer.

(number) = math.ldexp(v1,v2)

Returns v1*2^v2.

v1: (number) a floating point value
v2: (number) an exponent

Returns (number) the load exponent result

math.frexp is the inversed operation.

@@ Line 4: / Line 4: @@
 === Description ===
-'''''load exponent''''': multiplies a floating point value v1 by the number 2 raised to the v2 power. Returns v1*2^v2 (v2 should be an integer).
+Used to multiply a floating point value ''v1'' by the number 2 raised to the ''v2'' power. This is called a '''load exponent'''. ''v2'' should be an integer.
 <source lang="lua">
 (number) = math.ldexp(v1,v2)
 </source>
+Returns v1*2^v2.
 === Parameters ===
-'''v1''': (number) first value<br/>
+'''v1''': (number) a floating point value<br/>
-'''v2''': (number) second value<br/>
+'''v2''': (number) an exponent<br/>
 === Return values ===
-'''Returns''' (number) result<br/>
+'''Returns''' (number) the load exponent result<br/>
+=== Note ===
+[[math.frexp]] is the inversed operation.
 {{Math}}