package checked_oint

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

Install

Dune Dependency

Authors

Maintainers

Sources

v0.2.0.tar.gz
md5=5ee41b2897b3f2eba115bcbcdfd5c678
sha512=c8d33fad538fea814c1fc89981bc57132025e544d83bdce41133f2c3660dba7f0a94c25626f6619d06d657345867acb779bef45353dfc03a59e698e4a8644432

Description

Published: 14 Jun 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.