package gen

  1. Overview
  2. Docs
Simple and efficient iterators (modules Gen and GenLabels).

Install

Dune Dependency

Authors

Maintainers

Sources

0.5.1.tar.gz
sha256=2bc625f816a4c2efe3a781552551862e7eacca26a1000ea3698fa4c08eec2c6a
md5=4fb545ddde26dd084f01210681df4c14

Description

Now provides additional modules GenClone and GenMList for lower-level control over persistency and duplication of iterators.

Tags

gen iterator iter fold

Published: 03 Feb 2018

README

Gen

Iterators for OCaml, both restartable and consumable. The implementation keeps a good balance between simplicity and performance.

The library is extensively tested using qtest. If you find a bug, please report!

The documentation can be found here; the main module is Gen and should suffice for 95% of use cases.

Install

$ opam install gen

or, manually, by building the library and running make install. Opam is recommended, for it keeps the library up-to-date.

Use

You can either build and install the library (see "Build"), or just copy files to your own project. The last solution has the benefits that you don't have additional dependencies nor build complications (and it may enable more inlining).

If you have comments, requests, or bugfixes, please share them! :-)

Build

There are no dependencies. This should work with OCaml>=3.12.

$ make

To build and run tests (requires oUnit and qtest):

$ opam install oUnit qtest
$ ./configure --enable-tests
$ make test

License

This code is free, under the BSD license.

Dependencies (3)

  1. base-bytes
  2. jbuilder >= "1.0+beta12"
  3. ocaml < "4.11"

Dev Dependencies (3)

  1. qcheck with-test & < "0.14"
  2. qtest with-test
  3. odoc with-doc

Conflicts

None

OCaml

Innovation. Community. Security.