GaloisInc/cryptol
1
1
Fork 0
mirror of https://github.com/GaloisInc/cryptol.git synced 2024-08-16 17:30:27 +03:00
Code Issues Projects Releases Wiki Activity

Add docstring for 'RoundingMode'. Fixes #836.

Browse Source
This commit is contained in:
Brian Huffman 2020-07-28 14:11:47 -07:00
parent cf57a0ffd2
commit b9eb076441
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/Float.cry
View File

@ -27,6 +27,17 @@ type Float256 = Float 19 237
* Rounding modes (this should be an enumeration type, when we add these)
*---------------------------------------------------------------------- */
/**
* A 'RoundingMode' is used to specify the precise behavior of some
* floating point primitives.
*
* There are five valid 'RoundingMode' values:
* * roundNearestEven
* * roundNearestAway
* * roundPositive
* * roundNegative
* * roundZero
*/
type RoundingMode = [3]
/** Round toward nearest, ties go to even. */