The Standard Library
NumFu comes with a comprehensive set of built-in constants and functions covering mathematics, string manipulation, list operations, and more. They are grouped into different modules that can be imported using the import statement.
For example, to import something from the math module:
import pi, e from "math"
// `pi` and `e` can be used later in the code
For more information on how to use modules and imports, see the Imports chapter in the guide.
math
The math module offers a variety of mathematical functions and constants.
Constants
pi
Type: Number
Description: Mathematical constant π (pi)
Value: 3.14159265358979323846...
e
Type: Number
Description: Euler's number (base of natural logarithm)
Value: 2.71828182845904523536...
Trigonometric Functions
sin(x)
Parameters: Number - angle in radians
Returns: Number - sine of x
cos(x)
Parameters: Number - angle in radians
Returns: Number - cosine of x
tan(x)
Parameters: Number - angle in radians
Returns: Number - tangent of x
asin(x), acos(x), atan(x)
Parameters: Number - value
Returns: Number - inverse trig function result in radians
atan2(y, x)
Parameters: Number, Number - y and x coordinates
Returns: Number - angle in radians from x-axis to point (x,y)
Hyperbolic Functions
sinh(x), cosh(x), tanh(x)
Parameters: Number
Returns: Number - hyperbolic sine, cosine, or tangent
asinh(x), acosh(x), atanh(x)
Parameters: Number
Returns: Number - inverse hyperbolic function
Exponential and Logarithmic Functions
exp(x)
Parameters: Number
Returns: Number - e raised to the power x
log(x, base)
Parameters: Number, Number - value and base
Returns: Number - logarithm of x in given base
log10(x)
Parameters: Number
Returns: Number - base-10 logarithm
sqrt(x)
Parameters: Number
Returns: Number - square root
Rounding and Comparison Functions
ceil(x)
Parameters: Number
Returns: Number - smallest integer ≥ x
floor(x)
Parameters: Number
Returns: Number - largest integer ≤ x
round(x), round(x, precision)
Parameters: Number or Number, Number
Returns: Number - rounded value
sign(x)
Parameters: Number
Returns: Number - -1, 0, or 1
sign(5) // 1
sign(-3) // -1
sign(0) // 0
abs(x)
Parameters: Number
Returns: Number - absolute value
max(...numbers), max(list)
Parameters: Variable numbers or a list
Returns: Number - maximum value
max(1, 5, 3, 9, 2) // 9
max([1, 5, 3, 9, 2]) // 9
min(...numbers), min(list)
Parameters: Variable numbers or a list
Returns: Number - minimum value
min(1, 5, 3, 9, 2) // 1
min([1, 5, 3, 9, 2]) // 1
Utility Functions
sum(list)
Parameters: List<Number>
Returns: Number - sum of all elements in the list
sum([1, 2, 3]) // 6
sum([1, 2, 3, 4]) // 10
radians(x)
Parameters: Number
Returns: Number - radians representation of x
radians(180) // 3.14159265358979
radians(90) == pi/2 // true
degrees(x)
Parameters: Number
Returns: Number - degrees representation of x
degrees(pi) // 180
degrees(pi/2) == 90 // true
types
The types module provides functions for converting and checking data types.
isnan(x)
Parameters: Number
Returns: Boolean - true if x is NaN (Not a Number)
isnan(nan) // true
isnan(0/0) // true
isinf(x)
Parameters: Number
Returns: Boolean - true if x is positive or negative infinity
isinf(1/0) // true
isinf(-(1/0)) // true
Bool(x)
Parameters: Any
Returns: Boolean - boolean representation
Falsy values: false, 0, "", []
Truthy values: Everything else
Bool(1) // true
Bool(0) // false
Bool("hello") // true
Bool("") // false
Bool([1, 2]) // true
Bool([]) // false
Number(x)
Parameters: Boolean | Number | String
Returns: Number - numeric representation
Number(true) // 1
Number(false) // 0
Number("42") // 42
Number("3.14") // 3.14
Number("hello") // Error: Can't convert to number
List(x)
Parameters: Any (must be iterable)
Returns: List - list representation
List("hello") // ["h", "e", "l", "l", "o"]
List([1, 2, 3]) // [1, 2, 3]
String(x)
Parameters: Any
Returns: String - string representation
String(42) // "42"
String(true) // "true"
String([1, 2, 3]) // "[1, 2, 3]"
std
The std module provides a variety of functions for working with lists and strings, along with various other utilities.
List Operations
append(list, element)
Parameters: List, Any
Returns: List - new list with element added at end
append([1, 2, 3], 4) // [1, 2, 3, 4]
append([], "first") // ["first"]
length(list), length(string)
Parameters: List | String
Returns: Number - number of elements/characters
length([1, 2, 3, 4]) // 4
length("hello") // 5
length([]) // 0
contains(list, element), contains(string, substring)
Parameters: List, Any or String, String
Returns: Boolean - true if element is found
contains([1, 2, 3], 2 ) // true
contains("hello", "lo") // true
contains([1, 2, 3], 4) // false
set(list, index, value), set(string, index, char)
Parameters: List, Number, Any or String, Number, String
Returns: List | String - new collection with element changed
set([1, 2, 3], 1, 99) // [1, 99, 3]
set("hello", 0, "H") // "Hello"
reverse(list), reverse(string)
Parameters: List | String
Returns: List | String - reversed collection
reverse([1, 2, 3, 4]) // [4, 3, 2, 1]
reverse("hello") // "olleh"
sort(list), sort(string)
Parameters: List | String
Returns: List | String - sorted collection
sort([3, 1, 4, 1, 5]) // [1, 1, 3, 4, 5]
sort("dcba") // "abcd"
slice(collection, start, end)
Parameters: List | String, Number, Number
Returns: List | String - slice from start to end (inclusive)
Use -x for end to go to the end of the collection.
slice([1, 2, 3, 4, 5], 1, 3) // [2, 3, 4]
slice("hello", 1, 3) // "ell"
slice([1, 2, 3, 4, 5], 2, -2) // [3, 4]
String-Specific Operations
join(list, separator)
Parameters: List<String>, String
Returns: String - elements joined with separator
join(["hello", "world"], "-") // "hello-world"
join([], ",") // ""
split(string, delimiter)
Parameters: String, String
Returns: List - string split by delimiter
split("hello,world", ",") // ["hello", "world"]
split("one two three", " ") // ["one", "two", "three"]
split("hello", "") // ["hello"]
format(template, ...args)
Parameters: String, ...String
Returns: String - formatted string
Use {} as placeholders in the template.
format("Hello, {}!", "World") // "Hello, World!"
format("{} + {} = {}", "2", "3", "5") // "2 + 3 = 5"
format("Name: {}, Age: {}", "Alice", "30") // "Name: Alice, Age: 30"
trim(string)
Parameters: String
Returns: String - string with leading and trailing whitespace removed
trim(" hello ") // "hello"
toLowerCase(string)
Parameters: String
Returns: String - string in lowercase
toLowerCase("HELLO") // "hello"
toUpperCase(string)
Parameters: String
Returns: String - string in uppercase
toUpperCase("hello") // "HELLO"
replace(string, old, new)
Parameters: String, String, String
Returns: String - string with occurrences of old replaced by new
replace("hello world", "world", "there") // "hello there"
count(string, substring)
Parameters: String, String
Returns: Number - count of occurrences of substring in string
count("hello hello", "hello") // 2
Utility Functions
range(start, end)
Parameters: Number, Number
Returns: List - list of numbers from start to end (end not included)
range(1, 5) // [1, 2, 3, 4]
io
The io module provides functions for reading and writing input and output.
print(value)
Parameters: Any
Returns: Any - the input value (for chaining)
Prints the value without a newline.
print("Hello") // Prints: Hello
print(42) // Prints: 42
println(value)
Parameters: Any
Returns: Any - the input value (for chaining)
Prints the value with a newline.
println("Hello") // Prints: Hello\n
println(42) // Prints: 42\n
input(), input(prompt)
Parameters: None or String
Returns: String - text entered by the user
Read text entered by the user. You can optionally pass a prompt string.
input("What is your name? ")
What is your name? John // user enters "John"
Hello, John! // Output
random
The random module provides functions for generating random numbers.
random()
Parameters: None
Returns: Number - random number between 0 and 1
random() // 0.7234567891234567 (example)
random() * 10 // Random number 0-10
floor(random() * 6) + 1 // Random dice roll 1-6
seed(value)
Parameters: Number | String
Returns: None - seeds the random number generator
seed(42) // Set seed for reproducible randomness
seed("hello") // Can also use strings as seeds
system
The system module provides functions for interacting with the operating system.
time()
Parameters: None
Returns: Number - current Unix timestamp