Home

This wiki exists to document the design and use of the HotDrink library. Discussion should be directed to the mailing list.

Background

To begin, it may help to get a little background on constraint systems, the fundamental basis of the HotDrink library.

Tutorial

Get acquainted with HotDrink by reading the tutorial.

Notation

In the rest of the documentation, you will come across Haskell-style type signatures:

property :: Type
functionOrMethod :: FirstArgType -> SecondArgType -> ReturnType

Like in Haskell, type names begin with a capital letter. Type variables begin with a lowercase letter. We use a special type, Any, as a universal type variant. The unit type is ().

Optional function parameters are suffixed with ?. Variable function parameters are suffixed with .... Both suffixes may co-exist (and, in fact, do at least once).

Tour

Learn about HotDrink in greater detail (or prepare to contribute) by taking a look at the library's overall organization.