Fix some divexact methods to pass check as kwarg, not positional

thofma · Dec 22, 2023 · f73db83 · f73db83
1 parent 473fe80
commit f73db83
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 12 deletions.
diff --git a/src/AlgAssAbsOrd/Elem.jl b/src/AlgAssAbsOrd/Elem.jl
@@ -227,26 +227,26 @@ function divexact(a::T, b::T, action::Symbol, check::Bool = true) where { T <: U
 end
 
 @doc raw"""
-    divexact_right(a::AlgAssAbsOrdElem, b::AlgAssAbsOrdElem, check::Bool = true)
-    divexact_right(a::AlgAssRelOrdElem, b::AlgAssRelOrdElem, check::Bool = true)
+    divexact_right(a::AlgAssAbsOrdElem, b::AlgAssAbsOrdElem; check::Bool = true)
+    divexact_right(a::AlgAssRelOrdElem, b::AlgAssRelOrdElem; check::Bool = true)
       -> AlgAssRelOrdElem
 
 Returns an element $c \in O$ such that $a = c \cdot b$ where $O$ is the order
 containing $a$.
 If `check` is `false`, it is not checked whether $c$ is an element of $O$.
 """
-divexact_right(a::T, b::T, check::Bool = true) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } = divexact(a, b, :right, check)
+divexact_right(a::T, b::T; check::Bool = true) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } = divexact(a, b, :right, check)
 
 @doc raw"""
-    divexact_left(a::AlgAssAbsOrdElem, b::AlgAssAbsOrdElem, check::Bool = true)
-    divexact_left(a::AlgAssRelOrdElem, b::AlgAssRelOrdElem, check::Bool = true)
+    divexact_left(a::AlgAssAbsOrdElem, b::AlgAssAbsOrdElem; check::Bool = true)
+    divexact_left(a::AlgAssRelOrdElem, b::AlgAssRelOrdElem; check::Bool = true)
       -> AlgAssRelOrdElem
 
 Returns an element $c \in O$ such that $a = b \cdot c$ where $O$ is the order
 containing $a$.
 If `check` is `false`, it is not checked whether $c$ is an element of $O$.
 """
-divexact_left(a::T, b::T, check::Bool = true) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } = divexact(a, b, :left, check)
+divexact_left(a::T, b::T; check::Bool = true) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } = divexact(a, b, :left, check)
 
 ################################################################################
 #

diff --git a/src/Deprecations.jl b/src/Deprecations.jl
@@ -127,6 +127,14 @@
 
 @deprecate field_of_fractions(O::GenOrd) function_field(O::GenOrd)
 
+# Deprecated during 0.23.*
+
+@deprecate divexact_right(a::T, b::T, check::Bool) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } divexact(a, b, :right, check)
+@deprecate divexact_left(a::T, b::T, check::Bool) where { T <: Union{ AlgAssAbsOrdElem, AlgAssRelOrdElem } } divexact(a, b, :left, check)
+@deprecate divexact(a::NumFieldOrdElem, b::Integer, check::Bool) divexact(a, b; check=check)
+@deprecate divexact(a::NumFieldOrdElem, b::ZZRingElem, check::Bool) divexact(a, b; check=check)
+@deprecate divexact(x::T, y::T, check::Bool) where T <: NumFieldOrdElem divexact(x, y; check=check)
+
 # Things that moved to Nemo
 
 # > 0.18.1

diff --git a/src/NumFieldOrd/NumFieldOrdElem.jl b/src/NumFieldOrd/NumFieldOrdElem.jl
@@ -117,7 +117,7 @@ function -(x::T, y::T) where T <: NumFieldOrdElem
   return z
 end
 
-function divexact(x::T, y::T, check::Bool = true) where T <: NumFieldOrdElem
+function divexact(x::T, y::T; check::Bool = true) where T <: NumFieldOrdElem
   !check_parent(x, y) && error("Wrong parents")
   a = divexact(x.elem_in_nf, y.elem_in_nf)
   if check
@@ -174,7 +174,7 @@ for T in [Integer, ZZRingElem]
       return z
     end
 
-    function divexact(a::NumFieldOrdElem, b::$T, check::Bool = true)
+    function divexact(a::NumFieldOrdElem, b::$T; check::Bool = true)
       t = divexact(a.elem_in_nf, b)
       if check
         if !in(t, parent(a))

diff --git a/test/NfOrd/Elem.jl b/test/NfOrd/Elem.jl
@@ -133,10 +133,10 @@
     c = @inferred divexact(O1(a1^2), O1(a1))
     @test c == O1(a1)
 
-    c = @inferred divexact(O1(a1^2), O1(a1), true)
+    c = @inferred divexact(O1(a1^2), O1(a1); check=true)
     @test c == O1(a1)
 
-    c = @inferred divexact(O1(a1^2), O1(a1), false)
+    c = @inferred divexact(O1(a1^2), O1(a1); check=false)
     @test c == O1(a1)
 
     @test_throws ErrorException divexact(O1(1), O1(2))
@@ -191,9 +191,9 @@
     @test c == O1(a1)
     c = @inferred divexact(b, ZZRingElem(2))
     @test c == O1(a1)
-    c = @inferred divexact(b, ZZRingElem(2), true)
+    c = @inferred divexact(b, ZZRingElem(2); check=true)
     @test c == O1(a1)
-    c = @inferred divexact(b, ZZRingElem(2), false)
+    c = @inferred divexact(b, ZZRingElem(2); check=false)
     @test c == O1(a1)
 
     @test_throws ErrorException divexact(b, O1(4*a1))