package bwd

  1. Overview
  2. Docs
package bwd
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module is similar to List but for backward lists.

Notes on the discrepancies with List:

  • Functions rev, rev_append, rev_map, and rev_map2 will never be included.
  • A new function prepend was added as the forward version of append.
  • A new module Notation was added for the infix notation.
  • Functions for association lists are currently missing, but might be added later.
  • Functions init, tl (as hd for lists), hd (as tl for lists), merge, to_seq, and of_seq are also missing, but might be added in the future.

Please open a GitHub issue if you want a function to be included. We want to make this library useful to you, too!

type 'a t = 'a bwd =
  1. | Emp
  2. | Snoc of 'a bwd * 'a
val length : 'a bwd -> int
val compare_lengths : 'a bwd -> 'a bwd -> int
val compare_length_with : 'a bwd -> int -> int
val snoc : 'a bwd -> 'a -> 'a bwd
val nth : 'a bwd -> int -> 'a
val nth_opt : 'a bwd -> int -> 'a option
val append : 'a bwd -> 'a list -> 'a bwd
val prepend : 'a bwd -> 'a list -> 'a list

Comparison

val equal : ('a -> 'a -> bool) -> 'a bwd -> 'a bwd -> bool
val compare : ('a -> 'a -> int) -> 'a bwd -> 'a bwd -> int

Iterators

Note that the iteration direction is from the right to the left, in the opposite direction of the corresponding functions in List.

val iter : ('a -> unit) -> 'a bwd -> unit
val iteri : (int -> 'a -> unit) -> 'a bwd -> unit
val map : ('a -> 'b) -> 'a bwd -> 'b bwd
val mapi : (int -> 'a -> 'b) -> 'a bwd -> 'b bwd
val filter_map : ('a -> 'b option) -> 'a bwd -> 'b bwd
val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b bwd -> 'a
val fold_right_map : ('a -> 'b -> 'b * 'c) -> 'a bwd -> 'b -> 'b * 'c bwd
val fold_right : ('a -> 'b -> 'b) -> 'a bwd -> 'b -> 'b

Iterators on two lists

Note that the iteration direction is from the right to the left, in the opposite direction of the corresponding functions in List.

val iter2 : ('a -> 'b -> unit) -> 'a bwd -> 'b bwd -> unit
val map2 : ('a -> 'b -> 'c) -> 'a bwd -> 'b bwd -> 'c bwd
val fold_left2 : ('a -> 'b -> 'c -> 'a) -> 'a -> 'b bwd -> 'c bwd -> 'a
val fold_right2 : ('a -> 'b -> 'c -> 'c) -> 'a bwd -> 'b bwd -> 'c -> 'c

List scanning

Note that the iteration direction is from the right to the left, in the opposite direction of the corresponding functions in List.

val for_all : ('a -> bool) -> 'a bwd -> bool
val exists : ('a -> bool) -> 'a bwd -> bool
val for_all2 : ('a -> 'b -> bool) -> 'a bwd -> 'b bwd -> bool
val exists2 : ('a -> 'b -> bool) -> 'a bwd -> 'b bwd -> bool
val mem : 'a -> 'a bwd -> bool
val memq : 'a -> 'a bwd -> bool

List searching

Note that the iteration direction is from the right to the left, in the opposite direction of the corresponding functions in List.

val find : ('a -> bool) -> 'a bwd -> 'a
val find_opt : ('a -> bool) -> 'a bwd -> 'a option
val find_map : ('a -> 'b option) -> 'a bwd -> 'b option
val filter : ('a -> bool) -> 'a bwd -> 'a bwd
val find_all : ('a -> bool) -> 'a bwd -> 'a bwd
val filteri : (int -> 'a -> bool) -> 'a bwd -> 'a bwd
val partition : ('a -> bool) -> 'a bwd -> 'a bwd * 'a bwd
val partition_map : ('a -> ('b, 'c) Stdlib.Either.t) -> 'a bwd -> 'b bwd * 'c bwd

Lists of pairs

val split : ('a * 'b) bwd -> 'a bwd * 'b bwd
val combine : 'a bwd -> 'b bwd -> ('a * 'b) bwd

Backward and forward lists

val to_list : 'a bwd -> 'a list
val of_list : 'a list -> 'a bwd

Infix notation

module Infix : sig ... end

Notation inspired by Conor McBride.