mirror of
https://github.com/GaloisInc/cryptol.git
synced 2024-09-11 14:06:13 +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)
|
* 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]
|
type RoundingMode = [3]
|
||||||
|
|
||||||
/** Round toward nearest, ties go to even. */
|
/** Round toward nearest, ties go to even. */
|
||||||
|
Loading…
Reference in New Issue
Block a user