Home My Page Projects Code Snippets Project Openings diderot
Summary Activity Tracker Tasks SCM

SCM Repository

[diderot] Annotation of /trunk/src/compiler/common/float-lit.sml
ViewVC logotype

Annotation of /trunk/src/compiler/common/float-lit.sml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 234 - (view) (download)

1 : jhr 26 (* float-lit.sml
2 :     *
3 :     * COPYRIGHT (c) 2010 The Diderot Project (http://diderot.cs.uchicago.edu)
4 :     * All rights reserved.
5 :     *
6 :     * Internal representation of floating-point literals with limited
7 :     * support for arithmetic.
8 :     *)
9 :    
10 :     structure FloatLit :> sig
11 :    
12 :     type float
13 :    
14 :     val isZero : float -> bool
15 :    
16 :     (* return the representation of +/-0.0 *)
17 : jhr 83 val zero : bool -> float
18 : jhr 26
19 :     (* plus and minus one *)
20 :     val one : float
21 :     val m_one : float
22 :    
23 :     (* negate a float *)
24 :     val negate : float -> float
25 :    
26 :     (* equality, comparisons, and hashing functions *)
27 :     val same : (float * float) -> bool
28 : jhr 42 val compare : (float * float) -> order (* not ordering on reals *)
29 : jhr 26 val hash : float -> word
30 :    
31 : jhr 42 (* special floats *)
32 :     val nan : float (* some quiet NaN *)
33 :     val posInf : float (* positive infinity *)
34 :     val negInf : float (* negative infinity *)
35 :    
36 : jhr 26 (* create a float from pieces: isNeg is true if the number is negative, whole
37 :     * is the whole-number part, frac is the fractional part, and exp is the
38 :     * exponent. This function may raise Overflow, when the exponent of the
39 :     * normalized representation is too small or too large.
40 :     *)
41 :     val float : {isNeg : bool, whole : string, frac : string, exp : int} -> float
42 :     val toString : float -> string
43 : jhr 234 val toReal : float -> real
44 : jhr 26
45 :     (* external representation (for pickling) *)
46 :     val toBytes : float -> Word8Vector.vector
47 :     val fromBytes : Word8Vector.vector -> float
48 :    
49 :     end = struct
50 :    
51 :     structure SS = Substring
52 :     structure W = Word
53 :     structure W8V = Word8Vector
54 :    
55 :     (* The value {isNeg, digits=[d0, ..., dn], exp} represents the number
56 :     *
57 :     * [+/-] 0.d0...dn * 10^exp
58 :     *
59 :     * where the sign is negative if isNeg is true.
60 :     *)
61 : jhr 42 datatype float
62 :     = PosInf (* positive infinity *)
63 :     | NegInf (* negative infinity *)
64 :     | NaN (* some quiet NaN *)
65 :     | Flt of {isNeg : bool, digits : int list, exp : int}
66 : jhr 26
67 : jhr 42 (* special floats *)
68 :     val nan = NaN
69 :     val posInf = PosInf
70 :     val negInf = NegInf
71 :    
72 :     fun isZero (Flt{isNeg, digits=[0], exp}) = true
73 : jhr 26 | isZero _ = false
74 :    
75 : jhr 42 fun zero isNeg = Flt{isNeg = isNeg, digits = [0], exp = 0}
76 : jhr 26
77 : jhr 42 val one = Flt{isNeg = false, digits = [1], exp = 1}
78 :     val m_one = Flt{isNeg = true, digits = [1], exp = 1}
79 : jhr 26
80 :     (* negate a float *)
81 : jhr 42 fun negate PosInf = NegInf
82 :     | negate NegInf = PosInf
83 :     | negate NaN = raise Fail "negate nan"
84 :     | negate (Flt{isNeg, digits, exp}) =
85 :     Flt{isNeg = not isNeg, digits = digits, exp = exp}
86 : jhr 26
87 :     (* equality, comparisons, and hashing functions *)
88 : jhr 42 fun same (NegInf, NegInf) = true
89 :     | same (PosInf, PosInf) = true
90 :     | same (NaN, NaN) = true
91 :     | same (Flt f1, Flt f2) =
92 : jhr 26 (#isNeg f1 = #isNeg f2) andalso (#exp f1 = #exp f2)
93 :     andalso (#digits f1 = #digits f2)
94 : jhr 42 | same _ = false
95 : jhr 26
96 : jhr 42 fun compare (NegInf, NegInf) = EQUAL
97 :     | compare (NegInf, _) = LESS
98 :     | compare (_, NegInf) = GREATER
99 :     | compare (PosInf, PosInf) = EQUAL
100 :     | compare (PosInf, _) = LESS
101 :     | compare (_, PosInf) = GREATER
102 :     | compare (NaN, NaN) = EQUAL
103 :     | compare (NaN, _) = LESS
104 :     | compare (_, NaN) = GREATER
105 :     | compare (Flt f1, Flt f2) = (case (#isNeg f1, #isNeg f2)
106 : jhr 26 of (false, true) => GREATER
107 :     | (true, false) => LESS
108 :     | _ => (case Int.compare(#exp f1, #exp f2)
109 :     of EQUAL => let
110 :     fun cmp ([], []) = EQUAL
111 :     | cmp ([], _) = LESS
112 :     | cmp (_, []) = GREATER
113 :     | cmp (d1::r1, d2::r2) = (case Int.compare(d1, d2)
114 :     of EQUAL => cmp(r1, r2)
115 :     | order => order
116 :     (* end case *))
117 :     in
118 :     cmp (#digits f1, #digits f2)
119 :     end
120 :     | order => order
121 :     (* end case *))
122 :     (* end case *))
123 :    
124 : jhr 42 fun hash PosInf = 0w1
125 :     | hash NegInf = 0w3
126 :     | hash NaN = 0w5
127 :     | hash (Flt{isNeg, digits, exp}) = let
128 : jhr 26 fun hashDigits ([], h, _) = h
129 :     | hashDigits (d::r, h, i) =
130 :     hashDigits (r, W.<<(W.fromInt d, i+0w4), W.andb(i+0w1, 0wxf))
131 :     in
132 :     hashDigits(digits, W.fromInt exp, 0w0)
133 :     end
134 :    
135 :     fun float {isNeg, whole, frac, exp} = let
136 :     fun cvtDigit (c, l) = (Char.ord c - Char.ord #"0") :: l
137 :     fun isZero #"0" = true | isZero _ = false
138 :     (* whole digits with leading zeros removed *)
139 :     val whole = SS.dropl isZero (SS.full whole)
140 :     (* fractional digits with trailing zeros removed *)
141 :     val frac = SS.dropr isZero (SS.full frac)
142 :     (* normalize by stripping leading zero digits *)
143 :     fun normalize {isNeg, digits=[], exp} = zero isNeg
144 :     | normalize {isNeg, digits=0::r, exp} =
145 :     normalize {isNeg=isNeg, digits=r, exp=exp-1}
146 : jhr 42 | normalize flt = Flt flt
147 : jhr 26 in
148 :     case SS.foldr cvtDigit (SS.foldr cvtDigit [] frac) whole
149 :     of [] => zero isNeg
150 :     | digits => normalize {
151 :     isNeg = isNeg,
152 :     digits = digits,
153 :     exp = exp + SS.size whole
154 :     }
155 :     (* end case *)
156 :     end
157 :    
158 : jhr 42 fun toString PosInf = "+inf"
159 :     | toString NegInf = "-inf"
160 :     | toString NaN = "nan"
161 :     | toString (Flt{isNeg, digits, exp}) = let
162 : jhr 26 val s = if isNeg then "-0." else "0."
163 :     val e = if exp < 0
164 :     then ["e-", Int.toString(~exp)]
165 :     else ["e", Int.toString exp]
166 :     in
167 :     concat(s :: List.foldr (fn (d, ds) => Int.toString d :: ds) e digits)
168 :     end
169 :    
170 : jhr 234 fun toReal PosInf = Real.posInf
171 :     | toReal NegInf = Real.negInf
172 :     | toReal NaN = 0.0 / 0.0
173 :     | toReal x = valOf(Real.fromString(toString x)) (* FIXME *)
174 : jhr 26
175 :    
176 :     (***** external representation (for pickling) *****
177 :     *
178 :     * The representation we use is a sequence of bytes:
179 :     *
180 :     * [sign, d0, ..., dn, exp0, ..., exp3]
181 :     *
182 :     * where
183 :     * sign == 0 or 1
184 :     * di == ith digit
185 :     * expi == ith byte of exponent (exp0 is lsb, exp3 is msb).
186 :     *
187 : jhr 42 * we encode Infs and NaNs using the sign byte:
188 :     *
189 :     * 2 == PosInf
190 :     * 3 == NegInf
191 :     * 4 == NaN
192 :     *
193 : jhr 26 * NOTE: we could pack the sign and digits into 4-bit nibbles, but we are keeping
194 :     * things simple for now.
195 :     *)
196 :    
197 : jhr 42 fun toBytes PosInf = Word8Vector.fromList [0w2]
198 :     | toBytes NegInf = Word8Vector.fromList [0w3]
199 :     | toBytes NaN = Word8Vector.fromList [0w4]
200 :     | toBytes (Flt{isNeg, digits, exp}) = let
201 : jhr 26 val sign = if isNeg then 0w1 else 0w0
202 :     val digits = List.map Word8.fromInt digits
203 :     val exp' = W.fromInt exp
204 :     fun byte i = Word8.fromLargeWord(W.toLargeWord((W.>>(exp', 0w8*i))))
205 :     val exp = [byte 0w0, byte 0w1, byte 0w2, byte 0w3]
206 :     in
207 :     Word8Vector.fromList(sign :: (digits @ exp))
208 :     end
209 :    
210 :     fun fromBytes v = let
211 :     fun error () = raise Fail "Bogus float pickle"
212 : jhr 42 val len = W8V.length v
213 :     in
214 :     if (len = 1)
215 :     then (case W8V.sub(v, 0) (* special float value *)
216 :     of 0w2 => PosInf
217 :     | 0w3 => NegInf
218 :     | 0w4 => NaN
219 : jhr 26 | _ => error()
220 :     (* end case *))
221 : jhr 42 else let
222 :     val ndigits = W8V.length v - 5
223 :     val _ = if (ndigits < 1) then error() else ()
224 :     val isNeg = (case W8V.sub(v, 0)
225 :     of 0w0 => false
226 :     | 0w1 => true
227 :     | _ => error()
228 :     (* end case *))
229 :     fun digit i = Word8.toInt(W8V.sub(v, i+1))
230 :     fun byte i = W.<<(
231 :     W.fromLargeWord(Word8.toLargeWord(W8V.sub(v, ndigits+1+i))),
232 :     W.fromInt(8*i))
233 :     val exp = W.toIntX(W.orb(byte 3, W.orb(byte 2, W.orb(byte 1, byte 0))))
234 :     in
235 :     Flt{isNeg = isNeg, digits = List.tabulate(ndigits, digit), exp = exp}
236 :     end
237 : jhr 26 end
238 :    
239 :     end
240 :    

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0