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.27318931957726394
0.16014943640993645
0.003618290234682817
0.11027995856686375
0.12624933132298358
0.09923857373348707
0.00324325481071456
0.0793356034882401
0.42545820274557716
0.5759924311872343
⋮
0.10043177989349604
0.6581139311186996
0.6288979505534886
0.01905321982878035
0.4110039145748627
0.1784552402272058
0.08202099232911264
0.005044131897298222
0.16237751673569695For 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}:
-1.2798210380857176
0.4761891587152365
-0.17360536546379587
0.7898012747500384