From 048177a548b5fc4d30d1a5c4ba7022a91877107f Mon Sep 17 00:00:00 2001 From: Kiana Sheibani Date: Sun, 4 Sep 2022 16:39:55 -0400 Subject: [PATCH] Create README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e69de29..2a87b14 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,11 @@ +# idris2-ratio + +A small library for arbitrary-precision ratio types. + +The main type exported by this library is `Data.Ratio.Rational`, which is a +number type stored as the ratio between two integers. The ratio is always stored +in reduced form to save memory space, but this comes at the cost of worst-case +O(n) arithmetic. + +The specific integer type used for the ratio can be set by using `Data.Ratio.Ratio`, +which takes a type parameter `a`. Most operations require `Integral a`.