Demonstration of Operator Algebras and Kron
Let M, D, F be matrix-based, diagonal-matrix-based, and function-based SciMLOperators respectively. Here are some examples of composing operators in order to build more complex objects and using their operations.
using SciMLOperators, LinearAlgebra
N = 4
function f(v, u, p, t)
u .* v
end
function f(w, v, u, p, t)
w .= u .* v
end
u = rand(4)
p = nothing # parameter struct
t = 0.0 # time
M = MatrixOperator(rand(N, N))
D = DiagonalOperator(rand(N))
F = FunctionOperator(f, zeros(N), zeros(N); u, p, t)FunctionOperator(4 × 4)Then, the following codes just work.
L1 = 2M + 3F + LinearAlgebra.I + rand(N, N)
L2 = D * F * M'
L3 = kron(M, D, F)
L4 = lu(M) \ D
L5 = [M; D]' * [M F; F D] * [F; D]((((MatrixOperator(4 × 4) * MatrixOperator(4 × 4)) + (DiagonalOperator(4 × 4) * FunctionOperator(4 × 4))) * FunctionOperator(4 × 4)) + (((MatrixOperator(4 × 4) * FunctionOperator(4 × 4)) + (DiagonalOperator(4 × 4) * DiagonalOperator(4 × 4))) * DiagonalOperator(4 × 4)))Each L# can be applied to AbstractVectors of appropriate sizes:
v = rand(N)
w = L1(v, u, p, t) # == L1 * v
v_kron = rand(N^3)
w_kron = L3(v_kron, u, p, t) # == L3 * v_kron64-element reshape(transpose(::Matrix{Float64}), 64) with eltype Float64:
0.4192124046129998
0.8068151221168005
0.46247188432847114
0.09144199990031103
0.05711819747792267
0.20955723855959912
0.09565303155263276
0.05026429773940661
0.09460029996859927
0.15488447607774633
⋮
0.039392713815825334
0.09316956936517133
0.18871421441779737
0.10870065431653739
0.08279298465512411
0.13013209093855474
0.22552319535221532
0.20275201068504128
0.17861172529046412For mutating operator evaluations, call cache_operator to generate an in-place cache, so the operation is nonallocating.
α, β = rand(2)
# allocate cache
L2 = cache_operator(L2, u)
L4 = cache_operator(L4, u)
# allocation-free evaluation
L2(w, v, u, p, t) # == mul!(w, L2, v)
L4(w, v, u, p, t, α, β) # == mul!(w, L4, v, α, β)4-element Vector{Float64}:
0.16757894748590216
-0.27869825576171964
-0.1440943924253963
0.6745691181537893