Math

The Math library consists of many math constants and functions that are extremely important for things such as games, apps, etc.

Import it into your projects like so:

using Std::Math

println(Math.abs(-5)) # prints 5
println(Math.pi) # prints 3.14159...

Summary

Constants

A few global constants used heavily in mathematics:

   pi:
 number

   e:
 number

   tau:
 number

Methods

The following are mathematic functions. All of them (as of writing) take in numbers as arguments. You can convert values to numbers using the number(value) built-in function.

  abs(
 x:
 number  ,  
): number

  sin(
 x:
 number  ,  
): number

  cos(
 x:
 number  ,  
): number

  tan(
 x:
 number  ,  
): number

  asin(
 x:
 number  ,  
): number

  acos(
 x:
 number  ,  
): number

  atan(
 x:
 number  ,  
): number

  asinh(
 x:
 number  ,  
): number

  acosh(
 x:
 number  ,  
): number

  atanh(
 x:
 number  ,  
): number

  atan2(
 x:
 number  , y:
 number  ,  
): number

  floor(
 x:
 number  ,  
): number

  ceil(
 x:
 number  ,  
): number

  round(
 x:
 number  ,  
): number

  pow(
 base:
 number  , exponent:
 number  ,  
): number

  sqrt(
 x:
 number  ,  
): number

  max(
 a:
 number  , b:
 number  ,  
): number

  min(
 a:
 number  , b:
 number  ,  
): number

  clamp(
 value:
 number  , min:
 number  , max:
 number  ,  
): number

Constants

pi

readable

The ratio of any circle’s circumference to its diameter. An irrational number that keeps going but never repeats. Approximately equal to 3.14159265359.

# Area = πr²
let r = 3
let area = Math.pi * r * r
println($"The area of a circle with radius {r} is {area}")

e

readable

The mathematical constant ‘e’, also known as Euler’s number, an irrational, non-repeating decimal fundamental to natural growth, decay, and logarithms (base e or ln) Approximately equal to 2.718281828459.

tau

readable

The number tau (τ) is a mathematical constant that is the ratio of a circle’s circumference to its radius. It is approximately equal to 6.2831853 and exactly equal to 2π

Methods

abs

Returns the absolute (positive) value of a number. Or the positive distance of it from zero. Useful for converting negative values to positive ones.

  abs(
 x:
 number  ,  
): number

println(Math.abs(-5))
# prints 5

sin

Trigonometric sine of angle x in radians. Can be used to create a sin-wave or for calculating proper distance based on angles.

  abs(
 x:
 number  ,  
): number

Math.sin(x)

cos

Returns the cosine of angle x in radians. Useful for trigonometry and calculating distances or projections.

  cos(
 x:
 number  ,  
): number

tan

Returns the tangent of angle x in radians. Useful for slope calculations or angle-based math.

  tan(
 x:
 number  ,  
): number

asin

Returns the inverse sine (arc-sine) of x. The result is in radians.

  asin(
 x:
 number  ,  
): number

acos

Returns the inverse cosine (arc-cosine) of x. Result is in radians.

  acos(
 x:
 number  ,  
): number

atan

Returns the inverse tangent (arc-tangent) of x. Result is in radians.

  atan(
 x:
 number  ,  
): number

asinh

Returns the inverse hyperbolic sine of x.

  asinh(
 x:
 number  ,  
): number

acosh

Returns the inverse hyperbolic cosine of x.

  acosh(
 x:
 number  ,  
): number

atanh

Returns the inverse hyperbolic tangent of x.

  atanh(
 x:
 number  ,  
): number

atan2

Returns the arc-tangent of y / x, considering the signs of both arguments to determine the correct quadrant.

  atan2(
 y:
 number  , x:
 number  ,  
): number

floor

Rounds x down to the nearest smaller integer.

  floor(
 x:
 number  ,  
): number

ceil

Rounds x up to the nearest larger integer.

  ceil(
 x:
 number  ,  
): number

round

Rounds x to the nearest integer.

  round(
 x:
 number  ,  
): number

exp

Returns e raised to the power of x.

  exp(
 x:
 number  ,  
): number

pow

Raises base to the power of exponent.

  pow(
 base:
 number  , exponent:
 number  ,  
): number

sqrt

Returns the square root of x.

  sqrt(
 x:
 number  ,  
): number

max

Returns the larger of a or b.

  max(
 a:
 number  , b:
 number  ,  
): number

min

Returns the smaller of a or b.

  min(
 a:
 number  , b:
 number  ,  
): number

clamp

Clamps value between min and max. Useful for restricting a number to a specific range.

  clamp(
 value:
 number  , min:
 number  , max:
 number  ,  
): number