changed
CHANGELOG.md
|
@@ -1,9 +1,13 @@
|
1
1
|
# CHANGELOG
|
2
2
|
|
3
|
- ## v2.0.0-rc.0 (2020-01-21)
|
3
|
+ ## v2.0.0 (2020-09-08)
|
4
4
|
|
5
5
|
Decimal v2.0 requires Elixir v1.2+.
|
6
6
|
|
7
|
+ ### Enhancements
|
8
|
+
|
9
|
+ * Add `Decimal.integer?/1`
|
10
|
+
|
7
11
|
### Breaking changes
|
8
12
|
|
9
13
|
* Change `Decimal.compare/2` to return `:lt | :eq | :gt`
|
|
@@ -18,13 +22,13 @@ Decimal v2.0 requires Elixir v1.2+.
|
18
22
|
* Remove deprecated `Decimal.reduce/1`
|
19
23
|
* Remove deprecated `Decimal.with_context/2`, `Decimal.get_context/1`, `Decimal.set_context/1`,
|
20
24
|
and `Decimal.update_context/1`
|
21
|
- * Remove deprecated `Decimal.decimal?/1
|
25
|
+ * Remove deprecated `Decimal.decimal?/1`
|
22
26
|
|
23
27
|
### Deprecations
|
24
28
|
|
25
29
|
* Deprecate `Decimal.cmp/2`
|
26
30
|
|
27
|
- ## v1.9.0-rc.0 (2020-01-07)
|
31
|
+ ## v1.9.0 (2020-09-08)
|
28
32
|
|
29
33
|
### Enhancements
|
added
LICENSE.txt
|
@@ -0,0 +1,176 @@
|
1
|
+ Apache License
|
2
|
+ Version 2.0, January 2004
|
3
|
+ https://www.apache.org/licenses/
|
4
|
+
|
5
|
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+ 1. Definitions.
|
8
|
+
|
9
|
+ "License" shall mean the terms and conditions for use, reproduction,
|
10
|
+ and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+ "Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+ the copyright owner that is granting the License.
|
14
|
+
|
15
|
+ "Legal Entity" shall mean the union of the acting entity and all
|
16
|
+ other entities that control, are controlled by, or are under common
|
17
|
+ control with that entity. For the purposes of this definition,
|
18
|
+ "control" means (i) the power, direct or indirect, to cause the
|
19
|
+ direction or management of such entity, whether by contract or
|
20
|
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+ outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+ "You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+ exercising permissions granted by this License.
|
25
|
+
|
26
|
+ "Source" form shall mean the preferred form for making modifications,
|
27
|
+ including but not limited to software source code, documentation
|
28
|
+ source, and configuration files.
|
29
|
+
|
30
|
+ "Object" form shall mean any form resulting from mechanical
|
31
|
+ transformation or translation of a Source form, including but
|
32
|
+ not limited to compiled object code, generated documentation,
|
33
|
+ and conversions to other media types.
|
34
|
+
|
35
|
+ "Work" shall mean the work of authorship, whether in Source or
|
36
|
+ Object form, made available under the License, as indicated by a
|
37
|
+ copyright notice that is included in or attached to the work
|
38
|
+ (an example is provided in the Appendix below).
|
39
|
+
|
40
|
+ "Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+ form, that is based on (or derived from) the Work and for which the
|
42
|
+ editorial revisions, annotations, elaborations, or other modifications
|
43
|
+ represent, as a whole, an original work of authorship. For the purposes
|
44
|
+ of this License, Derivative Works shall not include works that remain
|
45
|
+ separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+ the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+ "Contribution" shall mean any work of authorship, including
|
49
|
+ the original version of the Work and any modifications or additions
|
50
|
+ to that Work or Derivative Works thereof, that is intentionally
|
51
|
+ submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+ or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+ the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+ means any form of electronic, verbal, or written communication sent
|
55
|
+ to the Licensor or its representatives, including but not limited to
|
56
|
+ communication on electronic mailing lists, source code control systems,
|
57
|
+ and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+ Licensor for the purpose of discussing and improving the Work, but
|
59
|
+ excluding communication that is conspicuously marked or otherwise
|
60
|
+ designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+ "Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+ on behalf of whom a Contribution has been received by Licensor and
|
64
|
+ subsequently incorporated within the Work.
|
65
|
+
|
66
|
+ 2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+ this License, each Contributor hereby grants to You a perpetual,
|
68
|
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+ copyright license to reproduce, prepare Derivative Works of,
|
70
|
+ publicly display, publicly perform, sublicense, and distribute the
|
71
|
+ Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+ 3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+ this License, each Contributor hereby grants to You a perpetual,
|
75
|
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+ (except as stated in this section) patent license to make, have made,
|
77
|
+ use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+ where such license applies only to those patent claims licensable
|
79
|
+ by such Contributor that are necessarily infringed by their
|
80
|
+ Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+ with the Work to which such Contribution(s) was submitted. If You
|
82
|
+ institute patent litigation against any entity (including a
|
83
|
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+ or a Contribution incorporated within the Work constitutes direct
|
85
|
+ or contributory patent infringement, then any patent licenses
|
86
|
+ granted to You under this License for that Work shall terminate
|
87
|
+ as of the date such litigation is filed.
|
88
|
+
|
89
|
+ 4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+ Work or Derivative Works thereof in any medium, with or without
|
91
|
+ modifications, and in Source or Object form, provided that You
|
92
|
+ meet the following conditions:
|
93
|
+
|
94
|
+ (a) You must give any other recipients of the Work or
|
95
|
+ Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+ (b) You must cause any modified files to carry prominent notices
|
98
|
+ stating that You changed the files; and
|
99
|
+
|
100
|
+ (c) You must retain, in the Source form of any Derivative Works
|
101
|
+ that You distribute, all copyright, patent, trademark, and
|
102
|
+ attribution notices from the Source form of the Work,
|
103
|
+ excluding those notices that do not pertain to any part of
|
104
|
+ the Derivative Works; and
|
105
|
+
|
106
|
+ (d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+ distribution, then any Derivative Works that You distribute must
|
108
|
+ include a readable copy of the attribution notices contained
|
109
|
+ within such NOTICE file, excluding those notices that do not
|
110
|
+ pertain to any part of the Derivative Works, in at least one
|
111
|
+ of the following places: within a NOTICE text file distributed
|
112
|
+ as part of the Derivative Works; within the Source form or
|
113
|
+ documentation, if provided along with the Derivative Works; or,
|
114
|
+ within a display generated by the Derivative Works, if and
|
115
|
+ wherever such third-party notices normally appear. The contents
|
116
|
+ of the NOTICE file are for informational purposes only and
|
117
|
+ do not modify the License. You may add Your own attribution
|
118
|
+ notices within Derivative Works that You distribute, alongside
|
119
|
+ or as an addendum to the NOTICE text from the Work, provided
|
120
|
+ that such additional attribution notices cannot be construed
|
121
|
+ as modifying the License.
|
122
|
+
|
123
|
+ You may add Your own copyright statement to Your modifications and
|
124
|
+ may provide additional or different license terms and conditions
|
125
|
+ for use, reproduction, or distribution of Your modifications, or
|
126
|
+ for any such Derivative Works as a whole, provided Your use,
|
127
|
+ reproduction, and distribution of the Work otherwise complies with
|
128
|
+ the conditions stated in this License.
|
129
|
+
|
130
|
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+ any Contribution intentionally submitted for inclusion in the Work
|
132
|
+ by You to the Licensor shall be under the terms and conditions of
|
133
|
+ this License, without any additional terms or conditions.
|
134
|
+ Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+ the terms of any separate license agreement you may have executed
|
136
|
+ with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+ 6. Trademarks. This License does not grant permission to use the trade
|
139
|
+ names, trademarks, service marks, or product names of the Licensor,
|
140
|
+ except as required for reasonable and customary use in describing the
|
141
|
+ origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+ 7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+ agreed to in writing, Licensor provides the Work (and each
|
145
|
+ Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+ implied, including, without limitation, any warranties or conditions
|
148
|
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+ PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+ appropriateness of using or redistributing the Work and assume any
|
151
|
+ risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+ 8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+ whether in tort (including negligence), contract, or otherwise,
|
155
|
+ unless required by applicable law (such as deliberate and grossly
|
156
|
+ negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+ liable to You for damages, including any direct, indirect, special,
|
158
|
+ incidental, or consequential damages of any character arising as a
|
159
|
+ result of this License or out of the use or inability to use the
|
160
|
+ Work (including but not limited to damages for loss of goodwill,
|
161
|
+ work stoppage, computer failure or malfunction, or any and all
|
162
|
+ other commercial damages or losses), even if such Contributor
|
163
|
+ has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+ 9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+ the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+ and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+ or other liability obligations and/or rights consistent with this
|
169
|
+ License. However, in accepting such obligations, You may act only
|
170
|
+ on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+ of any other Contributor, and only if You agree to indemnify,
|
172
|
+ defend, and hold each Contributor harmless for any liability
|
173
|
+ incurred by, or claims asserted against, such Contributor by reason
|
174
|
+ of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+ END OF TERMS AND CONDITIONS
|
changed
README.md
|
@@ -4,15 +4,13 @@
|
4
4
|
|
5
5
|
Arbitrary precision decimal arithmetic.
|
6
6
|
|
7
|
- Documentation: https://hexdocs.pm/decimal/
|
8
|
-
|
9
7
|
## Usage
|
10
8
|
|
11
9
|
Add Decimal as a dependency in your `mix.exs` file.
|
12
10
|
|
13
11
|
```elixir
|
14
12
|
def deps do
|
15
|
- [{:decimal, "~> 1.0"}]
|
13
|
+ [{:decimal, "~> 2.0"}]
|
16
14
|
end
|
17
15
|
```
|
18
16
|
|
|
@@ -96,11 +94,11 @@ Using compare operators (`<`, `=`, `>`) directly with two decimals may not retur
|
96
94
|
the correct result. Instead use comparison functions.
|
97
95
|
|
98
96
|
```elixir
|
99
|
- iex> D.cmp(-1, 0)
|
97
|
+ iex> D.compare(-1, 0)
|
100
98
|
:lt
|
101
|
- iex> D.cmp(0, -1)
|
99
|
+ iex> D.compare(0, -1)
|
102
100
|
:gt
|
103
|
- iex> D.cmp(0, 0)
|
101
|
+ iex> D.compare(0, 0)
|
104
102
|
:eq
|
105
103
|
|
106
104
|
iex> D.equal?(-1, 0)
|
changed
hex_metadata.config
|
@@ -6,9 +6,9 @@
|
6
6
|
[<<"lib">>,<<"lib/decimal">>,<<"lib/decimal/error.ex">>,
|
7
7
|
<<"lib/decimal/context.ex">>,<<"lib/decimal/macros.ex">>,
|
8
8
|
<<"lib/decimal.ex">>,<<".formatter.exs">>,<<"mix.exs">>,<<"README.md">>,
|
9
|
- <<"CHANGELOG.md">>]}.
|
9
|
+ <<"LICENSE.txt">>,<<"CHANGELOG.md">>]}.
|
10
10
|
{<<"licenses">>,[<<"Apache-2.0">>]}.
|
11
11
|
{<<"links">>,[{<<"GitHub">>,<<"https://github.com/ericmj/decimal">>}]}.
|
12
12
|
{<<"name">>,<<"decimal">>}.
|
13
13
|
{<<"requirements">>,[]}.
|
14
|
- {<<"version">>,<<"2.0.0-rc.0">>}.
|
14
|
+ {<<"version">>,<<"2.0.0">>}.
|
changed
lib/decimal.ex
|
@@ -23,7 +23,7 @@ defmodule Decimal do
|
23
23
|
## Specifications
|
24
24
|
|
25
25
|
* [IBM's General Decimal Arithmetic Specification](https://speleotrove.com/decimal/decarith.html)
|
26
|
- * [IEEE standard 854-1987](https://754r.ucbtest.org/standards/854.pdf)
|
26
|
+ * [IEEE standard 854-1987](https://web.archive.org/web/20150908012941/https://754r.ucbtest.org/standards/854.pdf)
|
27
27
|
|
28
28
|
This library follows the above specifications for reference of arithmetic
|
29
29
|
operation implementations, but the public APIs may differ to provide a
|
|
@@ -156,7 +156,7 @@ defmodule Decimal do
|
156
156
|
nil ->
|
157
157
|
quote do
|
158
158
|
case unquote(term) do
|
159
|
- %_{} -> true
|
159
|
+ %Decimal{} -> true
|
160
160
|
_ -> false
|
161
161
|
end
|
162
162
|
end
|
|
@@ -285,7 +285,7 @@ defmodule Decimal do
|
285
285
|
:gt
|
286
286
|
|
287
287
|
"""
|
288
|
- @spec compare(decimal, decimal) :: t
|
288
|
+ @spec compare(decimal, decimal) :: :lt | :gt | :eq
|
289
289
|
def compare(%Decimal{coef: :inf, sign: sign}, %Decimal{coef: :inf, sign: sign}),
|
290
290
|
do: :eq
|
291
291
|
|
|
@@ -1080,7 +1080,10 @@ defmodule Decimal do
|
1080
1080
|
#Decimal<3.14>
|
1081
1081
|
"""
|
1082
1082
|
@spec new(decimal) :: t
|
1083
|
- def new(%Decimal{} = num), do: num
|
1083
|
+ def new(%Decimal{sign: sign, coef: coef, exp: exp} = num)
|
1084
|
+ when sign in [1, -1] and ((is_integer(coef) and coef >= 0) or coef in [:NaN, :inf]) and
|
1085
|
+ is_integer(exp),
|
1086
|
+ do: num
|
1084
1087
|
|
1085
1088
|
def new(int) when is_integer(int),
|
1086
1089
|
do: %Decimal{sign: if(int < 0, do: -1, else: 1), coef: Kernel.abs(int)}
|
|
@@ -1388,6 +1391,30 @@ defmodule Decimal do
|
1388
1391
|
tmp
|
1389
1392
|
end
|
1390
1393
|
|
1394
|
+ @doc """
|
1395
|
+ Returns `true` when the given `decimal` has no significant digits after the decimal point.
|
1396
|
+
|
1397
|
+ ## Examples
|
1398
|
+
|
1399
|
+ iex> Decimal.integer?("1.00")
|
1400
|
+ true
|
1401
|
+
|
1402
|
+ iex> Decimal.integer?("1.10")
|
1403
|
+ false
|
1404
|
+ """
|
1405
|
+ doc_since("2.0.0")
|
1406
|
+ @spec integer?(t) :: boolean
|
1407
|
+ def integer?(%Decimal{coef: :NaN}), do: false
|
1408
|
+ def integer?(%Decimal{coef: :inf}), do: false
|
1409
|
+ def integer?(%Decimal{coef: coef, exp: exp}), do: exp >= 0 or zero_after_dot?(coef, exp)
|
1410
|
+ def integer?(num), do: integer?(decimal(num))
|
1411
|
+
|
1412
|
+ defp zero_after_dot?(coef, exp) when coef >= 10 and exp < 0,
|
1413
|
+ do: Kernel.rem(coef, 10) == 0 and zero_after_dot?(Kernel.div(coef, 10), exp + 1)
|
1414
|
+
|
1415
|
+ defp zero_after_dot?(_coef, exp),
|
1416
|
+ do: exp == 0
|
1417
|
+
|
1391
1418
|
## ARITHMETIC ##
|
1392
1419
|
|
1393
1420
|
defp add_align(coef1, exp1, coef2, exp2) when exp1 == exp2, do: {coef1, coef2}
|
|
@@ -1487,7 +1514,7 @@ defmodule Decimal do
|
1487
1514
|
|
1488
1515
|
defp pow10(num) when num > 104, do: pow10(104) * pow10(num - 104)
|
1489
1516
|
|
1490
|
- defp base10?(num) when num > unquote(pow10_max) do
|
1517
|
+ defp base10?(num) when num >= unquote(pow10_max) do
|
1491
1518
|
if Kernel.rem(num, unquote(pow10_max)) == 0 do
|
1492
1519
|
base10?(Kernel.div(num, unquote(pow10_max)))
|
1493
1520
|
else
|
changed
mix.exs
|
@@ -1,7 +1,8 @@
|
1
1
|
defmodule Decimal.Mixfile do
|
2
2
|
use Mix.Project
|
3
3
|
|
4
|
- @version "2.0.0-rc.0"
|
4
|
+ @version "2.0.0"
|
5
|
+ @source_url "https://github.com/ericmj/decimal"
|
5
6
|
|
6
7
|
def project() do
|
7
8
|
[
|
|
@@ -10,7 +11,7 @@ defmodule Decimal.Mixfile do
|
10
11
|
elixir: "~> 1.2",
|
11
12
|
deps: deps(),
|
12
13
|
name: "Decimal",
|
13
|
- source_url: "https://github.com/ericmj/decimal",
|
14
|
+ source_url: @source_url,
|
14
15
|
docs: [source_ref: "v#{@version}", main: "readme", extras: ["README.md"]],
|
15
16
|
description: description(),
|
16
17
|
package: package()
|
|
@@ -35,7 +36,7 @@ defmodule Decimal.Mixfile do
|
35
36
|
[
|
36
37
|
maintainers: ["Eric Meadows-Jönsson"],
|
37
38
|
licenses: ["Apache-2.0"],
|
38
|
- links: %{"GitHub" => "https://github.com/ericmj/decimal"}
|
39
|
+ links: %{"GitHub" => @source_url}
|
39
40
|
]
|
40
41
|
end
|
41
42
|
end
|