Difference between revisions of "Math.ldexp"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(9 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 ===
Returns v12^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">
+
<syntaxhighlight lang="lua">
 
(number) = math.ldexp(v1,v2)
 
(number) = math.ldexp(v1,v2)
</source>
+
</syntaxhighlight>
 +
 
 +
Returns v1*2^v2.
 +
 
 
=== Parameters ===
 
=== 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 ===
 
=== Return values ===
'''Returns''' (number) result<br/>
+
'''Returns''' (number) the load exponent result<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
local m, n = math.frexp(16.4)
 +
print("mantissa", m, "exponent", n)
 +
print(m*2^n)
 +
local r = math.ldexp(0.5125, 5)
 +
print("load exponent result", r) -- 16.4
 +
</syntaxhighlight>
 +
 
 +
=== Note ===
 +
[[math.frexp]] is the inversed operation.
 +
 
 +
{{Math}}

Latest revision as of 14:30, 13 July 2023

Available since: Gideros 2011.6
Class: math

Description

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.

Parameters

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

Return values

Returns (number) the load exponent result

Example

local m, n = math.frexp(16.4)
print("mantissa", m, "exponent", n)
print(m*2^n)
local r = math.ldexp(0.5125, 5)
print("load exponent result", r) -- 16.4

Note

math.frexp is the inversed operation.