Spec-Zone.ru › OCaml

Functor MoreLabels.Set.Make

module Make: functor (Ord : OrderedType) -> S 
    with type elt = Ord.t
     and type t = Set.Make(Ord).t

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

Параметры:
Ord : OrderedType

Множества

type elt 

Тип элементов множества.

type t 

Тип множеств.

val empty : t

Пустое множество.

val add : elt -> t -> t

add x s возвращает множество, содержащее все элементы s, плюс x. Если x уже содержится в s, то s возвращается без изменений (результат функции тогда физически равен s).

  • До версии 4.03 Физическое равенство не гарантировалось.
val singleton : elt -> t

singleton x возвращает одноэлементное множество, содержащее только x.

val remove : elt -> t -> t

remove x s возвращает множество, содержащее все элементы s, за исключением x. Если x не содержится в s, то s возвращается без изменений (результат функции тогда физически равен s).

  • До версии 4.03 Физическое равенство не гарантировалось.
val union : t -> t -> t

Объединение множеств.

val inter : t -> t -> t

Пересечение множеств.

val disjoint : t -> t -> bool

Проверка, являются ли два множества непересекающимися.

  • С версии 4.08
val diff : t -> t -> t

Разность множеств: diff s1 s2 содержит элементы s1, которые не содержатся в s2.

val cardinal : t -> int

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

Элементы

val elements : t -> elt list

Возвращает список всех элементов данного множества. Возвращённый список отсортирован в порядке возрастания относительно порядка Ord.compare, где Ord - аргумент, переданный в MoreLabels.Set.Make.

val min_elt : t -> elt

Возвращает наименьший элемент данного множества (относительно порядка Ord.compare), или генерирует исключение Not_found, если множество пусто.

val min_elt_opt : t -> elt option

Возвращает наименьший элемент данного множества (относительно порядка Ord.compare), или None, если множество пусто.

  • С версии 4.05
val max_elt : t -> elt

То же, что и MoreLabels.Set.S.min_elt, но возвращает наибольший элемент данного множества.

val max_elt_opt : t -> elt option

То же, что и MoreLabels.Set.S.min_elt_opt, но возвращает наибольший элемент данного множества.

  • С версии 4.05
val choose : t -> elt

Возвращает один элемент данного множества, или генерирует исключение Not_found, если множество пусто. Какой элемент выбирается, не определено, но одинаковые элементы будут выбираться для одинаковых множеств.

val choose_opt : t -> elt option

Возвращает один элемент данного множества, или None, если множество пусто. Какой элемент выбирается, не определено, но одинаковые элементы будут выбираться для одинаковых множеств.

  • С версии 4.05

Поиск

val find : elt -> t -> elt

find x s возвращает элемент s, равный x (согласно Ord.compare ), или генерирует исключение Not_found, если такой элемент не существует.

  • С версии 4.01
val find_opt : elt -> t -> elt option

find_opt x s возвращает элемент s, равный x (согласно Ord.compare ), или None, если такой элемент не существует.

  • С версии 4.05
val find_first : f:(elt -> bool) ->       t -> elt

find_first ~f s, где f - монотонно возрастающая функция, возвращает наименьший элемент e множества s, такой что f e, или генерирует исключение Not_found, если такого элемента нет.

Например, find_first (fun e -> Ord.compare e x >= 0) s вернет первый элемент e множества s, для которого Ord.compare e x >= 0 (интуитивно: e >= x ), или генерирует исключение Not_found, если x больше любого элемента множества s.

  • С версии 4.05
val find_first_opt : f:(elt -> bool) ->       t -> elt option

find_first_opt ~f s, где f - монотонно возрастающая функция, возвращает опцию, содержащую наименьший элемент e множества s такой, что f e, или None если такого элемента нет.

  • С версии 4.05
val find_last : f:(elt -> bool) ->       t -> elt

find_last ~f s, где f - монотонно убывающая функция, возвращает наибольший элемент e множества s такой, что f e, или генерирует исключение Not_found, если такого элемента нет.

  • С версии 4.05
val find_last_opt : f:(elt -> bool) ->       t -> elt option

find_last_opt ~f s, где f - монотонно убывающая функция, возвращает опцию, содержащую наибольший элемент e множества s такой, что f e, или None если такого элемента нет.

  • С версии 4.05

Перебор

val iter : f:(elt -> unit) -> t -> unit

iter ~f s применяет f поочерёдно ко всем элементам s Элементы s передаются f в порядке возрастания относительно порядка над типом элементов.

val fold : f:(elt -> 'acc -> 'acc) ->       t -> init:'acc -> 'acc

fold ~f s init вычисляет (f xN ... (f x2 (f x1 init))...), где x1 ... xN - элементы множества s в порядке возрастания.

Преобразование

val map : f:(elt -> elt) ->       t -> t

map ~f s - множество, элементы которого f a0, f a1,... f
          aN
, где a0, a1,... aN - элементы множества s.

Элементы передаются f в порядке возрастания относительно порядка над типом элементов.

Если ни один элемент s не изменяется функцией f, возвращается s без изменений. (Если каждый результат f физически равен его входному значению, то возвращаемое множество физически равно s.)

  • С версии 4.04
val filter : f:(elt -> bool) -> t -> t

filter ~f s возвращает множество всех элементов из s , которые удовлетворяют предикату f. Если f удовлетворяет каждому элементу в s, то возвращается s без изменений (результат функции тогда физически равен s).

  • До версии 4.03 Физическое равенство не гарантировалось.
val filter_map : f:(elt -> elt option) ->       t -> t

filter_map ~f s возвращает множество всех v, таких что f x = Some v для некоторого элемента x множества s.

Например,

filter_map (fun n -> if n mod 2 = 0 then Some (n / 2) else None) s

является множеством половин чётных элементов s.

Если ни один элемент s не изменяется или не отбрасывается функцией f (если f x = Some x для каждого элемента x ), то возвращается s без изменений: результат функции тогда физически равен s.

  • С версии 4.11
val partition : f:(elt -> bool) ->       t -> t * t

partition ~f s возвращает пару множеств (s1, s2), где s1 - множество всех элементов s , удовлетворяющих предикату f, и s2 - множество всех элементов s , не удовлетворяющих f.

val split : elt ->       t -> t * bool * t

split x s возвращает тройку (l, present, r), где l - множество элементов s , строго меньших x; r - множество элементов s , строго больших x; present - false, если s не содержит элемента, равного x, или true, если s содержит элемент, равный x.

Предикаты и сравнения

val is_empty : t -> bool

Проверить, пусто ли множество или нет.

val mem : elt -> t -> bool

mem x s проверяет, принадлежит ли x множеству s.

val equal : t -> t -> bool

equal s1 s2 проверяет, равны ли множества s1 и s2, то есть содержат ли они равные элементы.

val compare : t -> t -> int

Полный порядок между множествами. Может использоваться в качестве функции упорядочения для множеств множеств.

val subset : t -> t -> bool

subset s1 s2 проверяет, является ли множество s1 подмножеством множества s2.

val for_all : f:(elt -> bool) -> t -> bool

for_all ~f s проверяет, удовлетворяют ли все элементы множества предикату f.

val exists : f:(elt -> bool) -> t -> bool

exists ~f s проверяет, удовлетворяет ли хотя бы один элемент множества предикату f.

Преобразование

val to_list : t -> elt list

to_list s является MoreLabels.Set.S.elements s.

  • Since 5.1
val of_list : elt list -> t

of_list l создает множество из списка элементов. Обычно это более эффективно, чем применение add к списку, за исключением, возможно, списков с множеством дублированных элементов.

  • Since 4.02
val to_seq_from : elt ->       t -> elt Seq.t

to_seq_from x s итерирует по подмножеству элементов s в порядке возрастания, начиная с x или выше.

  • Since 4.07
val to_seq : t -> elt Seq.t

Итерировать по всему множеству в порядке возрастания

  • Since 4.07
val to_rev_seq : t -> elt Seq.t

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

  • Since 4.12
val add_seq : elt Seq.t -> t -> t

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

  • Since 4.07
val of_seq : elt Seq.t -> t

Создать множество из заданных связей

  • Since 4.07

© 1995-2024 INRIA.
https://ocaml.org/manual/5.2/api/MoreLabels.Set.Make.html

Spec-Zone.ru

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