build based on 3ce80e4

previews/PR1514/AdvancedUsageGuide.html

@@ -461,4 +461,4 @@
 myscale2! (generic function with 1 method)
 
 julia> @btime myscale2!(A, 2) setup = (A = random_itensor(i));
-  3.549 μs (2 allocations: 112 bytes)</code></pre><p>A very efficient function is written for the Tensor type. Then, the ITensor version just wraps the Tensor function by calling it after converting the ITensor to a Tensor (without any copying) with the <code>tensor</code> function. This is the basis for the design of all performance critical ITensors.jl functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Einsum.html">« ITensor indices and Einstein notation</a><a class="docs-footer-nextpage" href="Multithreading.html">Multithreading »</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="Friday 28 June 2024 16:45">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  3.549 μs (2 allocations: 112 bytes)</code></pre><p>A very efficient function is written for the Tensor type. Then, the ITensor version just wraps the Tensor function by calling it after converting the ITensor to a Tensor (without any copying) with the <code>tensor</code> function. This is the basis for the design of all performance critical ITensors.jl functions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Einsum.html">« ITensor indices and Einstein notation</a><a class="docs-footer-nextpage" href="Multithreading.html">Multithreading »</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="Friday 28 June 2024 17:19">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR1514/DMRGObserver.html

@@ -7,8 +7,8 @@
   println("Total Sz after sweep $sw = ", sum(Szs)/N)
 end</code></pre><h2 id="Constructors"><a class="docs-heading-anchor" href="#Constructors">Constructors</a><a id="Constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Constructors" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.DMRGObserver-Tuple{}" href="#ITensors.ITensorMPS.DMRGObserver-Tuple{}"><code>ITensors.ITensorMPS.DMRGObserver</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">DMRGObserver(;energy_tol=0.0,
               minsweeps=2,
-              energy_type=Float64)</code></pre><p>Construct a DMRGObserver by providing the energy tolerance used for early stopping, and minimum number of sweeps that must be done.</p><p>Optional keyword arguments:</p><ul><li>energy_tol: if the energy from one sweep to the next no longer changes by more than this amount, stop after the current sweep</li><li>minsweeps: do at least this many sweeps</li><li>energy_type: type to use when storing energies at each step</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/6dd63877fce36028a1c2e3466cab6d3d1cf50980/src/lib/ITensorMPS/src/observer.jl#L40-L56">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.DMRGObserver-Tuple{Vector{String}, Vector{&lt;:Index}}" href="#ITensors.ITensorMPS.DMRGObserver-Tuple{Vector{String}, Vector{&lt;:Index}}"><code>ITensors.ITensorMPS.DMRGObserver</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">DMRGObserver(ops::Vector{String},
+              energy_type=Float64)</code></pre><p>Construct a DMRGObserver by providing the energy tolerance used for early stopping, and minimum number of sweeps that must be done.</p><p>Optional keyword arguments:</p><ul><li>energy_tol: if the energy from one sweep to the next no longer changes by more than this amount, stop after the current sweep</li><li>minsweeps: do at least this many sweeps</li><li>energy_type: type to use when storing energies at each step</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/3ce80e4f726d77b3d4a458e459065644930933a8/src/lib/ITensorMPS/src/observer.jl#L40-L56">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.DMRGObserver-Tuple{Vector{String}, Vector{&lt;:Index}}" href="#ITensors.ITensorMPS.DMRGObserver-Tuple{Vector{String}, Vector{&lt;:Index}}"><code>ITensors.ITensorMPS.DMRGObserver</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">DMRGObserver(ops::Vector{String},
              sites::Vector{&lt;:Index};
              energy_tol=0.0,
              minsweeps=2,
-             energy_type=Float64)</code></pre><p>Construct a DMRGObserver, provide an array of <code>ops</code> of operator names which are strings recognized by the <code>op</code> function. Each of these operators will be measured on every site during every step of DMRG and the results recorded inside the DMRGOberver for later analysis. The array <code>sites</code> is the basis of sites used to define the MPS and MPO for the DMRG calculation.</p><p>Optionally, one can provide an energy tolerance used for early stopping, and minimum number of sweeps that must be done.</p><p>Optional keyword arguments:</p><ul><li>energy_tol: if the energy from one sweep to the next no longer changes by more than this amount, stop after the current sweep</li><li>minsweeps: do at least this many sweeps</li><li>energy_type: type to use when storing energies at each step</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/6dd63877fce36028a1c2e3466cab6d3d1cf50980/src/lib/ITensorMPS/src/observer.jl#L69-L97">source</a></section></article><h2 id="Methods"><a class="docs-heading-anchor" href="#Methods">Methods</a><a id="Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Methods" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.measurements-Tuple{DMRGObserver}" href="#ITensors.ITensorMPS.measurements-Tuple{DMRGObserver}"><code>ITensors.ITensorMPS.measurements</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">measurements(o::DMRGObserver)</code></pre><p>After using a DMRGObserver object <code>o</code> within a DMRG calculation, retrieve a dictionary of measurement results, with the keys being operator names and values being DMRGMeasurement objects.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/6dd63877fce36028a1c2e3466cab6d3d1cf50980/src/lib/ITensorMPS/src/observer.jl#L111-L119">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.DMRGMeasurement" href="#ITensors.ITensorMPS.DMRGMeasurement"><code>ITensors.ITensorMPS.DMRGMeasurement</code></a> — <span class="docstring-category">Type</span></header><section><div><p>A DMRGMeasurement object is an alias for <code>Vector{Vector{Float64}}</code>, in other words an array of arrays of real numbers.</p><p>Given a DMRGMeasurement <code>M</code>,the result for the measurement on sweep <code>n</code> and site <code>i</code> as <code>M[n][i]</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/6dd63877fce36028a1c2e3466cab6d3d1cf50980/src/lib/ITensorMPS/src/observer.jl#L14-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.energies-Tuple{DMRGObserver}" href="#ITensors.ITensorMPS.energies-Tuple{DMRGObserver}"><code>ITensors.ITensorMPS.energies</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">energies(o::DMRGObserver)</code></pre><p>After using a DMRGObserver object <code>o</code> within a DMRG calculation, retrieve an array of the energy after each sweep.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/6dd63877fce36028a1c2e3466cab6d3d1cf50980/src/lib/ITensorMPS/src/observer.jl#L122-L128">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Observer.html">« Observer System for DMRG</a><a class="docs-footer-nextpage" href="OpSum.html">OpSum »</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="Friday 28 June 2024 16:45">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+             energy_type=Float64)</code></pre><p>Construct a DMRGObserver, provide an array of <code>ops</code> of operator names which are strings recognized by the <code>op</code> function. Each of these operators will be measured on every site during every step of DMRG and the results recorded inside the DMRGOberver for later analysis. The array <code>sites</code> is the basis of sites used to define the MPS and MPO for the DMRG calculation.</p><p>Optionally, one can provide an energy tolerance used for early stopping, and minimum number of sweeps that must be done.</p><p>Optional keyword arguments:</p><ul><li>energy_tol: if the energy from one sweep to the next no longer changes by more than this amount, stop after the current sweep</li><li>minsweeps: do at least this many sweeps</li><li>energy_type: type to use when storing energies at each step</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/3ce80e4f726d77b3d4a458e459065644930933a8/src/lib/ITensorMPS/src/observer.jl#L69-L97">source</a></section></article><h2 id="Methods"><a class="docs-heading-anchor" href="#Methods">Methods</a><a id="Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Methods" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.measurements-Tuple{DMRGObserver}" href="#ITensors.ITensorMPS.measurements-Tuple{DMRGObserver}"><code>ITensors.ITensorMPS.measurements</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">measurements(o::DMRGObserver)</code></pre><p>After using a DMRGObserver object <code>o</code> within a DMRG calculation, retrieve a dictionary of measurement results, with the keys being operator names and values being DMRGMeasurement objects.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/3ce80e4f726d77b3d4a458e459065644930933a8/src/lib/ITensorMPS/src/observer.jl#L111-L119">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.DMRGMeasurement" href="#ITensors.ITensorMPS.DMRGMeasurement"><code>ITensors.ITensorMPS.DMRGMeasurement</code></a> — <span class="docstring-category">Type</span></header><section><div><p>A DMRGMeasurement object is an alias for <code>Vector{Vector{Float64}}</code>, in other words an array of arrays of real numbers.</p><p>Given a DMRGMeasurement <code>M</code>,the result for the measurement on sweep <code>n</code> and site <code>i</code> as <code>M[n][i]</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/3ce80e4f726d77b3d4a458e459065644930933a8/src/lib/ITensorMPS/src/observer.jl#L14-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ITensors.ITensorMPS.energies-Tuple{DMRGObserver}" href="#ITensors.ITensorMPS.energies-Tuple{DMRGObserver}"><code>ITensors.ITensorMPS.energies</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">energies(o::DMRGObserver)</code></pre><p>After using a DMRGObserver object <code>o</code> within a DMRG calculation, retrieve an array of the energy after each sweep.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensors.jl/blob/3ce80e4f726d77b3d4a458e459065644930933a8/src/lib/ITensorMPS/src/observer.jl#L122-L128">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Observer.html">« Observer System for DMRG</a><a class="docs-footer-nextpage" href="OpSum.html">OpSum »</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="Friday 28 June 2024 17:19">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR1514/DeveloperGuide.html

@@ -29,4 +29,4 @@
 
 # Call fA like this:
 fA(my_callback, psi; callback_args = (; a, b))
-</code></pre></li><li><p><strong>External (non-ITensor) Functions</strong>: Though it requires judgment in each case, if the keyword arguments an external (non-ITensor) function accepts are small in number, not expected to change, and known ahead of time, try to list them explicitly if possible (rather than forwarding with <code>kwargs...</code>). Possible exceptions could be if you want to make use of defaults defined for keyword arguments of an external function.</p></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="HDF5FileFormats.html">« HDF5 File Formats</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="Friday 28 June 2024 16:45">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></li><li><p><strong>External (non-ITensor) Functions</strong>: Though it requires judgment in each case, if the keyword arguments an external (non-ITensor) function accepts are small in number, not expected to change, and known ahead of time, try to list them explicitly if possible (rather than forwarding with <code>kwargs...</code>). Possible exceptions could be if you want to make use of defaults defined for keyword arguments of an external function.</p></li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="HDF5FileFormats.html">« HDF5 File Formats</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="Friday 28 June 2024 17:19">Friday 28 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>