# membrain

![memory-brain](https://user-images.githubusercontent.com/4276606/61223141-aa6bf400-a74e-11e9-876a-09e883ee5d5a.png)
[![Build status](https://img.shields.io/travis/kowainik/membrain.svg?logo=travis)](https://travis-ci.org/kowainik/membrain)
[![Hackage](https://img.shields.io/hackage/v/membrain.svg?logo=haskell)](https://hackage.haskell.org/package/membrain)
[![Stackage Lts](http://stackage.org/package/membrain/badge/lts)](http://stackage.org/lts/package/membrain)
[![Stackage Nightly](http://stackage.org/package/membrain/badge/nightly)](http://stackage.org/nightly/package/membrain)
[![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)

> "People think dreams aren't real just because they aren't made of matter, of particles.
> Dreams are real. But they are made of viewpoints, of images, of memories and puns and lost hopes."
>
> ― Neil Gaiman

This package implements type-safe memory units. It pursues the following goals:

1. Focus on correctness.
2. Low amount of boilerplate should be required to use the library.

The ideas behind this package are described in the following blog post:

 * [Insane in the Membrain](https://kowainik.github.io/posts/membrain)

The library is built around the following data type:

```haskell
newtype Memory (mem :: Nat) = Memory
    { unMemory :: Natural
    }
```

This data type stores every memory internally as bits. However, unit multiplier
is stored as type-level natural number. This approach allows to represent
different units and implement instances for them with low amount of boilerplate.

`membrain` implements various useful functions to work with `Memory`:

1. Smart constructors.
2. Conversion functions.
3. Pretty displaying.
4. Dependently-typed parsing.
5. Numeric functions.
6. Type-safe wrappers around functions from `base`.

## Acknowledgement

Icons made by [Kiranshastry](https://www.flaticon.com/authors/kiranshastry) from [Flaticon](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).