std.math

Математический модуль. Все функции чистые по значению: аргументы передаются по значению (Copy-семантика), без заимствования, без перемещения, без побочных эффектов.

use std.math

Константы

Импортируются по имени:

use std.math.{PI, E, TAU}

Константа	Тип	Значение
PI	Float	π ≈ 3.141592653589793
E	Float	e ≈ 2.718281828459045
TAU	Float	2π ≈ 6.283185307179586

use std.assert
use std.math.{E, PI, TAU}

main: () -> Void = {
    assert(PI > 3.14 and PI < 3.15)
    assert(E > 2.71 and E < 2.72)
    assert(TAU > 6.28 and TAU < 6.29)
}

Список функций

Функция	Сигнатура
abs	(n: Int) -> Int
max	(a: Int, b: Int) -> Int
min	(a: Int, b: Int) -> Int
clamp	(value: Int, min: Int, max: Int) -> Int
fabs	(n: Float) -> Float
fmax	(a: Float, b: Float) -> Float
fmin	(a: Float, b: Float) -> Float
pow	(base: Float, exp: Float) -> Float
sqrt	(n: Float) -> Float
floor	(n: Float) -> Float
ceil	(n: Float) -> Float
round	(n: Float) -> Float
sin	(n: Float) -> Float
cos	(n: Float) -> Float
tan	(n: Float) -> Float
PI	Float
E	Float
TAU	Float

Семейство целочисленных функций принимает `Int`, семейство вещественных — `Float`. При передаче значения несоответствующего типа оно приводится к `0` (если преобразование `to_int` / `to_float` завершается неудачей — выполняется откат к `0`); ошибка при этом не возникает — рекомендуется полагаться на проверку типов во время компиляции.

Целочисленные функции

abs

abs: (n: Int) -> Int

Абсолютное значение.

use std.assert
use std.math

main: () -> Void = {
    assert(math.abs(-5) == 5)
    assert(math.abs(5) == 5)
}

max

max: (a: Int, b: Int) -> Int

Большее из двух значений.

use std.assert
use std.math

main: () -> Void = {
    assert(math.max(3, 7) == 7)
}

min

min: (a: Int, b: Int) -> Int

Меньшее из двух значений.

use std.assert
use std.math

main: () -> Void = {
    assert(math.min(3, 7) == 3)
}

clamp

clamp: (value: Int, min: Int, max: Int) -> Int

Ограничивает value диапазоном [min, max].

• value — ограничиваемое значение
• min — нижняя граница (включительно)
• max — верхняя граница (включительно)

Возвращает: значение, попадающее в диапазон. Если значение меньше нижней границы, возвращается min; если больше верхней — возвращается max.

min > max приводит к панике интерпретатора (#339) (предусловие базового i64::clamp), а не к возврату ошибочного значения. Пожалуйста, гарантируйте, что min <= max.

use std.assert
use std.math

main: () -> Void = {
    assert(math.clamp(15, 1, 10) == 10)
    assert(math.clamp(-5, 1, 10) == 1)
    assert(math.clamp(5, 1, 10) == 5)
}

Вещественные функции

fabs

fabs: (n: Float) -> Float

Абсолютное значение вещественного числа.

use std.assert
use std.math

main: () -> Void = {
    assert(math.fabs(-2.5) == 2.5)
}

fmax

fmax: (a: Float, b: Float) -> Float

Большее из двух вещественных значений.

use std.assert
use std.math

main: () -> Void = {
    assert(math.fmax(1.5, 2.5) == 2.5)
}

fmin

fmin: (a: Float, b: Float) -> Float

Меньшее из двух вещественных значений.

use std.assert
use std.math

main: () -> Void = {
    assert(math.fmin(1.5, 2.5) == 1.5)
}

pow

pow: (base: Float, exp: Float) -> Float

Возведение base в степень exp.

use std.assert
use std.math

main: () -> Void = {
    assert(math.pow(2.0, 10.0) == 1024.0)
}

sqrt

sqrt: (n: Float) -> Float

Квадратный корень. Для отрицательных чисел возвращается NaN (без ошибки).

use std.assert
use std.math

main: () -> Void = {
    assert(math.sqrt(4.0) == 2.0)
    assert(math.sqrt(2.0) > 1.41 and math.sqrt(2.0) < 1.42)
}

floor

floor: (n: Float) -> Float

Округление вниз, результат остаётся Float.

use std.assert
use std.math

main: () -> Void = {
    assert(math.floor(3.7) == 3.0)
}

ceil

ceil: (n: Float) -> Float

Округление вверх, результат остаётся Float.

use std.assert
use std.math

main: () -> Void = {
    assert(math.ceil(3.2) == 4.0)
}

round

round: (n: Float) -> Float

Округление до ближайшего (половинки округляются в направлении от нуля), результат остаётся Float.

use std.assert
use std.math

main: () -> Void = {
    assert(math.round(3.5) == 4.0)
    assert(math.round(3.4) == 3.0)
}

sin

sin: (n: Float) -> Float

Синус, аргумент задаётся в радианах.

use std.assert
use std.math

main: () -> Void = {
    assert(math.sin(0.0) == 0.0)
}

cos

cos: (n: Float) -> Float

Косинус, аргумент задаётся в радианах.

use std.assert
use std.math

main: () -> Void = {
    assert(math.cos(0.0) == 1.0)
}

tan

tan: (n: Float) -> Float

Тангенс, аргумент задаётся в радианах.

use std.assert
use std.math

main: () -> Void = {
    assert(math.tan(0.0) == 0.0)
}

Связанные материалы

• std.string.parse_float — разбор строки в Float