From 9f9c83a1f3c08e22d3e894983cfbdaef0adca733 Mon Sep 17 00:00:00 2001
From: Matt Bauman <mbauman@gmail.com>
Date: Mon, 8 Jan 2018 14:19:34 -0500
Subject: [PATCH 1/2] Deprecate diff(::AbstractMatrix), require a dim argument
Akin to `cumsum`, `diff` now requires a `dim` argument in cases where the array has more than one dimension. Final piece of #20041 for the 1.0 milestone.
---
NEWS.md | 5 +++--
base/deprecated.jl | 2 ++
base/linalg/generic.jl | 13 ++++++++++---
test/bitarray.jl | 3 ++-
test/linalg/lapack.jl | 2 +-
5 files changed, 18 insertions(+), 7 deletions(-)
diff --git a/NEWS.md b/NEWS.md
index b512e2c1b363b..9985bd88c739f 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -847,8 +847,9 @@ Deprecated or removed
* `workspace` is discontinued, check out [Revise.jl](https://github.com/timholy/Revise.jl)
for an alternative workflow ([#25046]).
- * `cumsum`, `cumprod`, `accumulate`, and their mutating versions now require a `dim`
- argument instead of defaulting to using the first dimension ([#24684]).
+ * `cumsum`, `cumprod`, `accumulate`, their mutating versions, and `diff` all now require a `dim`
+ argument instead of defaulting to using the first dimension unless there is only
+ one dimension ([#24684]).
* The `sum_kbn` and `cumsum_kbn` functions have been moved to the
[KahanSummation](https://github.com/JuliaMath/KahanSummation.jl) package ([#24869]).
diff --git a/base/deprecated.jl b/base/deprecated.jl
index 9e10f28c8e4ab..17f88f39084c8 100644
--- a/base/deprecated.jl
+++ b/base/deprecated.jl
@@ -2301,6 +2301,8 @@ end
@deprecate cumsum(A::AbstractArray) cumsum(A, 1)
@deprecate cumprod(A::AbstractArray) cumprod(A, 1)
+import .LinAlg: diff
+@deprecate diff(A::AbstractMatrix) diff(A, 1)
# issue #16307
@deprecate finalizer(o, f::Function) finalizer(f, o)
diff --git a/base/linalg/generic.jl b/base/linalg/generic.jl
index 805bc4202c066..cee8de078bd4a 100644
--- a/base/linalg/generic.jl
+++ b/base/linalg/generic.jl
@@ -243,10 +243,11 @@ tril!(M::AbstractMatrix) = tril!(M,0)
diff(a::AbstractVector) = [ a[i+1] - a[i] for i=1:length(a)-1 ]
"""
- diff(A, [dim::Integer=1])
+ diff(A::AbstractVector)
+ diff(A::AbstractMatrix, dim::Integer)
Finite difference operator of matrix or vector `A`. If `A` is a matrix,
-compute the finite difference over a dimension `dim` (default `1`).
+specify the dimension over which to operate with the `dim` argument.
# Examples
```jldoctest
@@ -259,9 +260,15 @@ julia> diff(a,2)
2×1 Array{Int64,2}:
2
10
+
+julia> diff(vec(a))
+3-element Array{Int64,1}:
+ 4
+ -2
+ 12
```
"""
-function diff(A::AbstractMatrix, dim::Integer=1)
+function diff(A::AbstractMatrix, dim::Integer)
if dim == 1
[A[i+1,j] - A[i,j] for i=1:size(A,1)-1, j=1:size(A,2)]
elseif dim == 2
diff --git a/test/bitarray.jl b/test/bitarray.jl
index 549891e1966f6..1742c94e42e96 100644
--- a/test/bitarray.jl
+++ b/test/bitarray.jl
@@ -1406,7 +1406,8 @@ timesofar("cat")
@check_bit_operation diff(b1) Vector{Int}
b1 = bitrand(n1, n2)
- @check_bit_operation diff(b1) Matrix{Int}
+ @check_bit_operation diff(b1, 1) Matrix{Int}
+ @check_bit_operation diff(b1, 2) Matrix{Int}
b1 = bitrand(n1, n1)
@check_bit_operation svd(b1)
diff --git a/test/linalg/lapack.jl b/test/linalg/lapack.jl
index e316e6a0182ac..ca6265e33c1d0 100644
--- a/test/linalg/lapack.jl
+++ b/test/linalg/lapack.jl
@@ -203,7 +203,7 @@ end
Bvs = eigvecs(B)
Avs = eigvecs(A)
Bvs = LAPACK.gebak!('S','R',ilo,ihi,scale,Bvs)
- @test norm(diff(Avs ./ Bvs)) < 100 * eps(abs(float(one(elty))))
+ @test norm(diff(Avs ./ Bvs, 1)) < 100 * eps(abs(float(one(elty))))
end
end
From e2827279bbf357e3935d9772c2a81c58965ec58c Mon Sep 17 00:00:00 2001
From: Matt Bauman <mbauman@gmail.com>
Date: Mon, 8 Jan 2018 14:25:31 -0600
Subject: [PATCH 2/2] Add reference to this PR in NEWS.md
---
NEWS.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/NEWS.md b/NEWS.md
index 9985bd88c739f..6a12ffb157b35 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -849,7 +849,7 @@ Deprecated or removed
* `cumsum`, `cumprod`, `accumulate`, their mutating versions, and `diff` all now require a `dim`
argument instead of defaulting to using the first dimension unless there is only
- one dimension ([#24684]).
+ one dimension ([#24684], [#25457]).
* The `sum_kbn` and `cumsum_kbn` functions have been moved to the
[KahanSummation](https://github.com/JuliaMath/KahanSummation.jl) package ([#24869]).