package algaeff

  1. Overview
  2. Docs
Reusable Effects-Based Components

Install

Dune Dependency

Authors

Maintainers

Sources

2.0.0.tar.gz
md5=70f2a933368a5174d21abd84a0a52c04
sha512=71414cc028437d2c1b997257994d9d3345585373b7216ced23521c061cbca76ac7f82a204e4ef71a8617b7d8bf03dddd72e2519f088c2953ed5d716855d4cc6f

Description

This OCaml library collects reusable effects-based components we have identified while developing our proof assistants based on algebraic effects.

Published: 07 Nov 2023

README

README.markdown

# 🦠 Reusable Effects-Based Components

This library aims to collect reusable, general effects-based components we have seen when constructing our proof assistants using OCaml 5. All components here have appeared in various tutorials on algebraic effects; `algaeff` wraps these well-known components into an OPAM package.

## API Stability

We use [semantic versioning.](https://semver.org/) Breaking changes will bump the major version number.

## Components

- [Algaeff.State](https://redprl.org/algaeff/algaeff/Algaeff/State): mutable states
- [Algaeff.Reader](https://redprl.org/algaeff/algaeff/Algaeff/Reader): read-only environments
- [Algaeff.Sequencer](https://redprl.org/algaeff/algaeff/Algaeff/Sequencer): making a `Seq.t`
- [Algaeff.Mutex](https://redprl.org/algaeff/algaeff/Algaeff/Mutex): simple locking to prevent re-entrance
- [Algaeff.UniqueID](https://redprl.org/algaeff/algaeff/Algaeff/UniqueID): generating unique IDs

Effects-based concurrency (cooperative lightweight threading) was already tackled by other libraries such as [Eio](https://github.com/ocaml-multicore/eio) and [Affect](https://erratique.ch/software/affect). This library focuses on the rest.

There are a few other useful functions:

- [Algaeff.Fun.Deep.finally](https://redprl.org/algaeff/algaeff/Algaeff/Fun/Deep/index.html#val-finally): call `continue` or `discontinue` accordingly.
- [Algaeff.Fun.Shallow.finally_with](https://redprl.org/algaeff/algaeff/Algaeff/Fun/Shallow/index.html#val-finally_with): same as above, but for shallow effect handlers.

## How to Use It

### OCaml >= 5.0.0

You need OCaml 5.

### Example Code

```ocaml
module S = Algaeff.State.Make (Int)

let forty_two = S.run ~init:100 @@ fun () ->
  print_int (S.get ()); (* this will print out 100 *)
  S.set 42;
  S.get ()
```

### Documentation

[Here is the API documentation.](https://redprl.org/algaeff/algaeff/Algaeff)

Dependencies (2)

  1. ocaml >= "5.0"
  2. dune >= "2.0"

Dev Dependencies (3)

  1. odoc with-doc
  2. qcheck-core >= "0.18" & with-test
  3. alcotest >= "1.5" & with-test

Used by (3)

  1. asai >= "0.3.0"
  2. forester >= "3.0.0"
  3. yuujinchou >= "5.2.0"

Conflicts

None