package checked_oint

  1. Overview
  2. Docs
An OCaml library for checked integer arithmetic

Install

Dune Dependency

Authors

Maintainers

Sources

v0.1.1.tar.gz
md5=8c5bd9e10faffd495037c4ecd0f8e6ea
sha512=e0179cbb8ea6d3f1a5ed87e190c88cd5a95a5cca817ef786b945e0fd8ffaaea46d34b64ea673b6c184fae27860f9a44ad0b66dc974fbfc9558de9025eb84d6f2

Description

Published: 10 May 2024

README

checked_oint

checked_oint is an OCaml library for checked integer arithmetic. We support the full set of signed and unsigned integers of bitnesses 8, 16, 32, 64, and 128.

Installation

$ opam install checked_oint

Usage

open Checked_oint

let () =
  let x = U8.of_int_exn 50 in
  let y = U8.of_int_exn 70 in
  assert (U8.equal (U8.add_exn x y) (U8.of_int_exn 120));
  assert (Option.is_none (U8.mul x y))

You can find the API documentation here.

Release procedure

  1. Update the version field in dune-project.

  2. Type dune build to generate checked_oint.opam.

  3. Update CHANGELOG.md.

  4. Release the project in GitHub Releases.

  5. Type git pull && opam publish.

Dev Dependencies (1)

  1. odoc with-doc

Used by

None

Conflicts

None

OCaml

Innovation. Community. Security.