Skip to content

Commit

Permalink
build based on 2df7ad4
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 14, 2024
1 parent b29627b commit a3a0327
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
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>HermiteOptimalControl.jl Documentation · HermiteOptimalControl.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>HermiteOptimalControl.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 class="is-active"><a class="tocitem" href>HermiteOptimalControl.jl Documentation</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Workflow"><span>Workflow</span></a></li><li class="toplevel"><a class="tocitem" href="#Functions"><span>Functions</span></a></li><li><a class="tocitem" href="#Schrodinger-Problem-Definition"><span>Schrodinger Problem Definition</span></a></li><li><a class="tocitem" href="#Schrodinger-Problem-Examples"><span>Schrodinger Problem Examples</span></a></li><li><a class="tocitem" href="#Forward-Evolution"><span>Forward Evolution</span></a></li><li><a class="tocitem" href="#Gradient-Evaluation"><span>Gradient Evaluation</span></a></li><li><a class="tocitem" href="#Bsplines"><span>Bsplines</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>HermiteOptimalControl.jl Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>HermiteOptimalControl.jl Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/leespen1/HermiteOptimalControl.jl/blob/main/docs/src/index.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="HermiteOptimalControl.jl-Documentation"><a class="docs-heading-anchor" href="#HermiteOptimalControl.jl-Documentation">HermiteOptimalControl.jl Documentation</a><a id="HermiteOptimalControl.jl-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#HermiteOptimalControl.jl-Documentation" title="Permalink"></a></h1><ul><li><a href="#HermiteOptimalControl.jl-Documentation">HermiteOptimalControl.jl Documentation</a></li><li><a href="#Workflow">Workflow</a></li><li><a href="#Functions">Functions</a></li><li class="no-marker"><ul><li><a href="#Schrodinger-Problem-Definition">Schrodinger Problem Definition</a></li><li><a href="#Schrodinger-Problem-Examples">Schrodinger Problem Examples</a></li><li><a href="#Forward-Evolution">Forward Evolution</a></li><li><a href="#Gradient-Evaluation">Gradient Evaluation</a></li><li><a href="#Bsplines">Bsplines</a></li></ul></li></ul><h1 id="Workflow"><a class="docs-heading-anchor" href="#Workflow">Workflow</a><a id="Workflow-1"></a><a class="docs-heading-anchor-permalink" href="#Workflow" title="Permalink"></a></h1><p>Right now the user can set up Schrodinger problems, and compute the gradients of them with the control vector and target gate of their choosing. In a complete package, there would also be an optimization procedure which uses this gradient calculation.</p><p>The basic workflow is:</p><ol><li>Set up a SchrodingerProblem, either yourself using the constructor <a href="@ref">SchrodingerProb</a>, or by using one of the example problems provided. <a href="#Schrodinger-Problem-Examples">Schrodinger Problem Examples</a></li><li>Choose a control vector and target.</li><li>Compute a gradient using one of the methods provided. <a href="#Gradient-Evaluation">Gradient Evaluation</a></li></ol><h1 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h1><h2 id="Schrodinger-Problem-Definition"><a class="docs-heading-anchor" href="#Schrodinger-Problem-Definition">Schrodinger Problem Definition</a><a id="Schrodinger-Problem-Definition-1"></a><a class="docs-heading-anchor-permalink" href="#Schrodinger-Problem-Definition" title="Permalink"></a></h2><pre><code class="nohighlight hljs">SchrodingerProb</code></pre><h2 id="Schrodinger-Problem-Examples"><a class="docs-heading-anchor" href="#Schrodinger-Problem-Examples">Schrodinger Problem Examples</a><a id="Schrodinger-Problem-Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Schrodinger-Problem-Examples" title="Permalink"></a></h2><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>rabi_osc</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>gargamel_prob</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>bspline_prob</code>. Check Documenter&#39;s build log for details.</p></div></div><h2 id="Forward-Evolution"><a class="docs-heading-anchor" href="#Forward-Evolution">Forward Evolution</a><a id="Forward-Evolution-1"></a><a class="docs-heading-anchor-permalink" href="#Forward-Evolution" title="Permalink"></a></h2><p>Functions for evolving the state vector in a problem forward in time according to Schrodinger&#39;s equation, with or without forcing.</p><article class="docstring"><header><a class="docstring-binding" id="HermiteOptimalControl.eval_forward" href="#HermiteOptimalControl.eval_forward"><code>HermiteOptimalControl.eval_forward</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Evolve a vector SchrodingerProblem forward in time. Return the history of the state vector (u/v) in a 3-index array, where the first index of corresponds to the vector component, the second index corresponds to the derivative to be taken, and the third index corresponds to the timestep number.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/HermiteOptimalControl.jl/blob/36b15d5435082e323856423a3f21bcd934c0d8f2/src/forward_evolution.jl#L163-L168">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>eval_forward_forced</code>. Check Documenter&#39;s build log for details.</p></div></div><h2 id="Gradient-Evaluation"><a class="docs-heading-anchor" href="#Gradient-Evaluation">Gradient Evaluation</a><a id="Gradient-Evaluation-1"></a><a class="docs-heading-anchor-permalink" href="#Gradient-Evaluation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="HermiteOptimalControl.discrete_adjoint" href="#HermiteOptimalControl.discrete_adjoint"><code>HermiteOptimalControl.discrete_adjoint</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Arbitrary order version, should make one with target being abstract vector as well, so I can do state transfer problems.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/HermiteOptimalControl.jl/blob/36b15d5435082e323856423a3f21bcd934c0d8f2/src/eval_grad_discrete_adjoint.jl#L61-L64">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>eval_grad_forced</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>eval_grad_finite_difference</code>. Check Documenter&#39;s build log for details.</p></div></div><article class="docstring"><header><a class="docstring-binding" id="HermiteOptimalControl.infidelity" href="#HermiteOptimalControl.infidelity"><code>HermiteOptimalControl.infidelity</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Calculates the infidelity for the given state vector &#39;ψ&#39; and target state &#39;target.&#39;</p><p>Returns: Infidelity</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/HermiteOptimalControl.jl/blob/36b15d5435082e323856423a3f21bcd934c0d8f2/src/infidelity.jl#L1-L6">source</a></section><section><div><p>Calculates the infidelity for the given matrix of state vectors &#39;Q&#39; and matrix of target states &#39;target.&#39;</p><p>Returns: Infidelity</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/leespen1/HermiteOptimalControl.jl/blob/36b15d5435082e323856423a3f21bcd934c0d8f2/src/infidelity.jl#L16-L21">source</a></section></article><h2 id="Bsplines"><a class="docs-heading-anchor" href="#Bsplines">Bsplines</a><a id="Bsplines-1"></a><a class="docs-heading-anchor-permalink" href="#Bsplines" title="Permalink"></a></h2><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>bcparams</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>bcarrier2</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>bcarrier2_dt</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>gradbcarrier2!</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>gradbcarrier2_dt!</code>. Check Documenter&#39;s build log for details.</p></div></div></article><nav class="docs-footer"><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="Wednesday 7 February 2024 20:04">Wednesday 7 February 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>QuantumGateDesign.jl · 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 class="is-active"><a class="tocitem" href>QuantumGateDesign.jl</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Workflow"><span>Workflow</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>QuantumGateDesign.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>QuantumGateDesign.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/leespen1/QuantumGateDesign.jl/blob/main/docs/src/index.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="QuantumGateDesign.jl"><a class="docs-heading-anchor" href="#QuantumGateDesign.jl">QuantumGateDesign.jl</a><a id="QuantumGateDesign.jl-1"></a><a class="docs-heading-anchor-permalink" href="#QuantumGateDesign.jl" title="Permalink"></a></h1><ul><li><a href="#QuantumGateDesign.jl">QuantumGateDesign.jl</a></li><li><a href="#Workflow">Workflow</a></li></ul><h1 id="Workflow"><a class="docs-heading-anchor" href="#Workflow">Workflow</a><a id="Workflow-1"></a><a class="docs-heading-anchor-permalink" href="#Workflow" title="Permalink"></a></h1><p>Right now the user can set up Schrodinger problems, and compute the gradients of them with the control vector and target gate of their choosing. In a complete package, there would also be an optimization procedure which uses this gradient calculation.</p></article><nav class="docs-footer"><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="Friday 14 June 2024 19:22">Friday 14 June 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit a3a0327

Please sign in to comment.