Spec-Zone.ru › OCaml 4.14

Модуль ArrayLabels

module ArrayLabels: sig .. end

Операции с массивами.

Отмеченная версия этого модуля может использоваться так, как описано в модуле StdLabels.

type 'a t = 'a array 

Псевдоним для типа массивов.

val length : 'a array -> int

Возвращает длину (количество элементов) заданного массива.

val get : 'a array -> int -> 'a

get a n возвращает элемент с номером n массива a. Первый элемент имеет номер 0. Последний элемент имеет номер length a - 1. Вы также можете использовать a.(n) вместо get a n.

  • Возбуждает Invalid_argument если n находится вне диапазона от 0 до (length a - 1).
val set : 'a array -> int -> 'a -> unit

set a n x изменяет массив a на месте, заменяя элемент с номером n на x. Вы также можете использовать a.(n) <- x вместо set a n x.

  • Возбуждает Invalid_argument если n находится вне диапазона от 0 до length a - 1.
val make : int -> 'a -> 'a array

make n x возвращает новый массив длины n, инициализированный значением x. Все элементы этого нового массива изначально физически равны x (в смысле предиката ==). Следовательно, если x изменяемый, он используется совместно всеми элементами массива, и изменение x через одну из записей массива изменит все другие записи одновременно.

  • Возбуждает Invalid_argument если n < 0 или n > Sys.max_array_length. Если значение x — число с плавающей точкой, максимальный размер составляет только Sys.max_array_length / 2.
val create : int -> 'a -> 'a array
Устаревшее. create — псевдоним для ArrayLabels.make.
val create_float : int -> float array

create_float n возвращает новый массив чисел с плавающей точкой длины n, с неинициализированными данными.

  • С тех пор как 4.03
val make_float : int -> float array
Устаревшее. make_float — псевдоним для ArrayLabels.create_float.
val init : int -> f:(int -> 'a) -> 'a array

init n ~f возвращает новый массив длины n, с элементом под номером i инициализированным результатом f i. Другими словами, init n ~f табулирует результаты f, применённые к целым числам от 0 до n-1.

  • Возбуждает Invalid_argument если n < 0 или n > Sys.max_array_length. Если возвращаемый тип f — float, максимальный размер составляет только Sys.max_array_length / 2.
val make_matrix : dimx:int -> dimy:int -> 'a -> 'a array array

make_matrix ~dimx ~dimy e возвращает двумерный массив (массив массивов) с первой размерностью dimx и второй размерностью dimy. Все элементы этой новой матрицы изначально физически равны e. Элемент (x,y) матрицы m доступен с помощью обозначения m.(x).(y).

  • Возбуждает Invalid_argument если dimx или dimy отрицательные или больше, чем Sys.max_array_length. Если значение e — число с плавающей точкой, максимальный размер составляет только Sys.max_array_length / 2.
val create_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
Устаревшее. create_matrix — псевдоним для ArrayLabels.make_matrix.
val append : 'a array -> 'a array -> 'a array

append v1 v2 возвращает новый массив, содержащий конкатенацию массивов v1 и v2.

  • Возбуждает Invalid_argument если length v1 + length v2 > Sys.max_array_length.
val concat : 'a array list -> 'a array

То же, что ArrayLabels.append, но конкатенирует список массивов.

val sub : 'a array -> pos:int -> len:int -> 'a array

sub a ~pos ~len возвращает новый массив длины len, содержащий элементы с номерами от pos до pos + len - 1 массива a.

  • Возбуждает Invalid_argument если pos и len не обозначают допустимый подмассив a; то есть, если pos < 0, или len < 0, или pos + len > length a.
val copy : 'a array -> 'a array

copy a возвращает копию a, то есть новый массив, содержащий те же элементы, что и a.

val fill : 'a array -> pos:int -> len:int -> 'a -> unit

fill a ~pos ~len x изменяет массив a на месте, сохраняя x в элементах с номерами от pos до pos + len - 1.

  • Возбуждает Invalid_argument если pos и len не обозначают допустимый подмассив a.
val blit : src:'a array -> src_pos:int -> dst:'a array -> dst_pos:int -> len:int -> unit

blit ~src ~src_pos ~dst ~dst_pos ~len копирует len элементов из массива src, начиная с элемента под номером src_pos, в массив dst, начиная с элемента под номером dst_pos. Он работает корректно, даже если src и dst — один и тот же массив, и исходный и целевой фрагменты перекрываются.

  • Возбуждает Invalid_argument если src_pos и len не обозначают допустимый подмассив src, или если dst_pos и len не обозначают допустимый подмассив dst.
val to_list : 'a array -> 'a list

to_list a возвращает список всех элементов a.

val of_list : 'a list -> 'a array

of_list l возвращает новый массив, содержащий элементы l.

  • Возбуждает Invalid_argument если длина l больше Sys.max_array_length.

Итераторы

val iter : f:('a -> unit) -> 'a array -> unit

iter ~f a применяет функцию f по очереди ко всем элементам a. Это эквивалентно f a.(0); f a.(1); ...; f a.(length a - 1); ().

val iteri : f:(int -> 'a -> unit) -> 'a array -> unit

То же, что ArrayLabels.iter, но функция применяется к индексу элемента как первому аргументу, а сам элемент — как второй аргумент.

val map : f:('a -> 'b) -> 'a array -> 'b array

map ~f a применяет функцию f ко всем элементам a, и строит массив с результатами, возвращенными f: [| f a.(0); f a.(1); ...; f a.(length a - 1) |].

val mapi : f:(int -> 'a -> 'b) -> 'a array -> 'b array

То же, что ArrayLabels.map, но функция применяется к индексу элемента как первому аргументу, а сам элемент — как второй аргумент.

val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b array -> 'a

fold_left ~f ~init a вычисляет f (... (f (f init a.(0)) a.(1)) ...) a.(n-1), где n — длина массива a.

val fold_left_map : f:('a -> 'b -> 'a * 'c) -> init:'a -> 'b array -> 'a * 'c array

fold_left_map — комбинация ArrayLabels.fold_left и ArrayLabels.map, которая протаскивает аккумулятора через вызовы f.

  • С тех пор как 4.13.0
val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'a

fold_right ~f a ~init вычисляет f a.(0) (f a.(1) ( ... (f a.(n-1) init) ...)), где n — длина массива a.

Итераторы по двум массивам

val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unit

iter2 ~f a b применяет функцию f ко всем элементам a и b.

  • С тех пор как 4.05.0
  • Возбуждает Invalid_argument если массивы имеют разный размер.
val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array

map2 ~f a b применяет функцию f ко всем элементам a и b, и строит массив с результатами, возвращенными f: [| f a.(0) b.(0); ...; f a.(length a - 1) b.(length b - 1)|].

  • С тех пор как 4.05.0
  • Возбуждает Invalid_argument если массивы имеют разный размер.

Сканирование массивов

val for_all : f:('a -> bool) -> 'a array -> bool

for_all ~f [|a1; ...; an|] проверяет, удовлетворяют ли все элементы массива предикату f. То есть, он возвращает (f a1) && (f a2) && ... && (f an).

  • С тех пор как 4.03.0
val exists : f:('a -> bool) -> 'a array -> bool

exists ~f [|a1; ...; an|] проверяет, удовлетворяет ли хотя бы один элемент массива предикату f. То есть, он возвращает (f a1) || (f a2) || ... || (f an).

  • Since 4.03.0
val for_all2 : f:('a -> 'b -> bool) -> 'a array -> 'b array -> bool

То же, что и ArrayLabels.for_all, но для предиката с двумя аргументами.

  • Since 4.11.0
  • Raises Invalid_argument если длины двух массивов различны.
val exists2 : f:('a -> 'b -> bool) -> 'a array -> 'b array -> bool

То же, что и ArrayLabels.exists, но для предиката с двумя аргументами.

  • Since 4.11.0
  • Raises Invalid_argument если длины двух массивов различны.
val mem : 'a -> set:'a array -> bool

mem a ~set истинно тогда и только тогда, когда a структурно равен элементу l (т.е. существует элемент x в l, такой что compare a x = 0).

  • Since 4.03.0
val memq : 'a -> set:'a array -> bool

То же, что и ArrayLabels.mem, но использует физическое равенство для сравнения элементов списка вместо структурного равенства.

  • Since 4.03.0
val find_opt : f:('a -> bool) -> 'a array -> 'a option

find_opt ~f a возвращает первый элемент массива a, который удовлетворяет предикату f, или None если нет значения, удовлетворяющего f в массиве a.

  • Since 4.13.0
val find_map : f:('a -> 'b option) -> 'a array -> 'b option

find_map ~f a применяет f к элементам a в порядке следования и возвращает первый результат вида Some v, или None если таковых нет.

  • Since 4.13.0

Массивы пар

val split : ('a * 'b) array -> 'a array * 'b array

split [|(a1,b1); ...; (an,bn)|] является ([|a1; ...; an|], [|b1; ...; bn|]).

  • Since 4.13.0
val combine : 'a array -> 'b array -> ('a * 'b) array

combine [|a1; ...; an|] [|b1; ...; bn|] является [|(a1,b1); ...; (an,bn)|]. Поднимает Invalid_argument если длины двух массивов различны.

  • Since 4.13.0

Сортировка

val sort : cmp:('a -> 'a -> int) -> 'a array -> unit

Сортирует массив в порядке возрастания согласно функции сравнения. Функция сравнения должна возвращать 0, если её аргументы равны, положительное целое число, если первый больше, и отрицательное целое число, если первый меньше (полная спецификация приведена ниже). Например, compare — подходящая функция сравнения. После вызова sort, массив сортируется на месте в порядке возрастания. sort гарантируется, что будет выполняться с постоянным объёмом памяти и (максимально) логарифмическим объёмом стека.

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

Спецификация функции сравнения: Пусть a — массив, а cmp — функция сравнения. Следующее должно выполняться для всех x, y, z в a:

  • cmp x y > 0 тогда и только тогда, когда cmp y x < 0
  • если cmp x y >= 0 и cmp y z >= 0, то cmp x z >= 0

По завершении sort a содержит те же элементы, что и ранее, но переупорядоченные таким образом, что для всех i и j, являющихся допустимыми индексами a:

  • cmp a.(i) a.(j) >= 0 тогда и только тогда, когда i >= j
val stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unit

То же, что и ArrayLabels.sort, но алгоритм сортировки устойчивый (т.е. элементы, которые сравниваются как равные, сохраняются в исходном порядке) и не гарантирует работу с постоянным объемом памяти.

Текущая реализация использует сортировку слиянием. Она использует временный массив длиной n/2, где n — длина массива. Обычно она быстрее, чем текущая реализация ArrayLabels.sort.

val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit

То же, что и ArrayLabels.sort или ArrayLabels.stable_sort, какой из них быстрее на типичном вводе.

Массивы и последовательности

val to_seq : 'a array -> 'a Seq.t

Итерировать по массиву в порядке возрастания. Изменения массива во время итерации будут отражены в последовательности.

  • Since 4.07
val to_seqi : 'a array -> (int * 'a) Seq.t

Итерировать по массиву в порядке возрастания, выводить индексы вместе с элементами. Изменения массива во время итерации будут отражены в последовательности.

  • Since 4.07
val of_seq : 'a Seq.t -> 'a array

Создать массив из генератора

  • Since 4.07

© 1995-2022 INRIA.
https://v2.ocaml.org/releases/4.14/htmlman/libref/ArrayLabels.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API