Rename checked_rdiv; reexport checked*

Author: NHDaly

src/FixedPointDecimals.jl

@@ -27,6 +27,13 @@ module FixedPointDecimals
 
 export FixedDecimal, RoundThrows
 
+# (Re)export checked_* arithmetic functions
+# - Defined in this package:
+export checked_rdiv
+# - Reexported from Base:
+export checked_abs, checked_add, checked_cld, checked_div, checked_fld,
+    checked_mod, checked_mul, checked_neg, checked_rem, checked_sub
+
 using Base: decompose, BitInteger
 import Parsers
 
@@ -463,7 +470,7 @@ end
 # We introduce a new function for this since Base.Checked only supports integers, and ints
 # don't have a decimal division operation.
 """
-    FixedPointDecimals.checked_decimal_division(x::FD, y::FD) -> FD
+    FixedPointDecimals.checked_rdiv(x::FD, y::FD) -> FD
 
 Calculates `x / y`, checking for overflow errors where applicable.
 
@@ -472,11 +479,11 @@ The overflow protection may impose a perceptible performance penalty.
 See also:
 - `Base.checked_div` for truncating division.
 """
-checked_decimal_division(x::FD, y::FD) = checked_decimal_division(promote(x, y)...)
-checked_decimal_division(x, y::FD) = checked_decimal_division(promote(x, y)...)
-checked_decimal_division(x::FD, y) = checked_decimal_division(promote(x, y)...)
+checked_rdiv(x::FD, y::FD) = checked_rdiv(promote(x, y)...)
+checked_rdiv(x, y::FD) = checked_rdiv(promote(x, y)...)
+checked_rdiv(x::FD, y) = checked_rdiv(promote(x, y)...)
 
-function checked_decimal_division(x::FD{T,f}, y::FD{T,f}) where {T<:Integer,f}
+function checked_rdiv(x::FD{T,f}, y::FD{T,f}) where {T<:Integer,f}
     powt = coefficient(FD{T, f})
     quotient, remainder = fldmod(widemul(x.i, powt), y.i)
     v = _round_to_nearest(quotient, remainder, y.i)

test/FixedDecimal.jl

@@ -643,11 +643,11 @@ end
         @test_throws OverflowError Base.checked_div(1, FD{Int8,2}(0.5))
         @test_throws OverflowError Base.checked_div(FD{Int8,2}(1), FD{Int8,2}(0.4))
 
-        @testset "checked_decimal_division" begin
-            using FixedPointDecimals: checked_decimal_division
+        @testset "checked_rdiv" begin
+            using FixedPointDecimals: checked_rdiv
 
-            @test checked_decimal_division(Int8(1), FD{Int8,2}(0.8)) == FD{Int8,2}(1.25)
-            @test_throws OverflowError checked_decimal_division(Int8(1), FD{Int8,2}(0.7))
+            @test checked_rdiv(Int8(1), FD{Int8,2}(0.8)) == FD{Int8,2}(1.25)
+            @test_throws OverflowError checked_rdiv(Int8(1), FD{Int8,2}(0.7))
         end
 
         # Rounds down to -2
@@ -722,7 +722,7 @@ end
             @testset for op in (
                 Base.checked_add, Base.checked_sub, Base.checked_mul, Base.checked_div,
                 Base.checked_cld, Base.checked_fld, Base.checked_rem, Base.checked_mod,
-                FixedPointDecimals.checked_decimal_division,
+                FixedPointDecimals.checked_rdiv,
             )
                 @test op(x, y) === op(FD{Int64,1}(1), y)
                 @test op(y, x) === op(y, FD{Int64,1}(1))