Create README
This commit is contained in:
parent
a8f9b98c70
commit
048177a548
11
README.md
11
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`.
|
Loading…
Reference in a new issue