int and float info on readme

This commit is contained in:
Aaron Manning 2021-12-18 20:45:09 +11:00 committed by aaron-jack-manning
parent 99d1f15c9d
commit 1c94d51334

View File

@ -10,6 +10,8 @@ This is very bespoke for my requirements, and only something I do/use when I am
This library includes the following custom modules:
- Int (exposure of basic integer arithmetic functions)
- Float (exposure of basic float arithmetic functions)
- List (functional list data structure)
- Queue (functional queue implemented as two lists)
- Set (functional set implemented as a red-black tree)
@ -44,4 +46,4 @@ Also take note of the fact that I typically compile everything with `-S` and `-O
## The Core Library
One of the unfortunate consequences of the way OCaml's compilation works, is that there is a library called the core library, documented [here](https://ocaml.org/manual/core.html), which contains some definitions for types and exceptions, yet does not include the code from the stdlib that uses them. When compiling with the `-nopervasives` flag, this is still included but without the standard library. While this makes sense from the perspective of having some fundamental exceptions always available, having types like `list` included makes it very annoying when implemented a custom standard library. This quirk is why my library has no type definition for `list`, `bool`, `option`, etc. but still uses these types.
One of the unfortunate consequences of the way OCaml's compilation works, is that there is a library called the core library, documented [here](https://ocaml.org/manual/core.html), which contains some definitions for types and exceptions, yet does not include the code from the stdlib that uses them. When compiling with the `-nopervasives` flag, this is still included but without the standard library. While this makes sense from the perspective of having some fundamental exceptions always available, having types like `list` included makes it very annoying when implemented a custom standard library. This quirk is why my library has no type definition for `list`, `bool`, `option`, etc. but still uses these types.