Skip to content

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

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

Merged
merged 3 commits into from
Mar 20, 2025
Merged

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

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73d196b
[DOCS] Fix QN Index docs regarding `dir` keyword argument
mtfishman Feb 9, 2025
d1dd84c
Merge branch 'main' into ITensors_qnindex_docs
mtfishman Mar 20, 2025
8c76e20
Bump to v0.8.2
mtfishman Mar 20, 2025
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
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