Difference between revisions of "Module:BaseConvert"

From blackwiki
Jump to navigation Jump to search
blackwiki>Toohool
(handle bad input)
blackwiki>Toohool
(add support for leading zeros)
Line 3: Line 3:
 
-- templates such as {{binary}}, {{octal}}, {{hexadecimal}}, etc.
 
-- templates such as {{binary}}, {{octal}}, {{hexadecimal}}, etc.
 
--
 
--
−
-- If a number is passed in the precision argument, that number of digits
+
-- precision -  number of digits to be rendered after the radix point. Trailing
−
-- will be shown following the radix point. If no precision is specified,
+
--   zeros will be added if needed. If not specified, however many digits are
−
-- however many digits are needed will be shown, up to 10.
+
--  needed will be shown, up to 10.
−
--
+
-- width - minimum number of digits to be rendered before the radix point.
 +
--  Leading zeros will be added if needed.
  
 
local p = {}
 
local p = {}
Line 12: Line 13:
 
local digits = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
local digits = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
  
−
function p._convert(n, base, precision)
+
function p._convert(n, base, precision, width)
 
     local num = tonumber(n)
 
     local num = tonumber(n)
 
     base = tonumber(base)
 
     base = tonumber(base)
 
     precision = tonumber(precision)
 
     precision = tonumber(precision)
 +
    width = tonumber(width)
 
      
 
      
 
     if not num or not base then return n end
 
     if not num or not base then return n end
Line 33: Line 35:
 
         table.insert(t, 1, digits:sub(d, d))
 
         table.insert(t, 1, digits:sub(d, d))
 
     until i == 0
 
     until i == 0
 +
    while #t < (width or 0) do
 +
        table.insert(t, 1, '0')
 +
    end
 
     local intPart = table.concat(t, '')
 
     local intPart = table.concat(t, '')
 
      
 
      
Line 69: Line 74:
 
     local base = frame.args.base
 
     local base = frame.args.base
 
     local precision = frame.args.precision
 
     local precision = frame.args.precision
−
     return p._convert(n, base, precision)
+
    local width = frame.args.width
 +
     return p._convert(n, base, precision, width)
 
end
 
end
  
 
return p
 
return p

Revision as of 05:48, 23 February 2013

Converts numbers to a specified base between 2 and 36, for use in templates such as {{binary}}, {{octal}}, {{hexadecimal}}, etc.

Example usage:

local BaseConvert = require('Module:BaseConvert')
BaseConvert.convert({n = 14600926, base = 16}) -- returns 'DECADE'

Arguments:

  • n - (required) the number to be converted, as a string. It may be a number instead, if the input base is 10.
  • base - (required) the base to which the number should be converted. May be between 2 and 36, inclusive.
  • from - the base of the input. Defaults to 10 (or 16 if the input has a leading '0x'). Note that bases other than 10 are not supported if the input has a fractional part.
  • precision - number of digits to be rendered after the radix point. Trailing zeros will be added if needed. If not specified, however many digits are needed will be shown, up to 10.
  • width - minimum number of digits to be rendered before the radix point. Leading zeros will be added if needed.
  • default - Value to return if n is empty or non-numeric. Defaults to the value of n.
  • prefix / suffix - wikitext to add before/after the returned result. Will not be added if n is empty or non-numeric. For example, you might use a prefix of 0x when converting to hex, or a suffix of <sub>8</sub> when converting to octal.

--
-- Converts numbers to a specified base between 2 and 36, for use in
-- templates such as {{binary}}, {{octal}}, {{hexadecimal}}, etc.
--
-- precision -  number of digits to be rendered after the radix point. Trailing
--   zeros will be added if needed. If not specified, however many digits are
--   needed will be shown, up to 10.
-- width - minimum number of digits to be rendered before the radix point.
--   Leading zeros will be added if needed.

local p = {}

local digits = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'

function p._convert(n, base, precision, width)
    local num = tonumber(n)
    base = tonumber(base)
    precision = tonumber(precision)
    width = tonumber(width)
    
    if not num or not base then return n end
    
    local sign = ''
    if num < 0 then
        sign = '-'
        num = -num
    end
    
    local i, f = math.modf(num)

    local t = {}
    repeat
        local d = (i % base) + 1
        i = math.floor(i / base)
        table.insert(t, 1, digits:sub(d, d))
    until i == 0
    while #t < (width or 0) do
        table.insert(t, 1, '0') 
    end
    local intPart = table.concat(t, '')
    
    -- compute the fractional part
    local tf = {}
    while f > 0 and #tf < (precision or 10) do
        f = f * base
        i, f = math.modf(f)
        table.insert(tf, digits:sub(i + 1, i + 1))
    end
    
    -- add trailing zeros if needed
    if precision and #tf < precision then
        for i = 1, precision - #tf do
            table.insert(tf, '0') 
        end
    end

    fracPart = table.concat(tf, '')
    
    -- remove trailing zeros if not needed
    if not precision then
        fracPart = fracPart:gsub('0*$', '')
    end
    
    -- add the radix point if needed
    if #fracPart > 0 then
        fracPart = '.' .. fracPart
    end
    
    return sign .. intPart .. fracPart
end

function p.convert(frame)
    local n = frame.args.n
    local base = frame.args.base
    local precision = frame.args.precision
    local width = frame.args.width
    return p._convert(n, base, precision, width)
end

return p