Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.03 KB

README.md

File metadata and controls

42 lines (26 loc) · 1.03 KB

Build Status

FSQ: Functional Fixed-size Search Queues

FSQ is an OCaml implementation of functional fixed-size search queues, where old elements get popped from the queue when pushing to a queue that reached its maximum size.

This implementation is based on Priority Search Queues.

FSQ is distributed under the MPL-2.0 license.

Installation

fsq can be installed via opam:

opam install fsq

Building

To build from source, generate documentation, and run tests, use dune:

dune build
dune build @doc
dune runtest -f

In addition, the following Makefile targets are available as a shorthand for the above:

make all
make build
make doc
make test

Documentation

The documentation and API reference is generated from the source interfaces. It can be consulted online or via odig:

odig doc fsq