1) Split Essentials.Extensions and merge the parts into `Essentials…

….Terms`, `Essentials.FockPackage` and `Essentials.SpinPackage`; 2) Introduce `Essentials.Terms.AbstractGenerator`, modify the methods with `Essentials.Terms.Generator` for future extensions.
Quantum-Many-Body · May 3, 2019 · 6c56dbb · 6c56dbb
1 parent 1d1994b
commit 6c56dbb
Show file tree

Hide file tree

Showing 20 changed files with 630 additions and 610 deletions.
diff --git a/Manifest.toml b/Manifest.toml
@@ -33,24 +33,6 @@ version = "0.8.0"
 deps = ["Random", "Serialization", "Sockets"]
 uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 
-[[DocStringExtensions]]
-deps = ["LibGit2", "Markdown", "Pkg", "Test"]
-git-tree-sha1 = "4d30e889c9f106a51ffa4791a88ffd4765bf20c3"
-uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
-version = "0.7.0"
-
-[[Documenter]]
-deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "Pkg", "REPL", "Random", "Test", "Unicode"]
-git-tree-sha1 = "13a6d15102410d8e70146533b759fc48d844a1d0"
-uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-version = "0.22.3"
-
-[[DocumenterTools]]
-deps = ["Base64", "DocStringExtensions", "LibGit2", "Pkg", "Test"]
-git-tree-sha1 = "f5803a9c2c23ff226e8eab2df7ac4c75e77a0d53"
-uuid = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
-version = "0.1.0"
-
 [[Formatting]]
 deps = ["Compat"]
 git-tree-sha1 = "6b5c29ec39a54fa823beb31f836431969e83fb74"
@@ -61,11 +43,11 @@ version = "0.3.4"
 deps = ["Markdown"]
 uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 
-[[JSON]]
-deps = ["Dates", "Distributed", "Mmap", "Sockets", "Test", "Unicode"]
-git-tree-sha1 = "1f7a25b53ec67f5e9422f1f551ee216503f4a0fa"
-uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
-version = "0.20.0"
+[[LaTeXStrings]]
+deps = ["Compat"]
+git-tree-sha1 = "7ab9b8788cfab2bdde22adf9004bda7ad9954b6c"
+uuid = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
+version = "1.0.3"
 
 [[LibGit2]]
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"

diff --git a/Project.toml b/Project.toml
@@ -6,6 +6,7 @@ version = "0.1.0"
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Formatting = "59287772-0a20-5a39-b81b-1366585eb4c0"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 NearestNeighbors = "b8a86587-4115-5ab1-83bc-aa920d37bbce"

diff --git a/README.md b/README.md
@@ -49,6 +49,9 @@ For tutorials and munuals of this pacakge, please refer to its docs.
 - [**LATEST**][docs-latest-url] &mdash; **documentation of the latest version.**
 - [**STABLE**][docs-stable-url] &mdash; **documentation of the stable version.**
 
+## Note
+
+Due to the fast development of this package, releases with different minor version numbers are **not** guaranteed to be compatible with previous ones **before** the release of v1.0.0. Comments are welcomed in the issues.
 
 ## Contact
 [email protected]

diff --git a/docs/make.jl b/docs/make.jl
@@ -43,7 +43,6 @@ makedocs(
                         "man/Essentials/Terms.md",
                         "man/Essentials/FockPackage.md",
                         "man/Essentials/SpinPackage.md",
-                        "man/Essentials/Extensions.md",
                         ],
                     ],
                 ]

diff --git a/docs/src/man/Essentials/Extensions.md b/docs/src/man/Essentials/Extensions.md
diff --git a/docs/src/man/Essentials/Introduction.md b/docs/src/man/Essentials/Introduction.md
@@ -13,7 +13,6 @@ Pages=  [
         "Terms.md",
         "FockPackage.md",
         "SpinPackage.md",
-        "Extensions.md",
         ]
 Depth=2
 ```
diff --git a/src/Essentials/DegreesOfFreedom.jl b/src/Essentials/DegreesOfFreedom.jl
@@ -10,6 +10,7 @@ using ...Prerequisites.CompositeStructures: CompositeDict
 using ...Mathematics.VectorSpaces: VectorSpace
 using ...Mathematics.AlgebraOverFields: SimpleID,ID,Element,Elements
 
+import LaTeXStrings: latexstring
 import ..Spatials: pidtype,rcoord,icoord
 import ...Interfaces: reset!,update!,sequence
 import ...Mathematics.AlgebraOverFields: rawelement
@@ -638,6 +639,17 @@ function twist(operator::Operator,vectors::AbstractVector{<:AbstractVector{Float
     replace(operator,value=operator.value*exp(1im*angle(operator.id,vectors,values)))
 end
 
+"""
+    latexstring(oid::OID,l::Union{LaTeX,Nothing}=nothing) -> LaTeXStrings.LaTeXString
+    latexstring(opt::Operator,l::Union{LaTeX,Nothing}=nothing) -> LaTeXStrings.LaTeXString
+    latexstring(opts::Operators,l::Union{LaTeX,Nothing}=nothing) -> LaTeXStrings.LaTeXString
+
+Get the latexstring representation of an oid/operator/operators.
+"""
+latexstring(oid::OID,l::Union{LaTeX,Nothing}=nothing)=latexstring(repr(oid,l))
+latexstring(opt::Operator,l::Union{LaTeX,Nothing}=nothing)=latexstring(repr(opt,l))
+latexstring(opts::Operators,l::Union{LaTeX,Nothing}=nothing)=latexstring(repr(opts,l))
+
 """
     Boundary{Names}(values::AbstractVector{Float},vectors::AbstractVector{<:AbstractVector{Float}}) where Names
     Boundary()

diff --git a/src/Essentials/Essentials.jl b/src/Essentials/Essentials.jl
@@ -7,13 +7,11 @@ include("DegreesOfFreedom.jl")
 include("Terms.jl")
 include("FockPackage.jl")
 include("SpinPackage.jl")
-include("Extensions.jl")
 
 @reexport using .Spatials
 @reexport using .DegreesOfFreedom
 @reexport using .Terms
 @reexport using .FockPackage
 @reexport using .SpinPackage
-@reexport using .Extensions
 
 end # module