-
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
Dec 26, 2023
1 parent
d7675a6
commit 503bd61
Showing
26 changed files
with
65 additions
and
65 deletions.
There are no files selected for viewing
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 +1 @@ | ||
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-26T21:54:31","documenter_version":"1.2.1"}} | ||
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-26T22:02:55","documenter_version":"1.2.1"}} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Dealing with Fermions · TeNLib.jl</title><meta name="title" content="Dealing with Fermions · TeNLib.jl"/><meta property="og:title" content="Dealing with Fermions · TeNLib.jl"/><meta property="twitter:title" content="Dealing with Fermions · TeNLib.jl"/><meta name="description" content="A Tensor Network Library (TeNLib.jl) built on top of ITensors.jl for quantum many-body problems."/><meta property="og:description" content="A Tensor Network Library (TeNLib.jl) built on top of ITensors.jl for quantum many-body problems."/><meta property="twitter:description" content="A Tensor Network Library (TeNLib.jl) built on top of ITensors.jl for quantum many-body problems."/><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/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="../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img class="docs-light-only" src="../../assets/logo.png" alt="TeNLib.jl logo"/><img class="docs-dark-only" src="../../assets/logo-dark.png" alt="TeNLib.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TeNLib.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="../../">Introduction</a></li><li><span class="tocitem">Base functionalities</span><ul><li><a class="tocitem" href="../global/">Controlling global behaviors</a></li><li class="is-active"><a class="tocitem" href>Dealing with Fermions</a></li><li><a class="tocitem" href="../opstrings/">OpStrings</a></li><li><a class="tocitem" href="../couplingmodel/">CouplingModel</a></li><li><a class="tocitem" href="../solver/">Solvers</a></li><li><a class="tocitem" href="../graph/">The Graph object</a></li><li><a class="tocitem" href="../misc/">Miscellaneous typedefs and functions</a></li></ul></li><li><span class="tocitem">MPS based methods</span><ul><li><a class="tocitem" href="../../mps/state_envs/">StateEnvs</a></li><li><a class="tocitem" href="../../mps/update_site/">Perform local updates</a></li><li><a class="tocitem" href="../../mps/sweep/">Sweeping through the MPS</a></li><li><a class="tocitem" href="../../mps/dmrg/">Performing DMRG</a></li><li><a class="tocitem" href="../../mps/example_dmrg/">Example: DMRG</a></li><li><a class="tocitem" href="../../mps/tdvp/">Performing TDVP</a></li><li><a class="tocitem" href="../../mps/example_tdvp/">Example: TDVP</a></li><li><a class="tocitem" href="../../mps/measure/">Measuring the MPS</a></li></ul></li><li><span class="tocitem">TTN based methods</span><ul><li><a class="tocitem" href="../../ttn/ttn/">Tree Tensor Networks</a></li><li><a class="tocitem" href="../../ttn/ttn_struct/">The TTN object</a></li><li><a class="tocitem" href="../../ttn/ttn_gen/">Generating TTN</a></li><li><a class="tocitem" href="../../ttn/state_envs_ttn/">StateEnvsTTN</a></li><li><a class="tocitem" href="../../ttn/update_site_ttn/">Perform local updates</a></li><li><a class="tocitem" href="../../ttn/sweep_ttn/">Sweeping through the TTN</a></li><li><a class="tocitem" href="../../ttn/optimize_ttn/">Optimizing TTN</a></li><li><a class="tocitem" href="../../ttn/example_optimize/">Example: Optimizing TTN</a></li><li><a class="tocitem" href="../../ttn/measure_ttn/">Measuring the TTN</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><a class="is-disabled">Base functionalities</a></li><li class="is-active"><a href>Dealing with Fermions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Dealing with Fermions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/titaschanda/TeNLib.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/titaschanda/TeNLib.jl/blob/main/docs/src/base/fermions.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="Dealing-with-Fermions"><a class="docs-heading-anchor" href="#Dealing-with-Fermions">Dealing with Fermions</a><a id="Dealing-with-Fermions-1"></a><a class="docs-heading-anchor-permalink" href="#Dealing-with-Fermions" title="Permalink"></a></h1><p>TeNLib.jl uses the following function to teat fermionic operators.</p><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="TeNLib.bosonize-Union{Tuple{T}, Tuple{Vector{Pair{String, Int64}}, Array{Index{T}, 1}}} where T" href="#TeNLib.bosonize-Union{Tuple{T}, Tuple{Vector{Pair{String, Int64}}, Array{Index{T}, 1}}} where T"><code>TeNLib.bosonize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">function bosonize(oppair::Vector{Pair{String, Int}}, | ||
sites::Vector{Index{T}}) where T</code></pre><p>Given a string of operator names with positions in the form of <code>Vector{Pair{String, Int}}</code> "bosonizes" the operator string by putting the Jordan-Wigner string "F" at appropriate places.</p><p><strong>Arguments</strong></p><ul><li><code>oppair::Vector{Pair{String, Int}}</code>: Input string of operator names with positions.</li><li><code>sites::Vector{Index}</code>: The entire site <code>Index</code>s as per ITensors' convention.</li></ul><p><strong>Return values</strong></p><ul><li><code>::Int</code>: Even (+1) or odd (-1) permutation.</li><li><code>::Vector{Pair{String, Int}}</code>: modified string of operator names and positions.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/titaschanda/TeNLib.jl/blob/59efe08ba3eb4062e8048f3f97564e79c3f727e4/src/base/fermions.jl#L15-L29">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../global/">« Controlling global behaviors</a><a class="docs-footer-nextpage" href="../opstrings/">OpStrings »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 21:54">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
sites::Vector{Index{T}}) where T</code></pre><p>Given a string of operator names with positions in the form of <code>Vector{Pair{String, Int}}</code> "bosonizes" the operator string by putting the Jordan-Wigner string "F" at appropriate places.</p><p><strong>Arguments</strong></p><ul><li><code>oppair::Vector{Pair{String, Int}}</code>: Input string of operator names with positions.</li><li><code>sites::Vector{Index}</code>: The entire site <code>Index</code>s as per ITensors' convention.</li></ul><p><strong>Return values</strong></p><ul><li><code>::Int</code>: Even (+1) or odd (-1) permutation.</li><li><code>::Vector{Pair{String, Int}}</code>: modified string of operator names and positions.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/titaschanda/TeNLib.jl/blob/2e654263085a7b83f2d9edaea7f05848a18d91e1/src/base/fermions.jl#L15-L29">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../global/">« Controlling global behaviors</a><a class="docs-footer-nextpage" href="../opstrings/">OpStrings »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 26 December 2023 22:02">Tuesday 26 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.