package bignum

  1. Overview
  2. Docs
Core-flavoured wrapper around zarith's arbitrary-precision rationals

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=7acc936acbaaf71b2c1518e09b7651bec20d8dc72a990c871c40a74b63b1a8ed

doc/bignum.bigint/Bigint/Set/index.html

Module Bigint.SetSource

Sourcemodule Elt : sig ... end
Sourcemodule Diff : sig ... end
include Core.Set_intf.S with module Elt := Elt and module Diff := Diff
include Core.Set_intf.S_plain with module Elt := Elt and module Diff := Diff
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Ppx_compare_lib.Equal.S with type t := t
Sourceval equal : t -> t -> bool
include Diffable.S_plain with type t := t and module Diff := Diff
include Core.Set_intf.Creators_generic with type ('a, 'b) set := ('a, 'b) Base.Set.t with type ('a, 'b) t := t with type ('a, 'b) tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type 'a elt := Elt.t with type 'c cmp := Elt.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Base.Set.Without_comparator.t
include Base.Set.Creators_generic with type ('a, 'b) set := ('a, 'b) Base.Set.t with type ('a, 'b) t := t with type ('a, 'b) tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type 'a elt := Elt.t with type 'c cmp := Elt.comparator_witness with type ('a, 'b, 'c) create_options := ('a, 'b, 'c) Base.Set.Without_comparator.t
Sourceval empty : ('a, 'cmp, t) Base.Set.Without_comparator.t
Sourceval singleton : ('a, 'cmp, Elt.t -> t) Base.Set.Without_comparator.t
Sourceval union_list : ('a, 'cmp, t list -> t) Base.Set.Without_comparator.t
Sourceval of_list : ('a, 'cmp, Elt.t list -> t) Base.Set.Without_comparator.t
Sourceval of_array : ('a, 'cmp, Elt.t array -> t) Base.Set.Without_comparator.t
Sourceval of_sorted_array : ('a, 'cmp, Elt.t array -> t Base.Or_error.t) Base.Set.Without_comparator.t
Sourceval of_sorted_array_unchecked : ('a, 'cmp, Elt.t array -> t) Base.Set.Without_comparator.t
Sourceval of_increasing_iterator_unchecked : ('a, 'cmp, len:int -> f:(int -> Elt.t) -> t) Base.Set.Without_comparator.t
Sourceval stable_dedup_list : ('a, _, Elt.t list -> Elt.t list) Base.Set.Without_comparator.t
  • deprecated [since 2023-04] Use [List.stable_dedup] instead.
Sourceval map : ('b, 'cmp, ('a, _) Base.Set.t -> f:('a -> Elt.t) -> t) Base.Set.Without_comparator.t

The types of map and filter_map are subtle. The input set, ('a, _) set, reflects the fact that these functions take a set of *any* type, with any comparator, while the output set, ('b, 'cmp) t, reflects that the output set has the particular 'cmp of the creation function. The comparator can come in one of three ways, depending on which set module is used

  • Set.map -- comparator comes as an argument
  • Set.Poly.map -- comparator is polymorphic comparison
  • Foo.Set.map -- comparator is Foo.comparator
Sourceval filter_map : ('b, 'cmp, ('a, _) Base.Set.t -> f:('a -> Elt.t option) -> t) Base.Set.Without_comparator.t
Sourceval of_hashtbl_keys : ('a, 'cmp, (Elt.t, _) Core.Hashtbl.t -> t) Base.Set.Without_comparator.t
Sourceval of_map_keys : (Elt.t, _, Elt.comparator_witness) Base.Map.t -> t

Never requires a comparator because it can get one from the input Map.t.

Sourcemodule Provide_of_sexp (Elt : sig ... end) : sig ... end
Sourcemodule Provide_bin_io (Elt : sig ... end) : Core.Set_intf.Binable.S with type t := t
Sourcemodule Provide_hash (Elt : Base.Hasher.S with type t := Elt.t) : sig ... end
include Core.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Set_intf.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t