package checked_oint

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

Install

Dune Dependency

Authors

Maintainers

Sources

checked_oint-0.4.0.tar.gz
md5=abc8c77a6e909ca0938206929c8b526d
sha512=dc9d3509656e1fa99615e1ad78f1f7f537cfe115ccd439dbee8094f394373b49aed0cc513052a4a3e6ba68bf7ee2632456f9679dcb2da779b0792931af8862fd

Description

Published: 26 Nov 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 (1)

  1. mazeppa

Conflicts

None

OCaml

Innovation. Community. Security.