Merge pull request #302 from ChrisRackauckas-Claude/add-copy-overloads

Add copy overloads to prevent aliasing for all operators

Author: ChrisRackauckas

src/basic.jl

@@ -16,6 +16,9 @@ end
 
 Base.convert(::Type{AbstractMatrix}, ii::IdentityOperator) = Diagonal(ones(Bool, ii.len))
 
+# Copy method to avoid aliasing - IdentityOperator has no mutable fields, can return self
+Base.copy(L::IdentityOperator) = L
+
 # traits
 Base.show(io::IO, ii::IdentityOperator) = print(io, "IdentityOperator($(ii.len))")
 Base.size(ii::IdentityOperator) = (ii.len, ii.len)
@@ -131,6 +134,9 @@ end
 
 Base.convert(::Type{AbstractMatrix}, nn::NullOperator) = Diagonal(zeros(Bool, nn.len))
 
+# Copy method to avoid aliasing - NullOperator has no mutable fields, can return self
+Base.copy(L::NullOperator) = L
+
 # traits
 Base.show(io::IO, nn::NullOperator) = print(io, "NullOperator($(nn.len))")
 Base.size(nn::NullOperator) = (nn.len, nn.len)
@@ -775,6 +781,15 @@ function update_coefficients(L::ComposedOperator, u, p, t)
 end
 
 getops(L::ComposedOperator) = L.ops
+
+# Copy method to avoid aliasing
+function Base.copy(L::ComposedOperator)
+    ComposedOperator(
+        map(copy, L.ops),
+        L.cache === nothing ? nothing : deepcopy(L.cache)
+    )
+end
+
 islinear(L::ComposedOperator) = all(islinear, L.ops)
 Base.iszero(L::ComposedOperator) = all(iszero, getops(L))
 has_adjoint(L::ComposedOperator) = all(has_adjoint, L.ops)
@@ -1015,6 +1030,14 @@ has_ldiv!(L::InvertedOperator) = has_mul!(L.L)
 Base.:*(L::InvertedOperator, u::AbstractVecOrMat) = L.L \ u
 Base.:\(L::InvertedOperator, u::AbstractVecOrMat) = L.L * u
 
+# Copy method to avoid aliasing
+function Base.copy(L::InvertedOperator)
+    InvertedOperator(
+        copy(L.L),
+        L.cache === nothing ? nothing : deepcopy(L.cache)
+    )
+end
+
 function cache_self(L::InvertedOperator, u::AbstractVecOrMat)
     cache = zero(u)
     @reset L.cache = cache

src/batch.jl

@@ -107,6 +107,15 @@ end
 
 getops(L::BatchedDiagonalOperator) = (L.diag,)
 
+# Copy method to avoid aliasing
+function Base.copy(L::BatchedDiagonalOperator)
+    BatchedDiagonalOperator(
+        copy(L.diag),
+        L.update_func,
+        L.update_func!
+    )
+end
+
 function isconstant(L::BatchedDiagonalOperator)
     update_func_isconstant(L.update_func) & update_func_isconstant(L.update_func!)
 end

src/func.jl

@@ -439,6 +439,23 @@ function iscached(L::FunctionOperator)
     L.cache !== nothing
 end
 
+# Copy method to avoid aliasing
+function Base.copy(L::FunctionOperator)
+    FunctionOperator(
+        L.op,
+        L.op_adjoint,
+        L.op_inverse,
+        L.op_adjoint_inverse,
+        L.traits,
+        isdefined(L, :u) ? copy(L.u) : nothing,
+        isdefined(L, :p) ? deepcopy(L.p) : nothing,
+        L.t,
+        L.cache === nothing ? nothing : deepcopy(L.cache),
+        typeof(L).parameters[end-1],  # iType
+        typeof(L).parameters[end]      # oType
+    )
+end
+
 # fix method amg bw AbstractArray, AbstractVecOrMat
 cache_operator(L::FunctionOperator, u::AbstractArray) = _cache_operator(L, u)
 cache_operator(L::FunctionOperator, u::AbstractVecOrMat) = _cache_operator(L, u)

src/left.jl

@@ -106,6 +106,9 @@ for (op, LType, VType) in ((:adjoint, :AdjointOperator, :AbstractAdjointVecOrMat
 
     @eval getops(L::$LType) = (L.L,)
 
+    # Copy method to avoid aliasing
+    @eval Base.copy(L::$LType) = $LType(copy(L.L))
+
     @eval @forward $LType.L (
         # LinearAlgebra
         LinearAlgebra.issymmetric,

src/matrix.jl

@@ -405,6 +405,15 @@ function update_coefficients!(L::InvertibleOperator, u, p, t; kwargs...)
 end
 
 getops(L::InvertibleOperator) = (L.L, L.F)
+
+# Copy method to avoid aliasing
+function Base.copy(L::InvertibleOperator)
+    InvertibleOperator(
+        copy(L.L),
+        copy(L.F)
+    )
+end
+
 islinear(L::InvertibleOperator) = islinear(L.L)
 isconvertible(L::InvertibleOperator) = isconvertible(L.L)
 
@@ -618,6 +627,17 @@ function update_coefficients!(L::AffineOperator, u, p, t; kwargs...)
     nothing
 end
 
+# Copy method to avoid aliasing
+function Base.copy(L::AffineOperator)
+    AffineOperator(
+        copy(L.A),
+        copy(L.B),
+        copy(L.b);
+        update_func = L.update_func,
+        update_func! = L.update_func!
+    )
+end
+
 function isconstant(L::AffineOperator)
     update_func_isconstant(L.update_func) &
     update_func_isconstant(L.update_func!) &

src/scalar.jl

@@ -206,6 +206,11 @@ function SciMLOperators.update_coefficients(L::ScalarOperator, u, p, t; kwargs..
     return ScalarOperator(L.update_func(L.val, u, p, t; kwargs...), L.update_func)
 end
 
+# Copy method to avoid aliasing
+function Base.copy(L::ScalarOperator)
+    ScalarOperator(L.val, L.update_func)
+end
+
 # Add ScalarOperator specific implementations for the new interface
 function (α::ScalarOperator)(v::AbstractArray, u, p, t; kwargs...)
     α = update_coefficients(α, u, p, t; kwargs...)
@@ -313,6 +318,12 @@ function (α::AddedScalarOperator)(
 end
 
 getops(α::AddedScalarOperator) = α.ops
+
+# Copy method to avoid aliasing
+function Base.copy(L::AddedScalarOperator)
+    AddedScalarOperator(map(copy, L.ops))
+end
+
 has_ldiv(α::AddedScalarOperator) = !iszero(convert(Number, α))
 has_ldiv!(α::AddedScalarOperator) = has_ldiv(α)
 
@@ -432,6 +443,12 @@ function (α::ComposedScalarOperator)(
 end
 
 getops(α::ComposedScalarOperator) = α.ops
+
+# Copy method to avoid aliasing
+function Base.copy(L::ComposedScalarOperator)
+    ComposedScalarOperator(map(copy, L.ops))
+end
+
 has_ldiv(α::ComposedScalarOperator) = all(has_ldiv, α.ops)
 has_ldiv!(α::ComposedScalarOperator) = all(has_ldiv!, α.ops)
 
@@ -506,6 +523,12 @@ function (α::InvertedScalarOperator)(
     mul!(w, α, v, a, b)
 end
 getops(α::InvertedScalarOperator) = (α.λ,)
+
+# Copy method to avoid aliasing
+function Base.copy(L::InvertedScalarOperator)
+    InvertedScalarOperator(copy(L.λ))
+end
+
 has_ldiv(α::InvertedScalarOperator) = has_mul(α.λ)
 has_ldiv!(α::InvertedScalarOperator) = has_ldiv(α)
 #

src/tensor.jl

@@ -151,6 +151,15 @@ function update_coefficients(L::TensorProductOperator, u, p, t)
 end
 
 getops(L::TensorProductOperator) = L.ops
+
+# Copy method to avoid aliasing
+function Base.copy(L::TensorProductOperator)
+    TensorProductOperator(
+        map(copy, L.ops),
+        L.cache === nothing ? nothing : deepcopy(L.cache)
+    )
+end
+
 islinear(L::TensorProductOperator) = reduce(&, islinear.(L.ops))
 isconvertible(::TensorProductOperator) = false
 Base.iszero(L::TensorProductOperator) = reduce(|, iszero.(L.ops))