build based on aa6522c

dev/lib/GV/index.html

@@ -5,12 +5,12 @@
 
 Generates a `Vector{FeynmanGraph}`: the given-`type` diagrams with static interactions of a given order, where the actual order of diagrams equals to `order + VerOrder + 2 * GOrder`.
 Generates a `LabelProduct`: `labelProd` with inputs `tau_labels` and all the possible momenta-loop basis. 
-Generates external tau labels Vector{Vector{Int}}. The i-th labels (Vector{Int}) corresponds to the i-th `FeynmanGraph` in `Vector{FeynmanGraph}`.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>type</code> (Symbol): The type of the diagrams, including <code>:spinPolar</code>, <code>:chargePolar</code>, <code>:sigma</code>, <code>:green</code>, or <code>:freeEnergy</code>.</li><li><code>order</code> (Int): The order of the diagrams without counterterms.</li><li><code>GOrder</code> (Int, optional): The order of self-energy counterterms (defaults to 0).</li><li><code>VerOrder</code> (Int, optional): The order of interaction counterterms (defaults to 0).</li><li><code>labelProd</code> (Union{Nothing,LabelProduct}=nothing, optional): The initial cartesian QuantumOperator.label product (defaults to <code>nothing</code>).</li><li><code>spinPolarPara</code> (Float64, optional): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>tau_labels</code>(Union{Nothing, Vector{Int}}, optional): The labels for the discrete time of each vertex. (defaults to <code>nothing</code>).</li></ul><p><strong>Returns</strong></p><p>A tuple <code>(diagrams, fermi_labelProd, bose_labelProd, extT_labels)</code> where </p><ul><li><code>diagrams</code> is a <code>Vector{FeynmanGraph}</code> object representing the diagrams, </li><li><code>labelProd</code> is a <code>LabelProduct</code> object containing the labels for the leaves of graphs, </li><li><code>extT_labels</code> is a <code>Vector{Union{Tuple,Vector{Int}}}</code> object containing the external tau labels for each <code>FeynmanGraph</code> in <code>diagrams</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/29d18269fb58822e92abd161a2f6e2a5032d1a45/src/frontend/GV.jl#L28-L51">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FeynmanDiagram.FrontEnds.GV.diagsGV_ver4-Tuple{Int64}" href="#FeynmanDiagram.FrontEnds.GV.diagsGV_ver4-Tuple{Int64}"><code>FeynmanDiagram.FrontEnds.GV.diagsGV_ver4</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">function diagsGV_ver4(order::Int; spinPolarPara::Float64=0.0, filter::Vector{Filter}=[NoHartree], channels=[PHr, PHEr, PPr, Alli])
+Generates external tau labels Vector{Vector{Int}}. The i-th labels (Vector{Int}) corresponds to the i-th `FeynmanGraph` in `Vector{FeynmanGraph}`.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>type</code> (Symbol): The type of the diagrams, including <code>:spinPolar</code>, <code>:chargePolar</code>, <code>:sigma</code>, <code>:green</code>, or <code>:freeEnergy</code>.</li><li><code>order</code> (Int): The order of the diagrams without counterterms.</li><li><code>GOrder</code> (Int, optional): The order of self-energy counterterms (defaults to 0).</li><li><code>VerOrder</code> (Int, optional): The order of interaction counterterms (defaults to 0).</li><li><code>labelProd</code> (Union{Nothing,LabelProduct}=nothing, optional): The initial cartesian QuantumOperator.label product (defaults to <code>nothing</code>).</li><li><code>spinPolarPara</code> (Float64, optional): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>tau_labels</code>(Union{Nothing, Vector{Int}}, optional): The labels for the discrete time of each vertex. (defaults to <code>nothing</code>).</li></ul><p><strong>Returns</strong></p><p>A tuple <code>(diagrams, fermi_labelProd, bose_labelProd, extT_labels)</code> where </p><ul><li><code>diagrams</code> is a <code>Vector{FeynmanGraph}</code> object representing the diagrams, </li><li><code>labelProd</code> is a <code>LabelProduct</code> object containing the labels for the leaves of graphs, </li><li><code>extT_labels</code> is a <code>Vector{Union{Tuple,Vector{Int}}}</code> object containing the external tau labels for each <code>FeynmanGraph</code> in <code>diagrams</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/aa6522cbc4ace6bf14d43b27e7ee89416b7503f8/src/frontend/GV.jl#L28-L51">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FeynmanDiagram.FrontEnds.GV.diagsGV_ver4-Tuple{Int64}" href="#FeynmanDiagram.FrontEnds.GV.diagsGV_ver4-Tuple{Int64}"><code>FeynmanDiagram.FrontEnds.GV.diagsGV_ver4</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">function diagsGV_ver4(order::Int; spinPolarPara::Float64=0.0, filter::Vector{Filter}=[NoHartree], channels=[PHr, PHEr, PPr, Alli])
 
-Generates a `Vector{Graph}`: the 4-point vertex diagrams with static interactions of a given order.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>order</code> (Int): The order of the diagrams without counterterms.</li><li><code>spinPolarPara</code> (Float64, optional): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>channels</code> (optional): The channels for the diagrams, defaults to <code>[PHr, PHEr, PPr, Alli]</code>.</li><li><code>filter</code> (optional): Filter criteria for the diagrams, defaults to <code>[NoHartree]</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/29d18269fb58822e92abd161a2f6e2a5032d1a45/src/frontend/GV.jl#L77-L87">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FeynmanDiagram.FrontEnds.GV.read_diagrams-Tuple{AbstractString}" href="#FeynmanDiagram.FrontEnds.GV.read_diagrams-Tuple{AbstractString}"><code>FeynmanDiagram.FrontEnds.GV.read_diagrams</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">function read_diagrams(filename::AbstractString; loopPool::Union{LoopPool,Nothing}=nothing,
+Generates a `Vector{Graph}`: the 4-point vertex diagrams with static interactions of a given order.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>order</code> (Int): The order of the diagrams without counterterms.</li><li><code>spinPolarPara</code> (Float64, optional): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>channels</code> (optional): The channels for the diagrams, defaults to <code>[PHr, PHEr, PPr, Alli]</code>.</li><li><code>filter</code> (optional): Filter criteria for the diagrams, defaults to <code>[NoHartree]</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/aa6522cbc4ace6bf14d43b27e7ee89416b7503f8/src/frontend/GV.jl#L77-L87">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FeynmanDiagram.FrontEnds.GV.read_diagrams-Tuple{AbstractString}" href="#FeynmanDiagram.FrontEnds.GV.read_diagrams-Tuple{AbstractString}"><code>FeynmanDiagram.FrontEnds.GV.read_diagrams</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">function read_diagrams(filename::AbstractString; loopPool::Union{LoopPool,Nothing}=nothing,
     dim::Int=3, tau_labels::Union{Nothing,Vector{Int}}=nothing, GTypes=[0, 1], VTypes=[0, 1, 2],
     keywords::Vector{String}=[&quot;Polarization&quot;, &quot;DiagNum&quot;, &quot;Order&quot;, &quot;GNum&quot;, &quot;Ver4Num&quot;, &quot;LoopNum&quot;, &quot;ExtLoopIndex&quot;,
         &quot;DummyLoopIndex&quot;, &quot;TauNum&quot;, &quot;ExtTauIndex&quot;, &quot;DummyTauIndex&quot;])
 
 Reads a GV_diagrams file and returns FeynmanGraph of diagrams in this file 
-and the corresponding `LabelProduct` objects, which are used to keep track of QuantumOperator.label.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>filename</code> (AbstractString): The path to the file containing the diagrams.</li><li><code>loopPool</code> (Union{LoopPool,Nothing}): An optional <code>LoopPool</code> object. If not provided, a new one will be created.</li><li><code>spinPolarPara</code> (Float64): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>dim</code> (Int): The dimension of the system, used to initialize the <code>LoopPool</code> object. Default is 3.</li><li><code>tau_labels</code> (Union{Nothing,Vector{Int}}): The labels for the <code>Tau</code> objects in the diagrams. If not provided, they will be set to the integers from 1 to <code>tauNum</code>.</li><li><code>GTypes</code> (Vector{Int}): The labels for the fermionic <code>G</code> objects in the diagrams. Default is <code>[0, 1]</code>.</li><li><code>VTypes</code> (Vector{Int}): The labels for the bosonic <code>V</code> objects in the diagrams. Default is <code>[0, 1, 2]</code>.</li><li><code>keywords</code> (Vector{String}): A set of keywords used to extract information from the file. Default is <code>[&quot;Polarization&quot;, &quot;DiagNum&quot;, &quot;Order&quot;, &quot;GNum&quot;, &quot;Ver4Num&quot;, &quot;LoopNum&quot;, &quot;ExtLoopIndex&quot;, &quot;DummyLoopIndex&quot;, &quot;TauNum&quot;, &quot;ExtTauIndex&quot;, &quot;DummyTauIndex&quot;]</code>.</li></ul><p><strong>Returns</strong></p><p>A tuple <code>(diagrams, fermi_labelProd, bose_labelProd)</code> where </p><ul><li><code>diagrams</code> is a <code>FeynmanGraph</code> object representing the diagrams, </li><li><code>fermi_labelProd</code> is a <code>LabelProduct</code> object containing the labels for the fermionic <code>G</code> objects in the diagrams, </li><li><code>bose_labelProd</code> is a <code>LabelProduct</code> object containing the labels for the bosonic <code>W</code> objects in the diagrams.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/29d18269fb58822e92abd161a2f6e2a5032d1a45/src/frontend/GV_diagrams/readfile.jl#L87-L111">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../frontend/">« Front-end generates Feynman diagrams and translates then into a computational graph</a><a class="docs-footer-nextpage" href="../parquet/">Parquet Algorithm to Build Diagrams »</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.10 on <span class="colophon-date" title="Friday 23 February 2024 14:56">Friday 23 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+and the corresponding `LabelProduct` objects, which are used to keep track of QuantumOperator.label.</code></pre><p><strong>Arguments:</strong></p><ul><li><code>filename</code> (AbstractString): The path to the file containing the diagrams.</li><li><code>loopPool</code> (Union{LoopPool,Nothing}): An optional <code>LoopPool</code> object. If not provided, a new one will be created.</li><li><code>spinPolarPara</code> (Float64): The spin-polarization parameter (n<em>up - n</em>down) / (n<em>up + n</em>down) (defaults to <code>0.0</code>).</li><li><code>dim</code> (Int): The dimension of the system, used to initialize the <code>LoopPool</code> object. Default is 3.</li><li><code>tau_labels</code> (Union{Nothing,Vector{Int}}): The labels for the <code>Tau</code> objects in the diagrams. If not provided, they will be set to the integers from 1 to <code>tauNum</code>.</li><li><code>GTypes</code> (Vector{Int}): The labels for the fermionic <code>G</code> objects in the diagrams. Default is <code>[0, 1]</code>.</li><li><code>VTypes</code> (Vector{Int}): The labels for the bosonic <code>V</code> objects in the diagrams. Default is <code>[0, 1, 2]</code>.</li><li><code>keywords</code> (Vector{String}): A set of keywords used to extract information from the file. Default is <code>[&quot;Polarization&quot;, &quot;DiagNum&quot;, &quot;Order&quot;, &quot;GNum&quot;, &quot;Ver4Num&quot;, &quot;LoopNum&quot;, &quot;ExtLoopIndex&quot;, &quot;DummyLoopIndex&quot;, &quot;TauNum&quot;, &quot;ExtTauIndex&quot;, &quot;DummyTauIndex&quot;]</code>.</li></ul><p><strong>Returns</strong></p><p>A tuple <code>(diagrams, fermi_labelProd, bose_labelProd)</code> where </p><ul><li><code>diagrams</code> is a <code>FeynmanGraph</code> object representing the diagrams, </li><li><code>fermi_labelProd</code> is a <code>LabelProduct</code> object containing the labels for the fermionic <code>G</code> objects in the diagrams, </li><li><code>bose_labelProd</code> is a <code>LabelProduct</code> object containing the labels for the bosonic <code>W</code> objects in the diagrams.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/numericalEFT/FeynmanDiagram.jl/blob/aa6522cbc4ace6bf14d43b27e7ee89416b7503f8/src/frontend/GV_diagrams/readfile.jl#L87-L111">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../frontend/">« Front-end generates Feynman diagrams and translates then into a computational graph</a><a class="docs-footer-nextpage" href="../parquet/">Parquet Algorithm to Build Diagrams »</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.10 on <span class="colophon-date" title="Monday 11 March 2024 22:46">Monday 11 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>