Spec-Zone.ru › OCaml

Модуль Either

module Either: sig .. end

Тип Either.

Either — это самый простой и самый общий тип суммы/варианта: значение типа ('a, 'b) Either.t является либо Left (v : 'a), либо Right (v : 'b).

Это естественный выбор в API универсальных функций, где значения могут принадлежать двум различным случаям, возможно, разных типов, без присвоения конкретного значения каждому случаю.

Например:

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

Если вы ищете параметризованный тип, где один вариант означает успех, а другой — неудачу, вы должны использовать более специфичный тип Result.t.

  • Since 4.12
type ('a, 'b) t = 
| Left of 'a
| Right of 'b

Значение типа ('a, 'b) Either.t содержит либо значение типа 'a, либо значение типа 'b

val left : 'a -> ('a, 'b) t

left v является Left v.

val right : 'b -> ('a, 'b) t

right v является Right v.

val is_left : ('a, 'b) t -> bool

is_left (Left v) является true, is_left (Right v) является false.

val is_right : ('a, 'b) t -> bool

is_right (Left v) является false, is_right (Right v) является true.

val find_left : ('a, 'b) t -> 'a option

find_left (Left v) является Some v, find_left (Right _) является None

val find_right : ('a, 'b) t -> 'b option

find_right (Right v) является Some v, find_right (Left _) является None

val map_left : ('a1 -> 'a2) -> ('a1, 'b) t -> ('a2, 'b) t

map_left f e является Left (f v) если e является Left v и e если e является Right _.

val map_right : ('b1 -> 'b2) -> ('a, 'b1) t -> ('a, 'b2) t

map_right f e является Right (f v) если e является Right v и e если e является Left _.

val map : left:('a1 -> 'a2) ->       right:('b1 -> 'b2) -> ('a1, 'b1) t -> ('a2, 'b2) t

map ~left ~right (Left v) является Left (left v), map ~left ~right (Right v) является Right (right v).

val fold : left:('a -> 'c) -> right:('b -> 'c) -> ('a, 'b) t -> 'c

fold ~left ~right (Left v) является left v, и fold ~left ~right (Right v) является right v.

val iter : left:('a -> unit) -> right:('b -> unit) -> ('a, 'b) t -> unit

iter ~left ~right (Left v) является left v, и iter ~left ~right (Right v) является right v.

val for_all : left:('a -> bool) -> right:('b -> bool) -> ('a, 'b) t -> bool

for_all ~left ~right (Left v) является left v, и for_all ~left ~right (Right v) является right v.

val equal : left:('a -> 'a -> bool) ->       right:('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool

equal ~left ~right e0 e1 проверяет равенство e0 и e1 с использованием left и right для сравнения значений, заключенных в Left _ и Right _ соответственно.

val compare : left:('a -> 'a -> int) ->       right:('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int

compare ~left ~right e0 e1 полностью упорядочивает e0 и e1 с использованием left и right для сравнения значений, заключённых в Left _  и Right _ соответственно. Значения Left _ меньше значений Right _.

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

Spec-Zone.ru

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