package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

octez-19.1.tar.gz

sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e

sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-libs.stdlib/Tezos_stdlib/Compare/index.html

Module `Tezos_stdlib.Compare`Source

`Compare`

Monomorphic comparison for common ground types and common type constructors.

Compare provides a module signature for the standard comparison functions and operators as well as modules of that signature for the common OCaml ground types (int, bool, etc.) and type constructors (list, option, etc.).

Compare also provides some additional helpers for comparison-related tasks.

Signatures and a functor

Sourcemodule type COMPARABLE = sig ... end

COMPARABLE is a signature for basic comparison. It is used only for instantiating full comparison modules of signature S via the functor Make.

Sourcemodule type S = sig ... end

S is a signature for a fully-fledge comparison module. It includes all the functions and operators derived from a compare function.

Sourcemodule Make (P : COMPARABLE) : S with type t := P.t

Base types

The specialised comparison and all the specialised functions and operators on the base types are compatible with the polymorphic comparison and all the polymorphic functions and operators from the Stdlib.

Sourcemodule Char : S with type t = char

Sourcemodule Bool : S with type t = bool

Sourcemodule Int : sig ... end

Int is a comparison module. Out of performance concerns, the signature actually contains compiler builtins (external) rather than val.

Sourcemodule Int32 : S with type t = int32

Sourcemodule Uint32 : S with type t = int32

Sourcemodule Int64 : S with type t = int64

Sourcemodule Uint64 : S with type t = int64

Sourcemodule Float : S with type t = float

Sourcemodule String : S with type t = string

Sourcemodule Bytes : S with type t = bytes

Sourcemodule Z : S with type t = Z.t

Z is a comparison module for Zarith numbers.

module Q : S with type t = Q.t

Q is a comparison module for Zarith-based rational numbers.

Type constructors

Provided the functor argument(s) are compatible with the polymorphic comparison of the Stdlib, then the specialised comparison and all the specialised functions and operators on the derived types are compatible with the polymorphic comparison and all the polymorphic functions and operators from the Stdlib.

Sourcemodule List (P : COMPARABLE) : S with type t = P.t list

Sourcemodule Option (P : COMPARABLE) : S with type t = P.t option

Source

module Result
  (Ok : COMPARABLE)
  (Error : COMPARABLE) : 
  S with type t = (Ok.t, Error.t) result

List lengths

Helpers for more readable Stdlib.List.compare_lengths and Stdlib.List.compare_length_with.

These modules are intended to be used as Module.(expression), most often within an if condition. E.g.,

if Compare.List_length_with.(chunks > max_number_of_chunks) then
   raise Maximum_size_exceeded
else
   ..

Sourcemodule List_length_with : sig ... end

Sourcemodule List_lengths : sig ... end

Building blocks

Sourceval or_else : int -> (unit -> int) -> int

or_else c f is c if c <> 0 or f () otherwise.

The intended use is

let compare (foo_a, bar_a) (foo_b, bar_b) =
  or_else (Foo.compare foo_a foo_b) (fun () -> Bar.compare bar_a bar_b)

On This Page

Compare