Skip to content

Commit

Permalink
build based on 0a8b794
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 27, 2024
1 parent 14ba5ce commit f6fbe9d
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-27T12:00:53","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-27T12:30:21","documenter_version":"1.5.0"}}
6 changes: 3 additions & 3 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
\vdots & & \ddots & & \vdots \\
0 & 0 & \dots & Ĥ(t) & Ĥₙ \\
0 & 0 & \dots & 0 & Ĥ(t)
\end{pmatrix}\]</p><p>Note that the <span>$∂G/∂ϵₗ(t)$</span> (<span>$Ĥₗ$</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/ec1d5dd458f260038859afeca8818a4bb78a70be/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}
\end{pmatrix}\]</p><p>Note that the <span>$∂G/∂ϵₗ(t)$</span> (<span>$Ĥₗ$</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/0a8b7945e544711015101f15136c2f5f7f458e1b/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}
Ĥ |Ψ̃₁⟩ + Ĥ₁|Ψ⟩ \\
\vdots \\
Ĥ |Ψ̃ₙ⟩ + Ĥₙ|Ψ⟩ \\
Expand All @@ -16,6 +16,6 @@
\vdots \\
\frac{∂}{∂ϵₙ} e^{-i Ĥ dt} |Ψ⟩ \\
e^{-i Ĥ 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/ec1d5dd458f260038859afeca8818a4bb78a70be/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
\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/0a8b7945e544711015101f15136c2f5f7f458e1b/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/ec1d5dd458f260038859afeca8818a4bb78a70be/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/dev/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/ec1d5dd458f260038859afeca8818a4bb78a70be/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.6+dev 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="Saturday 27 July 2024 12:00">Saturday 27 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
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/0a8b7945e544711015101f15136c2f5f7f458e1b/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/dev/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/0a8b7945e544711015101f15136c2f5f7f458e1b/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.6+dev 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="Saturday 27 July 2024 12:30">Saturday 27 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit f6fbe9d

Please sign in to comment.