Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fix QN Index docs regarding dir keyword argument #1615

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[DOCS] Fix QN Index docs regarding dir keyword argument #1615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensors"
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
version = "0.8.0"
version = "0.8.1"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
9 changes: 4 additions & 5 deletions src/qn/qnindex.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,25 +139,24 @@ function Index(qnblocks::QNBlocks; dir::Arrow=Out, tags="", plev=0)
end

"""
Index(qnblocks::Vector{Pair{QN, Int64}}, tags; dir::Arrow = Out,
plev::Integer = 0)
Index(qnblocks::Vector{Pair{QN, Int64}}, tags; plev::Integer = 0)

Construct a QN Index from a Vector of pairs of QN and block
dimensions.

# Example

```
Index([QN("Sz", -1) => 1, QN("Sz", 1) => 1], "i"; dir = In)
i = Index([QN("Sz", -1) => 1, QN("Sz", 1) => 1], "i")
idag = dag(i) # Same Index with arrow direction flipped
```
"""
function Index(qnblocks::QNBlocks, tags; dir::Arrow=Out, plev::Integer=0)
return Index(qnblocks; dir=dir, tags=tags, plev=plev)
end

"""
Index(qnblocks::Pair{QN, Int64}...; dir::Arrow = Out,
tags = "",
Index(qnblocks::Pair{QN, Int64}...; tags = "",
plev::Integer = 0)

Construct a QN Index from a list of pairs of QN and block
Expand Down
Loading