linear-base: Standard library for linear types.

[ library, mit, prelude ] [ Propose Tags ]

Please see README.md.


[Skip to Readme]
Versions [faq] 0.1.0
Change log CHANGELOG.md
Dependencies base (>=4.15 && <5), containers, ghc-prim, hashable, primitive, storable-tuple, text, transformers, vector [details]
License MIT
Copyright (c) Tweag Holding and affiliates
Author Tweag
Maintainer arnaud.spiwack@tweag.io
Category Prelude
Home page https://github.com/tweag/linear-base#README
Source repo head: git clone https://github.com/tweag/linear-base
Uploaded by utdemir at 2021-02-09T00:40:18Z
Distributions NixOS:0.1.0
Downloads 89 total (10 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user [build log]
All reported builds failed as of 2021-02-09 [all 2 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for linear-base-0.1.0

[back to package description]

Linear base

License MIT Build status

Linear base is a standard library for developing applications with linear types. It is named linear-base to be an analog to the original base package that ships with GHC.

The purpose of linear-base is to provide the minimal facilities you need to write practical Linear Haskell code, i.e., Haskell code that uses the -XLinearTypes language extension.

Motivation

Why do you need linear-base to write linear projects?

  1. Data types, functions and classes in base are not linear types aware. For instance, if n is a linearly-bound Int, the RHS of a definition cannot write n + 1 — this will not type check. We need linear variants of Num, Functors, Monads, ($), etc.

  2. This library exports new abstractions that leverage linear types for resource safety or performance. For example, there are new APIs for file and socket I/O as well as for safe in-place mutation of arrays.

Getting started

-XLinearTypes is released with GHC 9, and linear-base is released on Hackage.

All source files with linear types need a language extension pragma at the top:

{-# LANGUAGE LinearTypes #-}

User Guide

If you already know what -XLinearTypes does and what the linear arrow a %1-> b means, then read the User Guide and explore the examples/ folder to know how to use linear-base.

Learning about -XLinearTypes

If you're a Haskeller who hasn't written any Linear Haskell code, don't fear! There are plenty of excellent resources and examples to help you.

Tutorials and examples

Reading material

Talks

Contributing

Linear base is maintained by Tweag.

To contribute please see the Design Document for instructions and advice on making pull requests.

Licence

See the Licence file.

Copyright © Tweag Holding and its affiliates.