membrain: Type-safe memory units
membrain provides newtype wrapper for type-safe work with memory units
newtype Memory (mem :: Nat) = Memory
{ unMemory :: Natural
}
This data type stores memory unit value phantom type parameter which is represented as type-level natural number. The ideas behind this package are described in the following blog post:
[Skip to Readme]
Downloads
- membrain-0.0.0.2.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 0.0.0.0, 0.0.0.1, 0.0.0.2 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | base (>=4.10.1.0 && <4.15) [details] |
| Tested with | ghc ==8.2.2, ghc ==8.4.4, ghc ==8.6.5, ghc ==8.8.3, ghc ==8.10.1 |
| License | MPL-2.0 |
| Copyright | 2018-2020 Kowainik |
| Author | Veronika Romashkina, Dmitrii Kovanikov |
| Maintainer | Kowainik <xrom.xkov@gmail.com> |
| Revised | Revision 1 made by vrom911 at 2020-06-03T10:26:35Z |
| Category | Memory, Safe |
| Home page | https://github.com/kowainik/membrain |
| Bug tracker | https://github.com/kowainik/membrain/issues |
| Source repo | head: git clone https://github.com/kowainik/membrain.git |
| Uploaded | by vrom911 at 2020-05-11T09:28:17Z |
| Distributions | |
| Downloads | 1057 total (16 in the last 30 days) |
| Rating | 2.25 (votes: 2) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs uploaded by user Build status unknown [no reports yet] |
Readme for membrain-0.0.0.2
[back to package description]membrain
"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:
- Focus on correctness.
- Low amount of boilerplate should be required to use the library.
The ideas behind this package are described in the following blog post:
The library is built around the following data type:
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:
- Smart constructors.
- Conversion functions.
- Pretty displaying.
- Dependently-typed parsing.
- Numeric functions.
- Type-safe wrappers around functions from
base.
Acknowledgement
Icons made by Kiranshastry from Flaticon is licensed by CC 3.0 BY.