build based on 2c8a605

JuliaQuantumControl · Jul 28, 2024 · 8ba1bd0 · 8ba1bd0
1 parent f6fbe9d
commit 8ba1bd0
Show file tree

Hide file tree

Showing 18 changed files with 1,253 additions and 3 deletions.
diff --git a/stable b/stable
@@ -1 +1 @@
-v0.1.6
+v0.1.7
diff --git a/v0.1 b/v0.1
@@ -1 +1 @@
-v0.1.6
+v0.1.7
diff --git a/v0.1.7/.documenter-siteinfo.json b/v0.1.7/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-28T00:42:54","documenter_version":"1.5.0"}}
diff --git a/v0.1.7/api/index.html b/v0.1.7/api/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · QuantumGradientGenerators.jl</title><meta name="title" content="API · QuantumGradientGenerators.jl"/><meta property="og:title" content="API · QuantumGradientGenerators.jl"/><meta property="twitter:title" content="API · QuantumGradientGenerators.jl"/><meta name="description" content="Documentation for QuantumGradientGenerators.jl."/><meta property="og:description" content="Documentation for QuantumGradientGenerators.jl."/><meta property="twitter:description" content="Documentation for QuantumGradientGenerators.jl."/><meta property="og:url" content="https://juliaquantumcontrol.github.io/QuantumGradientGenerators.jl/api/"/><meta property="twitter:url" content="https://juliaquantumcontrol.github.io/QuantumGradientGenerators.jl/api/"/><link rel="canonical" href="https://juliaquantumcontrol.github.io/QuantumGradientGenerators.jl/api/"/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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><link href="https://juliaquantumcontrol.github.io/QuantumControl.jl/dev/assets/topbar/topbar.css" rel="stylesheet" type="text/css"/><script src="https://juliaquantumcontrol.github.io/QuantumControl.jl/dev/assets/topbar/topbar.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">QuantumGradientGenerators.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li><li><a class="tocitem" href="#Reference"><span>Reference</span></a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/master/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="QuantumGradientGenerators-API"><a class="docs-heading-anchor" href="#QuantumGradientGenerators-API"><code>QuantumGradientGenerators</code> API</a><a id="QuantumGradientGenerators-API-1"></a><a class="docs-heading-anchor-permalink" href="#QuantumGradientGenerators-API" title="Permalink"></a></h1><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#QuantumGradientGenerators.GradGenerator"><code>QuantumGradientGenerators.GradGenerator</code></a></li><li><a href="#QuantumGradientGenerators.GradVector"><code>QuantumGradientGenerators.GradVector</code></a></li><li><a href="#QuantumGradientGenerators.GradgenOperator"><code>QuantumGradientGenerators.GradgenOperator</code></a></li><li><a href="#QuantumGradientGenerators.resetgradvec!-Tuple{GradVector}"><code>QuantumGradientGenerators.resetgradvec!</code></a></li></ul><h2 id="Reference"><a class="docs-heading-anchor" href="#Reference">Reference</a><a id="Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Reference" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantumGradientGenerators.GradGenerator" href="#QuantumGradientGenerators.GradGenerator"><code>QuantumGradientGenerators.GradGenerator</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Extended generator for the standard dynamic gradient.</p><pre><code class="language-julia hljs">G̃ = GradGenerator(G)</code></pre><p>contains the original time-dependent generator <code>G</code> (a Hamiltonian or Liouvillian) in <code>G̃.G</code>, a vector of control derivatives <span>$∂G/∂ϵₗ(t)$</span> in <code>G̃.control_derivs</code>, and the controls in <code>G̃.controls</code>.</p><p>For a generator <span>$G = Ĥ(t) = Ĥ₀ + ϵ₁(t) Ĥ₁ + … +  ϵₙ(t) Ĥₙ$</span>, this extended generator encodes the block-matrix</p><p class="math-container">\[G̃ = \begin{pmatrix}
+         Ĥ(t)  &amp;  0    &amp;  \dots   &amp;  0     &amp;  Ĥ₁     \\
+         0     &amp;  Ĥ(t) &amp;  \dots   &amp;  0     &amp;  Ĥ₂     \\
+    \vdots     &amp;       &amp;  \ddots  &amp;        &amp;  \vdots \\
+         0     &amp;  0    &amp;  \dots   &amp;  Ĥ(t)  &amp;  Ĥₙ     \\
+         0     &amp;  0    &amp;  \dots   &amp;  0     &amp;  Ĥ(t)
+\end{pmatrix}\]</p><p>Note that the <span>$∂G/∂ϵₗ(t)$</span> (<span>$Ĥₗ$</span> in the above example) may be time-dependent, to account for the possibility of non-linear control terms.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/2c8a60563ca50c622e3a505657c59a47ecce2c62/src/grad_generator.jl#L7-L33">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantumGradientGenerators.GradVector" href="#QuantumGradientGenerators.GradVector"><code>QuantumGradientGenerators.GradVector</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Extended state-vector for the dynamic gradient.</p><pre><code class="language-julia hljs">Ψ̃ = GradVector(Ψ, num_controls)</code></pre><p>for an initial state <code>Ψ</code> and <code>num_controls</code> control fields.</p><p>The <code>GradVector</code> conceptually corresponds to a direct-sum (block) column-vector <span>$Ψ̃ = (|Ψ̃₁⟩, |Ψ̃₂⟩, … |Ψ̃ₙ⟩, |Ψ⟩)^T$</span>, where <span>$n$</span> is <code>num_controls</code>. With a matching <span>$G̃$</span> as in the documentation of <a href="#QuantumGradientGenerators.GradGenerator"><code>GradGenerator</code></a>, we have</p><p class="math-container">\[G̃ Ψ̃ = \begin{pmatrix}
+Ĥ |Ψ̃₁⟩ + Ĥ₁|Ψ⟩ \\
+\vdots \\
+Ĥ |Ψ̃ₙ⟩ + Ĥₙ|Ψ⟩ \\
+Ĥ |Ψ⟩
+\end{pmatrix}\]</p><p>and</p><p class="math-container">\[e^{-i G̃ dt} \begin{pmatrix} 0 \\ \vdots \\ 0 \\ |Ψ⟩ \end{pmatrix}
+= \begin{pmatrix}
+\frac{∂}{∂ϵ₁} e^{-i Ĥ dt} |Ψ⟩ \\
+\vdots \\
+\frac{∂}{∂ϵₙ} e^{-i Ĥ dt} |Ψ⟩ \\
+e^{-i Ĥ dt} |Ψ⟩
+\end{pmatrix}.\]</p><p>Upon initialization, <span>$|Ψ̃₁⟩…|Ψ̃ₙ⟩$</span> are zero.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/2c8a60563ca50c622e3a505657c59a47ecce2c62/src/grad_vector.jl#L5-L41">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantumGradientGenerators.GradgenOperator" href="#QuantumGradientGenerators.GradgenOperator"><code>QuantumGradientGenerators.GradgenOperator</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Static generator for the dynamic gradient.</p><pre><code class="language-julia hljs">using QuantumPropagators.Controls: evaluate
+
+G::GradgenOperator = evaluate(gradgen::GradGenerator; vals_dict)</code></pre><p>is the result of plugging in specific values for all controls in a <a href="#QuantumGradientGenerators.GradGenerator"><code>GradGenerator</code></a>.</p><p>The resulting object can be multiplied directly with a <a href="#QuantumGradientGenerators.GradVector"><code>GradVector</code></a>, e.g., in the process of evaluating a piecewise-constant time propagation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/2c8a60563ca50c622e3a505657c59a47ecce2c62/src/gradgen_operator.jl#L8-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="QuantumGradientGenerators.resetgradvec!-Tuple{GradVector}" href="#QuantumGradientGenerators.resetgradvec!-Tuple{GradVector}"><code>QuantumGradientGenerators.resetgradvec!</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Reset the given gradient vector for a new gradient evaluation.</p><pre><code class="language-julia hljs">resetgradvec!(Ψ̃::GradVector)</code></pre><p>zeroes out <code>Ψ̃.grad_states</code> but leaves <code>Ψ̃.state</code> unaffected. This is possible whether or not Ψ̃ supports in-place operations (<a href="https://juliaquantumcontrol.github.io/QuantumPropagators.jl/stable/api/quantumpropagators/#QuantumPropagators.Interfaces.supports_inplace"><code>QuantumPropagators.Interfaces.supports_inplace</code></a>)</p><pre><code class="language-julia hljs">resetgradvec!(Ψ̃::GradVector, Ψ)</code></pre><p>additionally sets <code>Ψ̃.state</code> to <code>Ψ</code>, which requires that <code>Ψ̃.state</code> supports in-place operations.</p><p>Returns <code>Ψ̃</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl/blob/2c8a60563ca50c622e3a505657c59a47ecce2c62/src/grad_vector.jl#L52-L71">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaQuantumControl/QuantumGradientGenerators.jl">QuantumGradientGenerators.jl</a> v0.1.7 docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Sunday 28 July 2024 00:42">Sunday 28 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>