Модуль Float

module Float: sig .. end

Арифметика с плавающей точкой.

Числа с плавающей точкой OCaml следуют стандарту IEEE 754, используя числа двойной точности (64 бита). Операции с плавающей точкой никогда не генерируют исключения при переполнении, недополнении, делении на ноль и т. д. Вместо этого возвращаются специальные числа IEEE, такие как infinity для 1.0 /. 0.0, neg_infinity для -1.0 /. 0.0, и nan ('не число') для 0.0 /. 0.0. Эти специальные числа затем распространяются через вычисления с плавающей точкой как ожидается: например, 1.0 /. infinity равно 0.0, базовые арифметические операции (+., -., *., /.) с nan в качестве аргумента возвращают nan, ...

Since 4.07

val zero : float

Число 0 с плавающей точкой.

Since 4.08

val one : float

Число 1 с плавающей точкой.

Since 4.08

val minus_one : float

Число -1 с плавающей точкой.

Since 4.08

val neg : float -> float

Унарное отрицание.

val add : float -> float -> float

Сложение чисел с плавающей точкой.

val sub : float -> float -> float

Вычитание чисел с плавающей точкой.

val mul : float -> float -> float

Умножение чисел с плавающей точкой.

val div : float -> float -> float

Деление чисел с плавающей точкой.

val fma : float -> float -> float -> float

fma x y z возвращает x * y + z, с максимальными усилиями по вычислению этого выражения с одной округлением, используя либо аппаратные инструкции (обеспечивающие полное соответствие IEEE), либо программную эмуляцию.

В 64-битных Cygwin, 64-битных mingw-w64 и MSVC 2017 и более ранних версиях эта функция может быть эмулирована из-за известных ошибок и ограничений на этих платформах. Примечание: поскольку программная эмуляция fma является дорогостоящей, убедитесь, что вы используете аппаратную поддержку fma, если производительность имеет значение.

Since 4.08

val rem : float -> float -> float

rem a b возвращает остаток от деления a на b. Возвращаемое значение равно a -. n *. b, где n — это целое число, полученное из частного a /. b округлением к нулю.

val succ : float -> float

succ x возвращает число с плавающей точкой, непосредственно следующее за x, т. е. наименьшее число с плавающей точкой, большее чем x. См. также Float.next_after.

Since 4.08

val pred : float -> float

pred x возвращает число с плавающей точкой, непосредственно предшествующее x, т. е. наибольшее число с плавающей точкой, меньшее чем x. См. также Float.next_after.

Since 4.08

val abs : float -> float

abs f возвращает абсолютное значение f.

val infinity : float

Положительная бесконечность.

val neg_infinity : float

Отрицательная бесконечность.

val nan : float

Особое значение с плавающей точкой, обозначающее результат неопределённой операции, такой как 0.0 /. 0.0. Обозначает 'не число'. Любая операция с плавающей точкой с nan в качестве аргумента возвращает nan в качестве результата, если не указано иное в стандарте IEEE 754. Что касается сравнений чисел с плавающей точкой, =, <, <=, > и >= возвращают false, а <> возвращает true , если один или оба аргумента являются nan.

nan — quiet_nan начиная с 5.1; раньше это было сигнализирующее NaN.

val signaling_nan : float

Сигнализирующее NaN. Соответствующие сигналы не генерируют исключений OCaml, но значение может быть полезным для взаимодействия с библиотеками C.

Since 5.1

val quiet_nan : float

Тихое NaN.

Since 5.1

val pi : float

Постоянная пи.

val max_float : float

Наибольшее положительное конечное значение типа float.

val min_float : float

Наименьшее положительное, отличное от нуля, не денормализованное значение типа float.

val epsilon : float

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

val is_finite : float -> bool

is_finite x равно true, если и только если x конечно, т. е. не бесконечно и не Float.nan.

Since 4.08

val is_infinite : float -> bool

is_infinite x равно true, если и только если x равно Float.infinity или Float.neg_infinity.

Since 4.08

val is_nan : float -> bool

is_nan x равно true, если и только если x не является числом (см. Float.nan).

Since 4.08

val is_integer : float -> bool

is_integer x равно true, если и только если x является целым числом.

Since 4.08

val of_int : int -> float

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

val to_int : float -> int

Округление заданного числа с плавающей точкой до целого. Результат не определён, если аргумент является nan или выходит за пределы диапазона представимых целых чисел.

val of_string : string -> float

Преобразование заданной строки в число с плавающей точкой. Строка считывается в десятичном формате (по умолчанию) или в шестнадцатеричном (отмечена 0x или 0X). Формат десятичных чисел с плавающей точкой: [-] dd.ddd (e|E) [+|-] dd , где d обозначает десятичную цифру. Формат шестнадцатеричных чисел с плавающей точкой: [-] 0(x|X) hh.hhh (p|P) [+|-] dd , где h обозначает шестнадцатеричную цифру, а d — десятичную цифру. В обоих случаях, по меньшей мере, одна из целой и дробной части должна быть задана; экспоненциальная часть необязательна. Символ _ (подчеркивание) может появляться где угодно в строке и игнорируется. В зависимости от платформы выполнения, могут быть приняты другие представления чисел с плавающей точкой, но на них нельзя полагаться.

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

val of_string_opt : string -> float option

То же, что of_string, но возвращает None вместо повышения исключения.

val to_string : float -> string

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

Это преобразование может привести к потере точности. Для большего контроля над способом печати числа, см. Printf.

Эта функция является псевдонимом для string_of_float.

type fpclass = fpclass =

`\|`	`FP_normal`	`(*`	Нормальное число, ни одно из нижеперечисленных	`*)`
`\|`	`FP_subnormal`	`(*`	Число очень близко к 0.0, точность уменьшена	`*)`
`\|`	`FP_zero`	`(*`	Число равно 0.0 или -0.0	`*)`
`\|`	`FP_infinite`	`(*`	Число равно положительной или отрицательной бесконечности	`*)`
`\|`	`FP_nan`	`(*`	Не число: результат неопределённой операции	`*)`

Пять категорий чисел с плавающей точкой, определённых функцией Float.classify_float.

val classify_float : float -> fpclass

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

val pow : float -> float -> float

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

val sqrt : float -> float

Квадратный корень.

val cbrt : float -> float

Кубический корень.

Since 4.13

val exp : float -> float

Экспонента.

val exp2 : float -> float

Экспоненциальная функция по основанию 2.

Since 4.13

val log : float -> float

Натуральный логарифм.

val log10 : float -> float

Логарифм по основанию 10.

val log2 : float -> float

Логарифм по основанию 2.

Since 4.13

val expm1 : float -> float

expm1 x вычисляет exp x -. 1.0, предоставляя численные результаты, даже если x близко к 0.0.

val log1p : float -> float

log1p x вычисляет log(1.0 +. x) (натуральный логарифм), предоставляя численные результаты, даже если x близко к 0.0.

val cos : float -> float

Косинус. Аргумент в радианах.

val sin : float -> float

Синус. Аргумент в радианах.

val tan : float -> float

Тангенс. Аргумент в радианах.

val acos : float -> float

Арккосинус. Аргумент должен находиться в диапазоне [-1.0, 1.0]. Результат в радианах и находится между 0.0 и pi.

val asin : float -> float

Арксинус. Аргумент должен находиться в диапазоне [-1.0, 1.0]. Результат в радианах и находится между -pi/2 и pi/2.

val atan : float -> float

Арктангенс. Результат в радианах и находится между -pi/2 и pi/2.

val atan2 : float -> float -> float

atan2 y x возвращает арктангенс от y /. x. Знаки x и y используются для определения квадранта результата. Результат в радианах и находится между -pi и pi.

val hypot : float -> float -> float

hypot x y возвращает sqrt(x *. x +. y *. y), то есть длину гипотенузы прямоугольного треугольника со сторонами длиной x и y, или, эквивалентно, расстояние точки (x,y) от начала координат. Если одно из x или y бесконечно, возвращает infinity, даже если другое nan.

val cosh : float -> float

Гиперболический косинус. Аргумент в радианах.

val sinh : float -> float

Гиперболический синус. Аргумент в радианах.

val tanh : float -> float

Гиперболический тангенс. Аргумент в радианах.

val acosh : float -> float

Гиперболический арккосинус. Аргумент должен находиться в диапазоне [1.0, inf]. Результат в радианах и находится между 0.0 и inf.

Since 4.13

val asinh : float -> float

Гиперболический арксинус. Аргумент и результат охватывают всю вещественную прямую. Результат в радианах.

Since 4.13

val atanh : float -> float

Гиперболический арктангенс. Аргумент должен находиться в диапазоне [-1.0, 1.0]. Результат в радианах и охватывает всю вещественную прямую.

Since 4.13

val erf : float -> float

Функция ошибок. Аргумент охватывает всю вещественную прямую. Результат всегда находится в пределах [-1.0, 1.0].

Since 4.13

val erfc : float -> float

Дополнительная функция ошибок (erfc x = 1 - erf x). Аргумент охватывает всю вещественную прямую. Результат всегда находится в пределах [-1.0, 1.0].

Since 4.13

val trunc : float -> float

trunc x округляет x до ближайшего целого, модуль которого меньше или равен x.

Since 4.08

val round : float -> float

round x округляет x до ближайшего целого с округлением в сторону от нуля при равенстве (дробных значениях 0.5), независимо от текущего направления округления. Если x является целым числом, +0., -0., nan, или бесконечным, возвращается само x.

На 64-битных mingw-w64 эта функция может быть эмулирована из-за ошибки в библиотеке времени выполнения C (CRT) на этой платформе.

Since 4.08

val ceil : float -> float

Округление вверх до целого значения. ceil f возвращает наименьшее целое значение, большее или равное f. Результат возвращается как float.

val floor : float -> float

Округление вниз до целого значения. floor f возвращает наибольшее целое значение, меньшее или равное f. Результат возвращается как float.

val next_after : float -> float -> float

next_after x y возвращает следующее представимое число с плавающей точкой после x в направлении y. Более точно, если y больше (соответственно меньше), чем x, возвращается наименьшее (соответственно наибольшее) представимое число, большее (соответственно меньшее), чем x. Если x равно y, функция возвращает y. Если x или y бесконечно, возвращается nan. Обратите внимание, что next_after max_float infinity = infinity, и next_after 0. infinity — наименьшее положительное нормализованное число. Если x — наименьшее положительное нормализованное число, next_after x 0. = 0.

Since 4.08

val copy_sign : float -> float -> float

copy_sign x y возвращает float, модуль которого равен модулю x, а знак — знаку y. Если x равно nan, возвращает nan. Если y равно nan, возвращает либо x, либо -. x, но не указано, какое именно.

val sign_bit : float -> bool

sign_bit x равно true тогда и только тогда, когда бит знака x установлен. Например, sign_bit 1. и signbit 0. равны false, в то время как sign_bit (-1.) и sign_bit (-0.) равны true.

Since 4.08

val frexp : float -> float * int

frexp f возвращает пару мантиссы и порядка f. Когда f равно нулю, мантисса x и порядок n f равны нулю. Когда f не равно нулю, они определяются как f = x *. 2 ** n и 0.5 <= x < 1.0.

val ldexp : float -> int -> float

ldexp x n возвращает x *. 2 ** n.

val modf : float -> float * float

modf f возвращает пару дробной и целой части f.

type t = float

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

val compare : t -> t -> int

compare x y возвращает 0, если x равно y, отрицательное целое число, если x меньше y, и положительное целое число, если x больше y. compare рассматривает nan как равное самому себе и меньше любого другого значения с плавающей точкой. Такое обращение с nan гарантирует, что compare определяет отношение полного порядка.

val equal : t -> t -> bool

Функция равенства для чисел с плавающей точкой, сравниваемых с использованием Float.compare.

val min : t -> t -> t

min x y возвращает минимум из x и y. Она возвращает nan, когда x или y равны nan. Кроме того min (-0.) (+0.) = -0.

Since 4.08

val max : float -> float -> float

max x y возвращает максимум из x и y. Она возвращает nan, когда x или y равны nan. Кроме того max (-0.) (+0.) = +0.

Since 4.08

val min_max : float -> float -> float * float

min_max x y является (min x y, max x y), просто более эффективной.

Since 4.08

val min_num : t -> t -> t

min_num x y возвращает минимум из x и y, рассматривая nan как пропущенные значения. Если оба x и y равны nan, возвращается nan. Кроме того min_num (-0.) (+0.) = -0.

Since 4.08

val max_num : t -> t -> t

max_num x y возвращает максимум из x и y, рассматривая nan как пропущенные значения. Если оба x и y равны nan, возвращается nan. Кроме того max_num (-0.) (+0.) = +0.

Since 4.08

val min_max_num : float -> float -> float * float

min_max_num x y является (min_num x y, max_num x y), просто более эффективной. Обратите внимание, что, в частности, min_max_num x nan = (x, x) и min_max_num nan y = (y, y).

Since 4.08

val seeded_hash : int -> t -> int

Функция хеширования с затравкой для чисел с плавающей точкой, с тем же выходным значением, что и Hashtbl.seeded_hash. Эта функция позволяет передать этот модуль в качестве аргумента к функционалу Hashtbl.MakeSeeded.

Since 5.1

val hash : t -> int

Функция хеширования без затравки для чисел с плавающей точкой, с тем же выходным значением, что и Hashtbl.hash. Эта функция позволяет передать этот модуль в качестве аргумента к функционалу Hashtbl.Make.

module Array: sig .. end

Массивы чисел с плавающей точкой с упакованным представлением.

module ArrayLabels: sig .. end

Массивы чисел с плавающей точкой с упакованным представлением (функции с метками).