Add support for in-place interface

The wrapped vectors or operators can now be StaticArrays

.github/workflows/CI.yml

@@ -3,20 +3,16 @@ on:
   push:
     branches:
       - master
+      - dev
       - 'release-*'
     tags:
       - '*'
   pull_request:
     branches:
-    - master
+      - master
 env:
   GKSwstype: 100
   JULIA_PKG_PRECOMPILE_AUTO: false
-concurrency:
-  # Skip intermediate builds: always.
-  # Cancel intermediate builds: only if it is a pull request build.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 jobs:
   test:
     name: Test ${{ matrix.title }}
@@ -25,66 +21,54 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - title: 'Linux - latest'
+          - title: 'Linux - Latest'
             os: ubuntu-latest
             version: '1'
-            arch: x64
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-          arch: ${{ matrix.arch }}
-      - uses: julia-actions/cache@v1
-      - run: |
-          # Instantiate Pkg
+      - uses: julia-actions/cache@v2
+      - name: "Instantiate test environment"
+        run: |
           wget https://raw.githubusercontent.com/JuliaQuantumControl/JuliaQuantumControl/master/scripts/installorg.jl
           julia --project=test installorg.jl
-      - run: |
-          # Run tests
-          julia --project=test --color=auto --startup-file=yes --code-coverage="user" --depwarn="yes" --check-bounds="yes" -e 'include("test/runtests.jl")'
-      - run: |
-          # Run upstream "GRAPE" tests
-          julia --project=test -e '
-            using Pkg
-            Pkg.test("GRAPE", coverage=true)'
+      - name: "Run tests"
+        shell: julia --color=yes --project=test --code-coverage="@" --depwarn="yes" --check-bounds="yes" {0}
+        run: |
+          include(joinpath(pwd(), "test", "runtests.jl"))
+      - name: "Run upstream GRAPE tests"
+        shell: julia --color=yes --project=test --code-coverage="@" --depwarn="yes" --check-bounds="yes" {0}
+        run: |
+          using Pkg
+          Pkg.test("GRAPE", coverage=true)'
       - uses: julia-actions/julia-processcoverage@v1
-      - run: |
-          # Summarize coverage
-          julia --project=test -e 'using QuantumControlTestUtils; show_coverage();'
-      - uses: codecov/codecov-action@v3
+      - name: "Summarize coverage"
+        run: julia --project=test -e 'using QuantumControlTestUtils; show_coverage();'
+      - uses: codecov/codecov-action@v4
         with:
           files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
   docs:
     name: Documentation
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      statuses: write
-      pages: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
+      - uses: julia-actions/cache@v2
       - run: |
           # Install Python dependencies
           set -x
           /usr/bin/python3 -m pip install zip-files
-      - run: |
-          # Instantiate Pkg
+      - name: Instantiate Pkg
+        run: |
           wget https://raw.githubusercontent.com/JuliaQuantumControl/JuliaQuantumControl/master/scripts/installorg.jl
           julia --project=test installorg.jl
-      - run: |
-          # Run doctests
-          julia --project=test -e '
-            using Documenter: DocMeta, doctest
-            using QuantumGradientGenerators
-            DocMeta.setdocmeta!(QuantumGradientGenerators, :DocTestSetup, :(using QuantumGradientGenerators); recursive=true)
-            doctest(QuantumGradientGenerators)'
-      - run: |
-          # Make documentation
-          julia --project=test docs/make.jl
+      - name: Make documentations
+        run: julia --project=test docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
@@ -103,8 +87,8 @@ jobs:
     name: Codestyle
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
       - name: Get codestyle settings

docs/make.jl

@@ -3,26 +3,31 @@ using Documenter
 using DocumenterInterLinks
 using Pkg
 
-DocMeta.setdocmeta!(
-    QuantumGradientGenerators,
-    :DocTestSetup,
-    :(using QuantumGradientGenerators);
-    recursive=true
-)
 
 PROJECT_TOML = Pkg.TOML.parsefile(joinpath(@__DIR__, "..", "Project.toml"))
 VERSION = PROJECT_TOML["version"]
 NAME = PROJECT_TOML["name"]
 AUTHORS = join(PROJECT_TOML["authors"], ", ") * " and contributors"
 GITHUB = "https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl"
 
+DEV_OR_STABLE = "stable/"
+if endswith(VERSION, "dev")
+    DEV_OR_STABLE = "dev/"
+end
+
+links = InterLinks(
+    "Julia" => "https://docs.julialang.org/en/v1/",
+    "QuantumPropagators" => "https://juliaquantumcontrol.github.io/QuantumPropagators.jl/$DEV_OR_STABLE",
+    "QuantumControl" => "https://juliaquantumcontrol.github.io/QuantumControl.jl/$DEV_OR_STABLE",
+)
+
 println("Starting makedocs")
 
 makedocs(;
+    plugins=[links],
     authors=AUTHORS,
     sitename="QuantumGradientGenerators.jl",
-    modules=[QuantumGradientGenerators],
-    repo="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/{commit}{path}#{line}",
+    doctest=false,
     format=Documenter.HTML(;
         prettyurls=true,
         canonical="https://juliaquantumcontrol.github.io/QuantumGradientGenerators.jl",
@@ -41,7 +46,4 @@ makedocs(;
 
 println("Finished makedocs")
 
-deploydocs(;
-    repo="github.com/JuliaQuantumControl/QuantumGradientGenerators.jl",
-    devbranch="master"
-)
+deploydocs(; repo="github.com/JuliaQuantumControl/QuantumGradientGenerators.jl",)

src/grad_vector.jl

@@ -1,4 +1,5 @@
 import QuantumControlBase.QuantumPropagators: _exp_prop_convert_state
+import QuantumControlBase.QuantumPropagators.Interfaces: supports_inplace
 
 
 @doc raw"""Extended state-vector for the dynamic gradient.
@@ -34,17 +35,16 @@ e^{-i G̃ dt} \begin{pmatrix} 0 \\ \vdots \\ 0 \\ |Ψ⟩ \end{pmatrix}
 e^{-i Ĥ dt} |Ψ⟩
 \end{pmatrix}.
 ```
+
+Upon initialization, ``|Ψ̃₁⟩…|Ψ̃ₙ⟩`` are zero.
 """
 struct GradVector{num_controls,T}
     state::T
     grad_states::Vector{T}
 end
 
 function GradVector(Ψ::T, num_controls::Int64) where {T}
-    grad_states = [similar(Ψ) for _ = 1:num_controls]
-    for i = 1:num_controls
-        fill!(grad_states[i], 0.0)
-    end
+    grad_states = [zero(Ψ) for _ = 1:num_controls]
     GradVector{num_controls,T}(copy(Ψ), grad_states)
 end
 
@@ -55,18 +55,30 @@ end
 resetgradvec!(Ψ̃::GradVector)
 ```
 
-zeroes out `Ψ̃.grad_states` but leaves `Ψ̃.state` unaffected.
+zeroes out `Ψ̃.grad_states` but leaves `Ψ̃.state` unaffected. This is possible
+whether or not Ψ̃ supports in-place operations
+([`QuantumPropagators.Interfaces.supports_inplace`](@ref))
 
 ```julia
 resetgradvec!(Ψ̃::GradVector, Ψ)
 ```
 
-additionally sets `Ψ̃.state` to `Ψ`.
+additionally sets `Ψ̃.state` to `Ψ`, which requires that `Ψ̃.state` supports
+in-place operations.
+
+Returns `Ψ̃`.
 """
 function resetgradvec!(Ψ̃::GradVector)
-    for i = 1:length(Ψ̃.grad_states)
-        fill!(Ψ̃.grad_states[i], 0.0)
+    if supports_inplace(Ψ̃)
+        for i in eachindex(Ψ̃.grad_states)
+            fill!(Ψ̃.grad_states[i], 0.0)
+        end
+    else
+        for i in eachindex(Ψ̃.grad_states)
+            Ψ̃.grad_states[i] = zero(Ψ̃.state)
+        end
     end
+    return Ψ̃
 end
 
 function resetgradvec!(Ψ̃::GradVector{num_controls,T}, Ψ::T) where {num_controls,T}
@@ -76,3 +88,5 @@ end
 
 
 _exp_prop_convert_state(::GradVector) = Vector{ComplexF64}
+
+supports_inplace(Ψ̃::GradVector) = supports_inplace(Ψ̃.state)

src/gradgen_operator.jl

@@ -2,6 +2,7 @@ using Random: GLOBAL_RNG
 import QuantumControlBase.QuantumPropagators: _exp_prop_convert_operator
 import QuantumControlBase.QuantumPropagators.Controls: get_controls
 import QuantumControlBase.QuantumPropagators.SpectralRange: random_state
+import QuantumControlBase.QuantumPropagators.Interfaces: supports_inplace
 
 
 """Static generator for the dynamic gradient.
@@ -38,3 +39,5 @@ end
 
 
 _exp_prop_convert_operator(::GradgenOperator) = Matrix{ComplexF64}
+
+supports_inplace(::GradgenOperator) = true

src/linalg.jl

@@ -65,12 +65,8 @@ function Base.copyto!(dest::GradVector, src::GradVector)
 end
 
 
-function Base.copy(Ψ::GradVector)
-    Φ = GradVector(Ψ.state, length(Ψ.grad_states))
-    for i = 1:length(Ψ.grad_states)
-        copyto!(Φ.grad_states[i], Ψ.grad_states[i])
-    end
-    return Φ
+function Base.copy(Ψ::GradVector{num_controls,T}) where {num_controls,T}
+    return GradVector{num_controls,T}(copy(Ψ.state), [copy(ϕ) for ϕ in Ψ.grad_states])
 end
 
 
@@ -108,23 +104,30 @@ function Base.fill!(Ψ::GradVector, v)
 end
 
 
-function -(Ψ::GradVector, Φ::GradVector)
-    res = copy(Ψ)
-    LinearAlgebra.axpy!(-1, Φ.state, res.state)
-    for i = 1:length(Ψ.grad_states)
-        LinearAlgebra.axpy!(-1, Φ.grad_states[i], res.grad_states[i])
-    end
-    return res
+function Base.zero(Ψ::GradVector{num_controls,T}) where {num_controls,T}
+    return GradVector{num_controls,T}(zero(Ψ.state), [zero(ϕ) for ϕ ∈ Ψ.grad_states])
 end
 
 
-function +(Ψ::GradVector, Φ::GradVector)
-    res = copy(Ψ)
-    LinearAlgebra.axpy!(1, Φ.state, res.state)
-    for i = 1:length(Ψ.grad_states)
-        LinearAlgebra.axpy!(1, Φ.grad_states[i], res.grad_states[i])
-    end
-    return res
+function -(
+    Ψ::GradVector{num_controls,T},
+    Φ::GradVector{num_controls,T}
+) where {num_controls,T}
+    return GradVector{num_controls,T}(
+        Ψ.state - Φ.state,
+        [a - b for (a, b) in zip(Ψ.grad_states, Φ.grad_states)]
+    )
+end
+
+
+function +(
+    Ψ::GradVector{num_controls,T},
+    Φ::GradVector{num_controls,T}
+) where {num_controls,T}
+    return GradVector{num_controls,T}(
+        Ψ.state + Φ.state,
+        [a + b for (a, b) in zip(Ψ.grad_states, Φ.grad_states)]
+    )
 end
 
 
@@ -149,8 +152,12 @@ function *(
     G::GradgenOperator{num_controls,GT,CGT},
     Ψ::GradVector{num_controls,ST}
 ) where {num_controls,GT,CGT,ST}
-    Φ = similar(Ψ)
-    return LinearAlgebra.mul!(Φ, G, Ψ)
+    state = G.G * Ψ.state
+    grad_states = [G.G * ϕ for ϕ in Ψ.grad_states]
+    for (i, Hₙ) in enumerate(G.control_deriv_ops)
+        grad_states[i] += Hₙ * Ψ.state
+    end
+    return GradVector{num_controls,ST}(state, grad_states)
 end
 
 
@@ -211,16 +218,18 @@ function Base.convert(::Type{Vector{ComplexF64}}, gradvec::GradVector)
 end
 
 
-function Base.convert(::Type{GradVector{num_controls,T}}, vec::T) where {num_controls,T}
+function Base.convert(
+    ::Type{GradVector{num_controls,T}},
+    vec::AbstractVector
+) where {num_controls,T}
     L = num_controls
     N = length(vec) ÷ (L + 1)  # dimension of state
     @assert length(vec) == (L + 1) * N
-    grad_states = [vec[(i-1)*N+1:i*N] for i = 1:L]
-    state = vec[L*N+1:(L+1)*N]
+    grad_states = [convert(T, vec[(i-1)*N+1:i*N]) for i = 1:L]
+    state = convert(T, vec[L*N+1:(L+1)*N])
     return GradVector{num_controls,T}(state, grad_states)
 end
 
-
 function Base.Array{T}(G::GradgenOperator) where {T}
     N, M = size(G.G)
     L = length(G.control_deriv_ops)

test/Project.toml

@@ -1,6 +1,7 @@
 [deps]
 Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 GRAPE = "6b52fcaf-80fe-489a-93e9-9f92080510be"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
@@ -12,6 +13,7 @@ QuantumControlTestUtils = "d3fd27c9-1dfb-4e67-b0c0-90d0d87a1e48"
 QuantumGradientGenerators = "a563f35e-61db-434d-8c01-8b9e3ccdfd85"
 QuantumPropagators = "7bf12567-5742-4b91-a078-644e72a65fc1"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"