[Git][ghc/ghc][wip/uf-conf-codegen] primops: Document semantics of Float/Int conversions

[Ben Gamari]

Ben Gamari pushed to branch wip/uf-conf-codegen at Glasgow Haskell Compiler / GHC


Commits:
fa34519a by Ben Gamari at 2020-10-26T13:32:23-04:00
primops: Document semantics of Float/Int conversions

Fixes #18840.

- - - - -


1 changed file:

- compiler/GHC/Builtin/primops.txt.pp


Changes:

=====================================
compiler/GHC/Builtin/primops.txt.pp
=====================================
@@ -607,10 +607,22 @@ primop   IntToWordOp "int2Word#" GenPrimOp Int# -> Word#
    with code_size = 0
 
 primop   IntToFloatOp   "int2Float#"      GenPrimOp  Int# -> Float#
+   {Convert an {\tt Int#} to the corrsponding {\tt Float#} with the same
+    integral value (up to truncation due to floating-point precision). e.g.
+    {\tt int2Float# 1# == 1.0#}}
 primop   IntToDoubleOp   "int2Double#"          GenPrimOp  Int# -> Double#
+   {Convert an {\tt Int#} to the corrsponding {\tt Double#} with the same
+    integral value (up to truncation due to floating-point precision). e.g.
+    {\tt int2Double# 1# == 1.0#}}
 
 primop   WordToFloatOp   "word2Float#"      GenPrimOp  Word# -> Float#
+   {Convert an {\tt Word#} to the corrsponding {\tt Float#} with the same
+    integral value (up to truncation due to floating-point precision). e.g.
+    {\tt int2Float# 1# == 1.0#}}
 primop   WordToDoubleOp   "word2Double#"          GenPrimOp  Word# -> Double#
+   {Convert an {\tt Word#} to the corrsponding {\tt Double#} with the same
+    integral value (up to truncation due to floating-point precision). e.g.
+    {\tt int2Double# 1# == 1.0#}}
 
 primop   ISllOp   "uncheckedIShiftL#" GenPrimOp  Int# -> Int# -> Int#
          {Shift left.  Result undefined if shift amount is not



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/fa34519a875ed13c66f6c5e990a873239d53a234

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/fa34519a875ed13c66f6c5e990a873239d53a234
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20201026/36f997e7/attachment-0001.html>