-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jun 15, 2024
1 parent
4451d72
commit 4f02691
Showing
11 changed files
with
11 additions
and
11 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Forward Simulation · QuantumGateDesign.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">QuantumGateDesign.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../problem_setup/">Problem Setup</a></li><li class="is-active"><a class="tocitem" href>Forward Simulation</a></li><li><a class="tocitem" href="../gradient_evaluation/">Gradient Evaluation</a></li><li><a class="tocitem" href="../optimization/">Optimization</a></li><li><a class="tocitem" href="../control_functions/">Control Functions</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../visualization/">Visualization</a></li><li><a class="tocitem" href="../function-index/">Index</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Forward Simulation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Forward Simulation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/leespen1/QuantumGateDesign.jl/blob/main/docs/src/forward_simulation.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Forward-Simulation"><a class="docs-heading-anchor" href="#Forward-Simulation">Forward Simulation</a><a id="Forward-Simulation-1"></a><a class="docs-heading-anchor-permalink" href="#Forward-Simulation" title="Permalink"></a></h1><p>The function <a href="#QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}"><code>eval_forward</code></a> can be used to simulate the evolution of a quantum state in time.</p><article class="docstring"><header><a class="docstring-binding" id="QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}" href="#QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}"><code>QuantumGateDesign.eval_forward</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">eval_forward(prob, controls, pcof; [order=2, saveEveryNsteps=1, forcing=missing, abstol=1e-10, reltol=1e-10])</code></pre><p>Simulate a <code>SchrodingerProb</code> forward in time. Return the history of the state vector for each initial condition as a 4D array.</p><p><strong>Arguments</strong></p><ul><li><code>prob::SchrodingerProb</code>: Object containing the Hamiltonians, number of timesteps, etc.</li><li><code>controls</code>: An <code>AstractControl</code> or vector of controls, where the i-th control corresponds to the i-th control Hamiltonian.</li><li><code>pcof::AbstractVector{<: Real}</code>: The control vector.</li><li><code>order::Int64=2</code>: Which order of the method to use.</li><li><code>saveEveryNsteps::Int64=1</code>: Only store the state every <code>saveEveryNsteps</code> timesteps.</li><li><code>forcing::Union{AbstractArray{Float64}, Missing}</code>: Optional forcing array, ordered in same format as the returned history.</li><li><code>abstol::Float64=1e-10</code>: Absolute tolerance to use in GMRES.</li><li><code>reltol::Float64=1e-10</code>: Relative tolerance to use in GMRES.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/QuantumGateDesign.jl/blob/c9602f58c4ca6bcf191f329a1ceaf84253d4aaa8/src/forward_evolution.jl#L1-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../problem_setup/">« Problem Setup</a><a class="docs-footer-nextpage" href="../gradient_evaluation/">Gradient Evaluation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 15 June 2024 04:25">Saturday 15 June 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Forward Simulation · QuantumGateDesign.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">QuantumGateDesign.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../problem_setup/">Problem Setup</a></li><li class="is-active"><a class="tocitem" href>Forward Simulation</a></li><li><a class="tocitem" href="../gradient_evaluation/">Gradient Evaluation</a></li><li><a class="tocitem" href="../optimization/">Optimization</a></li><li><a class="tocitem" href="../control_functions/">Control Functions</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../visualization/">Visualization</a></li><li><a class="tocitem" href="../function-index/">Index</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Forward Simulation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Forward Simulation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/leespen1/QuantumGateDesign.jl/blob/main/docs/src/forward_simulation.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Forward-Simulation"><a class="docs-heading-anchor" href="#Forward-Simulation">Forward Simulation</a><a id="Forward-Simulation-1"></a><a class="docs-heading-anchor-permalink" href="#Forward-Simulation" title="Permalink"></a></h1><p>The function <a href="#QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}"><code>eval_forward</code></a> can be used to simulate the evolution of a quantum state in time.</p><article class="docstring"><header><a class="docstring-binding" id="QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}" href="#QuantumGateDesign.eval_forward-Union{Tuple{M2}, Tuple{M1}, Tuple{SchrodingerProb{M1, M2}, Any, AbstractVector{<:Real}}} where {M1<:AbstractMatrix{Float64}, M2<:AbstractMatrix{Float64}}"><code>QuantumGateDesign.eval_forward</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">eval_forward(prob, controls, pcof; [order=2, saveEveryNsteps=1, forcing=missing, abstol=1e-10, reltol=1e-10])</code></pre><p>Simulate a <code>SchrodingerProb</code> forward in time. Return the history of the state vector for each initial condition as a 4D array.</p><p><strong>Arguments</strong></p><ul><li><code>prob::SchrodingerProb</code>: Object containing the Hamiltonians, number of timesteps, etc.</li><li><code>controls</code>: An <code>AstractControl</code> or vector of controls, where the i-th control corresponds to the i-th control Hamiltonian.</li><li><code>pcof::AbstractVector{<: Real}</code>: The control vector.</li><li><code>order::Int64=2</code>: Which order of the method to use.</li><li><code>saveEveryNsteps::Int64=1</code>: Only store the state every <code>saveEveryNsteps</code> timesteps.</li><li><code>forcing::Union{AbstractArray{Float64}, Missing}</code>: Optional forcing array, ordered in same format as the returned history.</li><li><code>abstol::Float64=1e-10</code>: Absolute tolerance to use in GMRES.</li><li><code>reltol::Float64=1e-10</code>: Relative tolerance to use in GMRES.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/QuantumGateDesign.jl/blob/1354e6c635e8fe4befaa2eb888c14f04fcef6653/src/forward_evolution.jl#L1-L16">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../problem_setup/">« Problem Setup</a><a class="docs-footer-nextpage" href="../gradient_evaluation/">Gradient Evaluation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 15 June 2024 04:37">Saturday 15 June 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.