Spec-Zone.ru › OCaml

Модуль StdLabels.List

module List: ListLabels
type 'a t = 'a list = 
| []
| (::) of 'a * 'a list

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

val length : 'a list -> int

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

val compare_lengths : 'a list -> 'b list -> int

Сравнение длин двух списков. compare_lengths l1 l2 эквивалентно compare (length l1) (length l2), за исключением того, что вычисление останавливается после достижения конца самого короткого списка.

  • Since 4.05
val compare_length_with : 'a list -> len:int -> int

Сравнение длины списка с целым числом. compare_length_with l len эквивалентно compare (length l) len, за исключением того, что вычисление останавливается после не более len итераций по списку.

  • Since 4.05
val is_empty : 'a list -> bool

is_empty l истинно тогда и только тогда, когда l не содержит элементов. Эквивалентно compare_length_with l 0 = 0.

  • Since 5.1
val cons : 'a -> 'a list -> 'a list

cons x xs является x :: xs

  • Since 4.05
val hd : 'a list -> 'a

Возвращает первый элемент данного списка.

  • Raises Failure если список пуст.
val tl : 'a list -> 'a list

Возвращает данный список без его первого элемента.

  • Raises Failure если список пуст.
val nth : 'a list -> int -> 'a

Возвращает n-й элемент данного списка. Первый элемент (начало списка) имеет позицию 0.

  • Raises
    • Failure если список слишком короткий.
    • Invalid_argument если n отрицательно.
val nth_opt : 'a list -> int -> 'a option

Возвращает n-й элемент данного списка. Первый элемент (начало списка) имеет позицию 0. Возвращает None если список слишком короткий.

  • Since 4.05
  • Raises Invalid_argument если n отрицательно.
val rev : 'a list -> 'a list

Переворачивание списка.

val init : len:int -> f:(int -> 'a) -> 'a list

init ~len ~f равно [f 0; f 1; ...; f (len-1)], вычисляемому слева направо.

  • Since 4.06
  • Raises Invalid_argument если len < 0.
val append : 'a list -> 'a list -> 'a list

append l0 l1 добавляет l1 к l0 . Такая же функция, как у инфиксного оператора @.

  • Since 5.1 эта функция является хвостовой рекурсией.
val rev_append : 'a list -> 'a list -> 'a list

rev_append l1 l2 переворачивает l1 и конкатенирует его с l2. Это эквивалентно (ListLabels.rev l1) @ l2.

val concat : 'a list list -> 'a list

Конкатенация списка списков. Элементы аргумента конкатенируются вместе (в том же порядке) для получения результата. Не хвостовая рекурсия (длина аргумента + длина самого длинного подсписка).

val flatten : 'a list list -> 'a list

То же, что ListLabels.concat. Не хвостовая рекурсия (длина аргумента + длина самого длинного подсписка).

Сравнение

val equal : eq:('a -> 'a -> bool) -> 'a list -> 'a list -> bool

equal eq [a1; ...; an] [b1; ..; bm] выполняется, когда два входных списка имеют одинаковую длину, и для каждой пары элементов ai, bi в той же позиции выполняется eq ai bi.

Примечание: функция eq может быть вызвана даже если списки имеют разную длину. Если вы знаете, что ваша функция равенства дорогостоящая, вы можете сначала проверить ListLabels.compare_lengths.

  • Since 4.12
val compare : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> int

compare cmp [a1; ...; an] [b1; ...; bm] выполняет лексикографическое сравнение двух входных списков, используя тот же интерфейс 'a -> 'a -> int что и compare:

  • a1 :: l1 меньше a2 :: l2 (отрицательный результат), если a1 меньше a2, или если они равны (результат 0) и l1 меньше l2
  • пустой список [] строго меньше, чем непустые списки

Примечание: функция cmp будет вызвана даже если списки имеют разную длину.

  • Since 4.12

Итераторы

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

iter ~f [a1; ...; an] последовательно применяет функцию f к [a1; ...; an] . Эквивалентно f a1; f a2; ...; f an.

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

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

  • Since 4.00
val map : f:('a -> 'b) -> 'a list -> 'b list

map ~f [a1; ...; an] применяет функцию f к a1, ..., an, и строит список [f a1; ...; f an] с результатами, возвращаемыми f.

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

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

  • Since 4.00
val rev_map : f:('a -> 'b) -> 'a list -> 'b list

rev_map ~f l даёт тот же результат, что и ListLabels.rev (ListLabels.map f l), но более эффективно.

val filter_map : f:('a -> 'b option) -> 'a list -> 'b list

filter_map ~f l применяет f к каждому элементу l, отфильтровывает None элементы и возвращает список аргументов Some элементов.

  • Since 4.08
val concat_map : f:('a -> 'b list) -> 'a list -> 'b list

concat_map ~f l даёт тот же результат, что и ListLabels.concat (ListLabels.map f l). Хвостовая рекурсия.

  • Since 4.10
val fold_left_map : f:('acc -> 'a -> 'acc * 'b) -> init:'acc -> 'a list -> 'acc * 'b list

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

  • Since 4.11
val fold_left : f:('acc -> 'a -> 'acc) -> init:'acc -> 'a list -> 'acc

fold_left ~f ~init [b1; ...; bn] — это f (... (f (f init b1) b2) ...) bn.

val fold_right : f:('a -> 'acc -> 'acc) -> 'a list -> init:'acc -> 'acc

fold_right ~f [a1; ...; an] ~init — это f a1 (f a2 (... (f an init) ...)). Не хвостовая рекурсия.

Итераторы на двух списках

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

iter2 ~f [a1; ...; an] [b1; ...; bn] последовательно вызывает f a1 b1; ...; f an bn.

  • Raises Invalid_argument если два списка имеют разную длину.
val map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list

map2 ~f [a1; ...; an] [b1; ...; bn] — это [f a1 b1; ...; f an bn].

  • Raises Invalid_argument если два списка имеют разную длину.
val rev_map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list

rev_map2 ~f l1 l2 даёт тот же результат, что и ListLabels.rev (ListLabels.map2 f l1 l2), но более эффективно.

val fold_left2 : f:('acc -> 'a -> 'b -> 'acc) -> init:'acc -> 'a list -> 'b list -> 'acc

fold_left2 ~f ~init [a1; ...; an] [b1; ...; bn] — это f (... (f (f init a1 b1) a2 b2) ...) an bn.

  • Raises Invalid_argument если два списка имеют разную длину.
val fold_right2 : f:('a -> 'b -> 'acc -> 'acc) -> 'a list -> 'b list -> init:'acc -> 'acc

fold_right2 ~f [a1; ...; an] [b1; ...; bn] ~init — это f a1 b1 (f a2 b2 (... (f an bn init) ...)).

  • Raises Invalid_argument если два списка имеют разную длину. Не хвостовая рекурсия.

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

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

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

val exists : f:('a -> bool) -> 'a list -> bool

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

val for_all2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> bool

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

  • Raises Invalid_argument если определяется, что длины двух списков отличаются.
val exists2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> bool

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

  • Raises Invalid_argument если определяется, что длины двух списков отличаются.
val mem : 'a -> set:'a list -> bool

mem a ~set истинно тогда и только тогда, когда a равно элементу set.

val memq : 'a -> set:'a list -> bool

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

Поиск в списке

val find : f:('a -> bool) -> 'a list -> 'a

find ~f l возвращает первый элемент списка l, который удовлетворяет предикату f.

  • Raises Not_found если в списке l нет значения, удовлетворяющего f.
val find_opt : f:('a -> bool) -> 'a list -> 'a option

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

  • Since 4.05
val find_index : f:('a -> bool) -> 'a list -> int option

find_index ~f xs возвращает Some i, где i — индекс первого элемента списка xs, который удовлетворяет f x, если такой элемент существует.

Возвращает None если такого элемента нет.

  • Since 5.1
val find_map : f:('a -> 'b option) -> 'a list -> 'b option

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

  • Since 4.10
val find_mapi : f:(int -> 'a -> 'b option) -> 'a list -> 'b option

То же, что и find_map, но предикат применяется к индексу элемента (считая с 0) в качестве первого аргумента, а к самому элементу — в качестве второго.

  • Since 5.1
val filter : f:('a -> bool) -> 'a list -> 'a list

filter ~f l возвращает все элементы списка l, которые удовлетворяют предикату f. Порядок элементов входного списка сохраняется.

val find_all : f:('a -> bool) -> 'a list -> 'a list

find_all — другое имя для ListLabels.filter.

val filteri : f:(int -> 'a -> bool) -> 'a list -> 'a list

То же, что и ListLabels.filter, но предикат применяется к индексу элемента (считая с 0) в качестве первого аргумента, а к самому элементу — в качестве второго.

  • Since 4.11
val partition : f:('a -> bool) -> 'a list -> 'a list * 'a list

partition ~f l возвращает пару списков (l1, l2), где l1 — список всех элементов l, удовлетворяющих предикату f, а l2 — список всех элементов l, которые не удовлетворяют предикату f. Порядок элементов в входном списке сохраняется.

val partition_map : f:('a -> ('b, 'c) Either.t) -> 'a list -> 'b list * 'c list

partition_map f l возвращает пару списков (l1, l2), таких что для каждого элемента x входного списка l:

  • если f x является Left y1, то y1 находится в l1, и
  • если f x является Right y2, то y2 находится в l2.

Элементы вывода включены в l1 и l2 в том же относительном порядке, что и соответствующие элементы входного списка l.

В частности, partition_map (fun x -> if f x then Left x else Right x) l эквивалентно partition f l.

  • Since 4.12

Списки ассоциаций

val assoc : 'a -> ('a * 'b) list -> 'b

assoc a l возвращает значение, связанное с ключом a в списке пар l. То есть assoc a [ ...; (a,b); ...] = b если (a,b) — левое крайнее связывание a в списке l.

  • Raises Not_found если в списке l нет значения, связанного с a.
val assoc_opt : 'a -> ('a * 'b) list -> 'b option

assoc_opt a l возвращает значение, связанное с ключом a в списке пар l. То есть assoc_opt a [ ...; (a,b); ...] = Some b если (a,b) — левое крайнее связывание a в списке l. Возвращает None если в списке l нет значения, связанного с a.

  • Since 4.05
val assq : 'a -> ('a * 'b) list -> 'b

То же, что и ListLabels.assoc, но для сравнения ключей используется физическое равенство вместо структурного равенства.

val assq_opt : 'a -> ('a * 'b) list -> 'b option

То же, что и ListLabels.assoc_opt, но для сравнения ключей используется физическое равенство вместо структурного равенства.

  • Since 4.05
val mem_assoc : 'a -> map:('a * 'b) list -> bool

То же, что и ListLabels.assoc, но просто возвращает true если связывание существует, и false если связываний для данного ключа нет.

val mem_assq : 'a -> map:('a * 'b) list -> bool

То же, что и ListLabels.mem_assoc, но для сравнения ключей используется физическое равенство вместо структурного равенства.

val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) list

remove_assoc a l возвращает список пар l без первой пары с ключом a, если таковая имеется. Не рекурсивно по хвосту.

val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) list

То же, что и ListLabels.remove_assoc, но для сравнения ключей используется физическое равенство вместо структурного равенства. Не рекурсивно по хвосту.

Списки пар

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

Преобразование списка пар в пару списков: split [(a1,b1); ...; (an,bn)] это ([a1; ...; an], [b1; ...; bn]). Не рекурсивно по хвосту.

val combine : 'a list -> 'b list -> ('a * 'b) list

Преобразование пары списков в список пар: combine [a1; ...; an] [b1; ...; bn] это [(a1,b1); ...; (an,bn)].

  • Raises Invalid_argument если длины двух списков различны. Не рекурсивно по хвосту.

Сортировка

val sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list

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

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

val stable_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list

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

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

val fast_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list

То же, что и ListLabels.sort или ListLabels.stable_sort, что быстрее на типичных входных данных.

val sort_uniq : cmp:('a -> 'a -> int) -> 'a list -> 'a list

То же, что и ListLabels.sort, но также удаляются дубликаты.

  • Since 4.03
val merge : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> 'a list

Объединение двух списков: Предполагая, что l1 и l2 отсортированы по функции сравнения cmp, merge ~cmp l1 l2 вернёт отсортированный список, содержащий все элементы l1 и l2. Если несколько элементов равны, элементы l1 будут перед элементами l2.

Списки и последовательности

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

Итерация по списку.

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

Создание списка из последовательности.

  • Since 4.07

© 1995-2024 INRIA.
https://ocaml.org/manual/5.2/api/StdLabels.List.html

Spec-Zone.ru

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