@spec ceil(float(), precision_range()) :: float()

Округляет число с плавающей точкой до наименьшего целого, большего или равного num.

ceil/2 также принимает точность для округления значения с плавающей точкой до произвольного числа десятичных знаков (между 0 и 15).

Операция выполняется над двоичным представлением с плавающей точкой без преобразования в десятичную систему.

Поведение ceil/2 для чисел с плавающей точкой может быть неожиданным. Например:

iex> Float.ceil(-12.52, 2)
-12.51

Можно было ожидать, что оно округлится до -12.52. Это не ошибка. Большинство десятичных дробей не могут быть представлены в двоичном формате с плавающей точкой, и поэтому указанное выше число в памяти представлено как -12.51999999, что объясняет это поведение.

Эта функция всегда возвращает числа с плавающей точкой. Kernel.trunc/1 можно использовать вместо этого для усечения результата до целого числа.

Примеры

iex> Float.ceil(34.25)
35.0
iex> Float.ceil(-56.5)
-56.0
iex> Float.ceil(34.251, 2)
34.26

@spec floor(float(), precision_range()) :: float()

Округляет число с плавающей точкой до наибольшего числа, меньшего или равного num.

floor/2 также принимает точность для округления значения с плавающей точкой до произвольного числа десятичных знаков (между 0 и 15). Операция выполняется над двоичным представлением с плавающей точкой без преобразования в десятичную систему.

Эта функция всегда возвращает число с плавающей точкой. Kernel.trunc/1 можно использовать вместо этого для усечения результата до целого числа.

Известные проблемы

Поведение floor/2 для чисел с плавающей точкой может быть неожиданным. Например:

iex> Float.floor(12.52, 2)
12.51

Можно было ожидать, что оно округлится до 12.52. Это не ошибка. Большинство десятичных дробей не могут быть представлены в двоичном формате с плавающей точкой, и поэтому указанное выше число в памяти представлено как 12.51999999, что объясняет это поведение.

Примеры

iex> Float.floor(34.25)
34.0
iex> Float.floor(-56.5)
-57.0
iex> Float.floor(34.259, 2)
34.25

Возвращает максимальное конечное значение для числа с плавающей точкой.

Примеры

iex> Float.max_finite()
1.7976931348623157e308

Возвращает минимальное конечное значение для числа с плавающей точкой.

Примеры

iex> Float.min_finite()
-1.7976931348623157e308

@spec parse(binary()) :: {float(), binary()} | :error

Парсит двоичное значение в число с плавающей точкой.

В случае успеха возвращает кортеж в форме {float, remainder_of_binary}; когда двоичное значение не может быть преобразовано в действительное число с плавающей точкой, возвращается атом :error.

Если размер числа с плавающей точкой превышает максимальный размер 1.7976931348623157e+308, возвращается :error, даже если текстовое представление само по себе может быть правильно сформировано.

Если вы хотите преобразовать строковое представление числа с плавающей точкой непосредственно в число с плавающей точкой, можно использовать String.to_float/1 вместо этого.

Примеры

iex> Float.parse("34")
{34.0, ""}
iex> Float.parse("34.25")
{34.25, ""}
iex> Float.parse("56.5xyz")
{56.5, "xyz"}

iex> Float.parse("pi")
:error
iex> Float.parse("1.7976931348623159e+308")
:error

@spec pow(float(), number()) :: float()

Вычисляет base в степени exponent.

base должно быть числом с плавающей точкой, а exponent может быть любым числом. Однако, если задано отрицательное основание и дробный показатель, генерируется исключение ArithmeticError.

Она всегда возвращает число с плавающей точкой. См. Integer.pow/2 для возведения в степень, возвращающей целые числа.

Примеры

iex> Float.pow(2.0, 0)
1.0
iex> Float.pow(2.0, 1)
2.0
iex> Float.pow(2.0, 10)
1024.0
iex> Float.pow(2.0, -1)
0.5
iex> Float.pow(2.0, -3)
0.125

iex> Float.pow(3.0, 1.5)
5.196152422706632

iex> Float.pow(-2.0, 3)
-8.0
iex> Float.pow(-2.0, 4)
16.0

iex> Float.pow(-1.0, 0.5)
** (ArithmeticError) bad argument in arithmetic expression

@spec ratio(float()) :: {integer(), pos_integer()}

Возвращает пару целых чисел, отношение которых точно равно исходному числу с плавающей точкой, и с положительным знаменателем.

Примеры

iex> Float.ratio(0.0)
{0, 1}
iex> Float.ratio(3.14)
{7070651414971679, 2251799813685248}
iex> Float.ratio(-3.14)
{-7070651414971679, 2251799813685248}
iex> Float.ratio(1.5)
{3, 2}
iex> Float.ratio(-1.5)
{-3, 2}
iex> Float.ratio(16.0)
{16, 1}
iex> Float.ratio(-16.0)
{-16, 1}

@spec round(float(), precision_range()) :: float()

Округляет значение с плавающей точкой до произвольного числа десятичных знаков (от 0 до 15).

Направление округления всегда соответствует правилу "округлять до ближайшего, если половина, то вверх". Операция выполняется над двоичным представлением с плавающей точкой без преобразования в десятичную систему.

Эта функция принимает только числа с плавающей точкой и всегда возвращает число с плавающей точкой. Используйте Kernel.round/1, если вам нужна функция, которая принимает как числа с плавающей точкой, так и целые числа и всегда возвращает целое число.

Известные проблемы

Поведение round/2 для чисел с плавающей точкой может быть неожиданным. Например:

iex> Float.round(5.5675, 3)
5.567

Можно было ожидать, что оно округлится до 5.568 по правилу "округлять до ближайшего, если половина, то вверх". Это не ошибка. Большинство десятичных дробей не могут быть представлены в двоичном формате с плавающей точкой, и поэтому указанное выше число в памяти представлено как 5.567499999, что объясняет это поведение. Если вам нужно точное округление десятичных дробей, используйте библиотеку десятичных чисел. Вышеуказанное поведение также соответствует эталонным реализациям, например, "Correctly Rounded Binary-Decimal and Decimal-Binary Conversions" Дэвида М. Гейя.

Примеры

iex> Float.round(12.5)
13.0
iex> Float.round(5.5674, 3)
5.567
iex> Float.round(5.5675, 3)
5.567
iex> Float.round(-5.5674, 3)
-5.567
iex> Float.round(-5.5675)
-6.0
iex> Float.round(12.341444444444441, 15)
12.341444444444441

@spec to_charlist(float()) :: charlist()

Возвращает список символов, который соответствует кратчайшему текстовому представлению данного числа с плавающей точкой.

Базовый алгоритм изменяется в зависимости от версии Erlang/OTP:

• Для OTP >= 24 используется алгоритм, представленный в "Ryū: fast float-to-string conversion" в Proceedings of the SIGPLAN '2018 Conference on Programming Language Design and Implementation.

• Для OTP < 24 используется алгоритм, представленный в "Printing Floating-Point Numbers Quickly and Accurately" в Proceedings of the SIGPLAN '1996 Conference on Programming Language Design and Implementation.

Для настраиваемого представления используйте :erlang.float_to_list/2.

Примеры

iex> Float.to_charlist(7.0)
'7.0'

@spec to_string(float()) :: String.t()

Возвращает двоичное значение, соответствующее кратчайшему текстовому представлению данного числа с плавающей точкой.

Базовый алгоритм изменяется в зависимости от версии Erlang/OTP:

• Для OTP >= 24 используется алгоритм, представленный в "Ryū: fast float-to-string conversion" в Proceedings of the SIGPLAN '2018 Conference on Programming Language Design and Implementation.

• Для OTP < 24 используется алгоритм, представленный в "Printing Floating-Point Numbers Quickly and Accurately" в Proceedings of the SIGPLAN '1996 Conference on Programming Language Design and Implementation.

Для настраиваемого представления используйте :erlang.float_to_binary/2.

Примеры

iex> Float.to_string(7.0)
"7.0"