Skip to content

Commit 02f208c

Browse files
change entanglement_spectrum docstring
1 parent 235fbe3 commit 02f208c

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/algorithms/toolbox.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,17 +86,21 @@ function transfer_spectrum(above::InfiniteMPS; below=above, tol=Defaults.tol, nu
8686
end
8787

8888
"""
89-
entanglement_spectrum(ψ, [site::Int=0]) -> SectorDict{sectortype(ψ),Vector{<:Real}}
89+
entanglement_spectrum(ψ, site::Int) -> SectorDict{sectortype(ψ),Vector{<:Real}}
9090
9191
Compute the entanglement spectrum at a given site, i.e. the singular values of the gauge
9292
matrix to the right of a given site. This is a dictionary mapping the charge to the singular
9393
values.
94+
95+
For `InfiniteMPS` and `WindowMPS` the default value for `site` is 0.
96+
97+
For `FiniteMPS` no default value for `site` is given, it is up to the user to specify.
9498
"""
9599
function entanglement_spectrum(st::Union{InfiniteMPS,WindowMPS}, site::Int=0)
96100
checkbounds(st, site)
97101
return LinearAlgebra.svdvals(st.C[site])
98102
end
99-
function entanglement_spectrum(st::Union{FiniteMPS}, site::Int=1)
103+
function entanglement_spectrum(st::FiniteMPS, site::Int)
100104
checkbounds(st, site)
101105
return LinearAlgebra.svdvals(st.C[site])
102106
end

0 commit comments

Comments
 (0)