Module builtins

Some of Python's builtin functions

Functions

abs (n) Get absolute value of a number
all (iterable) All elements in an iterable evaluate to true
any (iterable) Any elements in an iterable evaluate to true
count (value, input) Count occurrences of value in input
div (x, y) Floor division of x by y
eval (input) Evaluates a string as code and returns result (Python style!)
filter (filt, iterable) Filter elements of an iterable with a function
hash (input) Unique integer representation of input
int (input) Convert input into an integer
iter (iterable) Iterate over the elements in an iterable
len (input) Length of iterable
map (func, iterable) Call function on each element of an iterable
max (...) Get the maximum value of two or more values
min (...) Get the minimum value of two or more values
num (input) Convert input into a number
range (r, stop, step) Create an array of ordered numbers (range of numbers)
repr (input) Simple string representation of an object
requal (value1, value2) Check if all values in two iterables are equal (recursive-equal)
reversed (iterable) Reverse the order of the elements in an iterable
round (n, places) Round a number to places
sign (n) Sign of a number
sorted (object, key, reverse) Sort an object
sum (iterable) Sum of the values in an iterable


Functions

abs (n)
Get absolute value of a number

Parameters:

  • n number any number

Returns:

    number absolute value of number
all (iterable)
All elements in an iterable evaluate to true

Parameters:

  • iterable any table-like object

Returns:

    boolean all elements are true
any (iterable)
Any elements in an iterable evaluate to true

Parameters:

  • iterable any table-like object

Returns:

    boolean any elements are true
count (value, input)
Count occurrences of value in input

Parameters:

  • value any object
  • input any object that can contain value

Returns:

    number how many of value is in input
div (x, y)
Floor division of x by y

Parameters:

  • x number the numerator
  • y number the denominator

Returns:

    number integer result of x / y
eval (input)
Evaluates a string as code and returns result (Python style!)

Parameters:

  • input

Returns:

    stuff
filter (filt, iterable)
Filter elements of an iterable with a function

Parameters:

  • filt
  • iterable

Returns:

hash (input)
Unique integer representation of input

Parameters:

  • input an integer, string or any object that has a __hash method

Returns:

    integer unique integer representation of object
int (input)
Convert input into an integer

Parameters:

  • input any object that can be converted into an integer

Returns:

    int of input
iter (iterable)
Iterate over the elements in an iterable

Parameters:

  • iterable

Returns:

len (input)
Length of iterable

Parameters:

  • input any iterable

Returns:

    number length of the iterable
map (func, iterable)
Call function on each element of an iterable

Parameters:

  • func
  • iterable

Returns:

max (...)
Get the maximum value of two or more values

Parameters:

  • ... any objects that can be compared with <, >, and ==

Returns:

    maximum value of what was passed
min (...)
Get the minimum value of two or more values

Parameters:

  • ... any objects that can be compared with <, >, and ==

Returns:

    minimum value of what was passed
num (input)
Convert input into a number

Parameters:

  • input any object that can be converted into a number

Returns:

    number input as a number
range (r, stop, step)
Create an array of ordered numbers (range of numbers)

Parameters:

  • r int If multiple arguments r is start of range, otherwise r is end of range (inclusive)
  • stop int (optional) Final number in the range (inclusive)
  • step int (optional) Distance between each number in the range (can be negative)

Returns:

    table array of numbers

Usage:

    -- range(5)        -- {1, 2, 3, 4, 5}
    range(0, 2)     -- {0, 1, 2}
    range(0, 9, 2)  -- {0, 2, 4, 6, 8}
    range(5, 1, -1) -- {5, 4, 3, 2, 1}
repr (input)
Simple string representation of an object

Parameters:

  • input

Returns:

requal (value1, value2)
Check if all values in two iterables are equal (recursive-equal)

Parameters:

  • value1 iterable for equality check
  • value2 iterable for equality check

Returns:

    boolean all values in both iterables are recursively equal
reversed (iterable)
Reverse the order of the elements in an iterable

Parameters:

  • iterable object to reverse order of

Returns:

    table copy of object with elements in reverse order
round (n, places)
Round a number to places

Parameters:

  • n number number to round
  • places number number of decimal places to round to

Returns:

    number num rounded to places
sign (n)
Sign of a number

Parameters:

  • n number any number

Returns:

    1 or -1 sign of the number
sorted (object, key, reverse)
Sort an object

Parameters:

  • object
  • key
  • reverse

Returns:

sum (iterable)
Sum of the values in an iterable

Parameters:

  • iterable table containing numbers

Returns:

    number result of adding all numbers in the iterable
generated by LDoc 1.4.6 Last updated 2018-11-10 22:55:04