mirror of
https://github.com/GaloisInc/cryptol.git
synced 2024-10-26 14:20:59 +03:00
Add docstring for 'RoundingMode'. Fixes #836.
This commit is contained in:
parent
cf57a0ffd2
commit
b9eb076441
@ -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. */
|
||||
|
Loading…
Reference in New Issue
Block a user