/
digits.ex
564 lines (444 loc) · 15.4 KB
/
digits.ex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
defmodule Cldr.Digits do
@moduledoc """
Abstract representation of number (integer, float, Decimal) in tuple form
and functions for transformations on number parts.
Representing a number as a list of its digits, and integer representing
where the decimal point is placed and an integer representing the sign
of the number allow more efficient transforms on the various parts of
the number as happens during the formatting of a number for string output.
"""
import Bitwise
import Cldr.Math, only: [power_of_10: 1]
require Integer
alias Cldr.Math
@typedoc """
Defines a number in a tuple form of three parts:
* A list of digits (0..9) representing the number
* A digit representing the place of the decimal points
in the number
* a `1` or `-1` representing the sign of the number
A number in integer, float or Decimal form can be converted
to digit form with `Digits.to_digits/1`.
The digits can be converted back to normal form with
`Cldr.Digits.to_integer/1`, `Cldr.Digits.to_float/1` and
`Cldr.Digits.to_decimal/1`.
"""
@type t :: {[0..9, ...], non_neg_integer, 1 | -1}
@two52 bsl(1, 52)
@two53 bsl(1, 53)
@float_bias 1022
@min_e -1074
@doc """
Returns the fractional part of an integer, float or Decimal as an integer.
* `number` can be either a float, Decimal or integer although an integer has
no fraction part and will therefore always return 0.
## Examples
iex> Cldr.Digits.fraction_as_integer(123.456)
456
iex> Cldr.Digits.fraction_as_integer(Decimal.new("123.456"))
456
iex> Cldr.Digits.fraction_as_integer(1999)
0
"""
@spec fraction_as_integer(Math.number_or_decimal() | {list, list, 1 | -1}) :: integer
def fraction_as_integer({_integer, fraction, _sign})
when is_list(fraction) do
Integer.undigits(fraction)
end
def fraction_as_integer({_integer, [], _sign}) do
0
end
def fraction_as_integer(number) do
number
|> to_tuple
|> fraction_as_integer
end
def fraction_as_integer(number, rounding) do
number = Float.round(number, rounding)
fraction_as_integer(number)
end
@doc """
Returns the number of decimal digits in a number
(integer, float, Decimal)
## Options
* `number` is an integer, float or `Decimal`
or a list (which is assumed to contain digits).
## Examples
iex> Cldr.Digits.number_of_digits(1234)
4
iex> Cldr.Digits.number_of_digits(Decimal.new("123456789"))
9
iex> Cldr.Digits.number_of_digits(1234.456)
7
iex> Cldr.Digits.number_of_digits(1234.56789098765)
15
iex> Cldr.Digits.number_of_digits '12345'
5
"""
@spec number_of_digits(
Math.number_or_decimal()
| list()
| {[integer(), ...], integer | [integer(), ...], -1 | 1}
) :: integer
def number_of_digits(%Decimal{} = number) do
number
|> to_digits
|> number_of_digits
end
def number_of_digits(number) when is_number(number) do
number
|> to_digits
|> number_of_digits
end
def number_of_digits(list) when is_list(list) do
length(list)
end
def number_of_digits({integer, place, _sign})
when is_list(integer) and is_integer(place) do
length(integer)
end
@doc """
Returns the number of decimal digits in the integer
part of a number.
## Options
* `number` is an integer, float or `Decimal` or
a list (which is assumed to contain digits).
## Examples
iex> Cldr.Digits.number_of_integer_digits(1234)
4
iex> Cldr.Digits.number_of_integer_digits(Decimal.new("123456789"))
9
iex> Cldr.Digits.number_of_integer_digits(1234.456)
4
iex> Cldr.Digits.number_of_integer_digits '12345'
5
"""
@spec number_of_integer_digits(
Math.number_or_decimal()
| list()
| {[integer(), ...], integer | [integer(), ...], -1 | 1}
) :: integer
def number_of_integer_digits(%Decimal{} = number) do
number
|> to_digits
|> number_of_integer_digits
end
def number_of_integer_digits(number) when is_number(number) do
number
|> to_digits
|> number_of_integer_digits
end
# A decomposed integer might be charlist or a list of integers
# since for certain transforms this is more efficient. Note
# that we are not checking if the list elements are actually
# digits.
def number_of_integer_digits(list) when is_list(list) do
length(list)
end
# For a tuple returned by `Digits.to_digits/1`
def number_of_integer_digits({integer, place, _sign})
when is_list(integer) and is_integer(place) and place <= 0 do
0
end
def number_of_integer_digits({integer, place, _sign})
when is_list(integer) and is_integer(place) do
place
end
# For a tuple returned by `Digits.to_tuple/1`
def number_of_integer_digits({[], _fraction, _sign}) do
0
end
def number_of_integer_digits({integer, fraction, _sign})
when is_list(integer) and is_list(fraction) do
number_of_integer_digits(integer)
end
@doc """
Remove trailing zeroes from the integer part of a number
and returns the integer part without trailing zeros.
* `number` is an integer, float or Decimal.
## Examples
iex> Cldr.Digits.remove_trailing_zeros(1234000)
1234
"""
@spec remove_trailing_zeros(Math.number_or_decimal() | [integer(), ...]) ::
integer | [integer(), ...]
def remove_trailing_zeros(0) do
0
end
def remove_trailing_zeros(number) when is_number(number) do
{integer_digits, _fraction_digits, sign} = to_tuple(number)
removed = remove_trailing_zeros(integer_digits)
to_integer({removed, length(removed), sign})
end
def remove_trailing_zeros(%Decimal{} = number) do
{integer_digits, _fraction_digits, sign} = to_tuple(number)
removed = remove_trailing_zeros(integer_digits)
to_integer({removed, length(removed), sign})
end
# Filters either a charlist or a list of integers.
def remove_trailing_zeros(number) when is_list(number) do
Enum.take_while(number, fn c ->
(c >= ?1 and c <= ?9) or c > 0
end)
end
@doc """
Returns the number of leading zeros in a
Decimal fraction.
* `number` is an integer, float or Decimal
Returns the number of leading zeros in the fractional
part of a number.
## Examples
iex> Cldr.Digits.number_of_leading_zeros(Decimal.new("0.0001"))
3
"""
@spec number_of_leading_zeros(Math.number_or_decimal() | [integer(), ...]) :: integer
def number_of_leading_zeros(%Decimal{} = number) do
{_integer_digits, fraction_digits, _sign} = to_tuple(number)
number_of_leading_zeros(fraction_digits)
end
def number_of_leading_zeros(number) when is_number(number) do
{_integer_digits, fraction_digits, _sign} = to_tuple(number)
number_of_leading_zeros(fraction_digits)
end
def number_of_leading_zeros(number) when is_list(number) do
Enum.take_while(number, fn c -> c == ?0 or c == 0 end)
|> length
end
@doc """
Returns the number of trailing zeros in an
integer number.
* `number` is an integer.
Returns the number of trailing zeros in the fractional
part of an integer.
## Examples
iex> Cldr.Digits.number_of_trailing_zeros(123000)
3
"""
def number_of_trailing_zeros(number) when is_integer(number) do
{integer_digits, _fraction_digits, _sign} = to_tuple(number)
number_of_trailing_zeros(integer_digits)
end
def number_of_trailing_zeros(number) when is_list(number) do
number
|> Enum.reverse
|> Enum.take_while(fn c -> c == ?0 or c == 0 end)
|> length
end
@doc """
Converts given number to a list representation.
Given an IEEE 754 float, computes the shortest, correctly rounded list of
digits that converts back to the same Double value when read back with
String.to_float/1. Implements the algorithm from "Printing Floating-Point
Numbers Quickly and Accurately" in Proceedings of the SIGPLAN '96 Conference
on Programming Language Design and Implementation.
Returns a tuple comprising a charlist for the integer part,
a charlist for the fractional part and an integer for the sign.
"""
# Code extracted from:
# https://github.com/ewildgoose/elixir-float_pp/blob/master/lib/float_pp/digits.ex,
# which is licensed under http://www.apache.org/licenses/LICENSE-2.0
@spec to_tuple(Decimal.t() | number) :: {list(), list(), integer}
def to_tuple(number) do
{mantissa, exp, sign} = to_digits(number)
mantissa =
cond do
# Need to right fill with zeros
exp > length(mantissa) ->
mantissa ++ :lists.duplicate(exp - length(mantissa), 0)
# Need to left fill with zeros
exp < 0 ->
:lists.duplicate(abs(exp), 0) ++ mantissa
true ->
mantissa
end
cond do
# Its an integer
exp == length(mantissa) ->
{mantissa, [], sign}
# It's a fraction with no integer part
exp <= 0 ->
{[], mantissa, sign}
# It's a fraction
exp > 0 and exp < length(mantissa) ->
{integer, fraction} = :lists.split(exp, mantissa)
{integer, fraction, sign}
end
end
@doc """
Computes a iodata list of the digits of the given IEEE 754 floating point number,
together with the location of the decimal point as {digits, place, positive}.
A "compact" representation is returned, so there may be fewer digits returned
than the decimal point location.
"""
def to_digits(float_0) when float_0 == 0.0, do: {[0], 1, 1}
def to_digits(0), do: {[0], 1, 1}
def to_digits(float) when is_float(float) do
# Find mantissa and exponent from IEEE-754 packed notation
{frac, exp} = frexp(float)
# Scale fraction to integer (and adjust mantissa to compensate)
frac = trunc(abs(frac) * @two53)
exp = exp - 53
# Compute digits
flonum(float, frac, exp)
end
if Code.ensure_loaded?(Decimal) and function_exported?(Decimal, :normalize, 1) do
def to_digits(%Decimal{} = number) do
%Decimal{coef: coef, exp: exp, sign: sign} = Decimal.normalize(number)
{digits, _place, _sign} = to_digits(coef)
{digits, length(digits) + exp, sign}
end
else
def to_digits(%Decimal{} = number) do
%Decimal{coef: coef, exp: exp, sign: sign} = Decimal.reduce(number)
{digits, _place, _sign} = to_digits(coef)
{digits, length(digits) + exp, sign}
end
end
def to_digits(integer) when is_integer(integer) when integer >= 0 do
digits = Integer.digits(integer)
{digits, length(digits), 1}
end
def to_digits(integer) when is_integer(integer) do
digits = Integer.digits(integer)
{digits, length(digits), -1}
end
@doc """
Takes a list of digits and coverts them back to a number of the same
type as `number`.
"""
def to_number(digits, number) when is_integer(number), do: to_integer(digits)
def to_number(digits, number) when is_float(number), do: to_float(digits)
def to_number(digits, %Decimal{}), do: to_decimal(digits)
def to_number(digits, :integer), do: to_integer(digits)
def to_number(digits, :float), do: to_float(digits)
def to_number(digits, :decimal), do: to_decimal(digits)
def to_integer({digits, place, sign}) do
{int_digits, _fraction_digits} = Enum.split(digits, place)
Integer.undigits(int_digits) * sign
end
def to_float({[0], _place, _sign}) do
0.0
end
def to_float({digits, place, sign}) when length(digits) >= place do
Integer.undigits(digits) / power_of_10(length(digits) - place) * sign
end
def to_float({digits, place, sign}) do
Integer.undigits(digits) * power_of_10(place - length(digits)) * sign * 1.0
end
def to_decimal({digits, place, sign}) do
%Decimal{coef: Integer.undigits(digits), exp: place - length(digits), sign: sign}
end
############################################################################
# The following functions are Elixir translations of the original paper:
# "Printing Floating-Point Numbers Quickly and Accurately"
# http://www.cs.tufts.edu/~nr/cs257/archive/florian-loitsch/printf.pdf
# See the paper for further explanation
_ = """
Set initial values {r, s, m+, m-}
based on table 1 from FP-Printing paper
Assumes frac is scaled to integer (and exponent scaled appropriately)
"""
defp flonum(float, frac, exp) do
round = Integer.is_even(frac)
if exp >= 0 do
b_exp = bsl(1, exp)
if frac !== @two52 do
scale(frac * b_exp * 2, 2, b_exp, b_exp, round, round, float)
else
scale(frac * b_exp * 4, 4, b_exp * 2, b_exp, round, round, float)
end
else
if exp === @min_e or frac !== @two52 do
scale(frac * 2, bsl(1, 1 - exp), 1, 1, round, round, float)
else
scale(frac * 4, bsl(1, 2 - exp), 2, 1, round, round, float)
end
end
end
@log_0_approx -60
def scale(r, s, m_plus, m_minus, low_ok, high_ok, float) do
# TODO: Benchmark removing the log10 and using the approximation given in original paper?
est =
if float == 0 do
@log_0_approx
else
trunc(Float.ceil(:math.log10(abs(float)) - 1.0e-10))
end
if est >= 0 do
fixup(r, s * power_of_10(est), m_plus, m_minus, est, low_ok, high_ok, float)
else
scale = power_of_10(-est)
fixup(r * scale, s, m_plus * scale, m_minus * scale, est, low_ok, high_ok, float)
end
end
def fixup(r, s, m_plus, m_minus, k, low_ok, high_ok, float) do
too_low = if high_ok, do: r + m_plus >= s, else: r + m_plus > s
if too_low do
{generate(r, s, m_plus, m_minus, low_ok, high_ok), k + 1, sign(float)}
else
{generate(r * 10, s, m_plus * 10, m_minus * 10, low_ok, high_ok), k, sign(float)}
end
end
defp generate(r, s, m_plus, m_minus, low_ok, high_ok) do
d = div(r, s)
r = rem(r, s)
tc1 = if low_ok, do: r <= m_minus, else: r < m_minus
tc2 = if high_ok, do: r + m_plus >= s, else: r + m_plus > s
if not tc1 do
if not tc2 do
[d | generate(r * 10, s, m_plus * 10, m_minus * 10, low_ok, high_ok)]
else
[d + 1]
end
else
if not tc2 do
[d]
else
if r * 2 < s do
[d]
else
[d + 1]
end
end
end
end
############################################################################
# Utility functions
# FIXME: We don't handle +/-inf and NaN inputs. Not believed to be an issue in
# Elixir, but beware future-self reading this...
# The frexp() function is as per the clib function with the same name. It breaks
# the floating-point number value into a normalized fraction and an integral
# power of 2.
#
# Returns {frac, exp}, where the magnitude of frac is in the interval
# [1/2, 1) or 0, and value = frac*(2^exp).
@doc false
def frexp(value) do
<<sign::1, exp::11, frac::52>> = <<value::float>>
frexp(sign, frac, exp)
end
def frexp(_Sign, 0, 0) do
{0.0, 0}
end
# Handle denormalised values
def frexp(sign, frac, 0) do
exp = bitwise_length(frac)
<<f::float>> = <<sign::1, @float_bias::11, frac - 1::52>>
{f, -@float_bias - 52 + exp}
end
# Handle normalised values
def frexp(sign, frac, exp) do
<<f::float>> = <<sign::1, @float_bias::11, frac::52>>
{f, exp - @float_bias}
end
_ = """
Return the number of significant bits needed to store the given number
"""
defp bitwise_length(value) do
bitwise_length(value, 0)
end
defp bitwise_length(0, n), do: n
defp bitwise_length(value, n), do: bitwise_length(bsr(value, 1), n + 1)
defp sign(float) when float < 0, do: -1
defp sign(_float), do: 1
end