Skip to content

Commit 79adce4

Browse files
authored
[Docs] Update docs to ITensorMPS (#1603)
1 parent 795042b commit 79adce4

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/src/HDF5FileFormats.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Datasets and Subgroups:
156156

157157
## [MPS](@id mps_hdf5)
158158

159-
HDF5 file format for `ITensors.MPS`
159+
HDF5 file format for `ITensorMPS.MPS`
160160

161161
Attributes:
162162
* "version" = 1
@@ -171,7 +171,7 @@ Datasets and Subgroups:
171171

172172
## [MPO](@id mpo_hdf5)
173173

174-
HDF5 file format for `ITensors.MPO`
174+
HDF5 file format for `ITensorMPS.MPO`
175175

176176
Attributes:
177177
* "version" = 1

docs/src/Observer.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ In our example, we will just compare the `energy` keyword
7070
argument to the `last_energy` variable held inside the `DemoObserver`:
7171

7272
```julia
73-
function ITensors.checkdone!(o::DemoObserver;kwargs...)
73+
function ITensorMPS.checkdone!(o::DemoObserver;kwargs...)
7474
sw = kwargs[:sweep]
7575
energy = kwargs[:energy]
7676
if abs(energy-o.last_energy)/abs(energy) < o.energy_tol
@@ -110,7 +110,7 @@ that prints out some of the information above, but in a more realistic setting o
110110
could use the MPS `psi` to perform essentially arbitrary measurements.
111111

112112
```julia
113-
function ITensors.measure!(o::DemoObserver; kwargs...)
113+
function ITensorMPS.measure!(o::DemoObserver; kwargs...)
114114
energy = kwargs[:energy]
115115
sweep = kwargs[:sweep]
116116
bond = kwargs[:bond]
@@ -148,7 +148,7 @@ mutable struct DemoObserver <: AbstractObserver
148148
DemoObserver(energy_tol=0.0) = new(energy_tol,1000.0)
149149
end
150150

151-
function ITensors.checkdone!(o::DemoObserver;kwargs...)
151+
function ITensorMPS.checkdone!(o::DemoObserver;kwargs...)
152152
sw = kwargs[:sweep]
153153
energy = kwargs[:energy]
154154
if abs(energy-o.last_energy)/abs(energy) < o.energy_tol
@@ -160,7 +160,7 @@ function ITensors.checkdone!(o::DemoObserver;kwargs...)
160160
return false
161161
end
162162

163-
function ITensors.measure!(o::DemoObserver; kwargs...)
163+
function ITensorMPS.measure!(o::DemoObserver; kwargs...)
164164
energy = kwargs[:energy]
165165
sweep = kwargs[:sweep]
166166
bond = kwargs[:bond]

docs/src/examples/DMRG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ using ITensors, ITensorMPS
383383
mutable struct EntanglementObserver <: AbstractObserver
384384
end
385385

386-
function ITensors.measure!(o::EntanglementObserver; bond, psi, half_sweep, kwargs...)
386+
function ITensorMPS.measure!(o::EntanglementObserver; bond, psi, half_sweep, kwargs...)
387387
wf_center, other = half_sweep==1 ? (psi[bond+1],psi[bond]) : (psi[bond],psi[bond+1])
388388
U,S,V = svd(wf_center, uniqueinds(wf_center,other))
389389
SvN = 0.0
@@ -406,7 +406,7 @@ using ITensors, ITensorMPS
406406
mutable struct EntanglementObserver <: AbstractObserver
407407
end
408408

409-
function ITensors.measure!(o::EntanglementObserver; bond, psi, half_sweep, kwargs...)
409+
function ITensorMPS.measure!(o::EntanglementObserver; bond, psi, half_sweep, kwargs...)
410410
wf_center, other = half_sweep==1 ? (psi[bond+1],psi[bond]) : (psi[bond],psi[bond+1])
411411
U,S,V = svd(wf_center, uniqueinds(wf_center,other))
412412
SvN = 0.0
@@ -481,7 +481,7 @@ using ITensors, ITensorMPS
481481
mutable struct SizeObserver <: AbstractObserver
482482
end
483483

484-
function ITensors.measure!(o::SizeObserver; bond, half_sweep, psi, projected_operator, kwargs...)
484+
function ITensorMPS.measure!(o::SizeObserver; bond, half_sweep, psi, projected_operator, kwargs...)
485485
if bond==1 && half_sweep==2
486486
psi_size = Base.format_bytes(Base.summarysize(psi))
487487
PH_size = Base.format_bytes(Base.summarysize(projected_operator))
@@ -503,7 +503,7 @@ using ITensors, ITensorMPS
503503
mutable struct SizeObserver <: AbstractObserver
504504
end
505505

506-
function ITensors.measure!(o::SizeObserver; bond, sweep, half_sweep, psi, projected_operator, kwargs...)
506+
function ITensorMPS.measure!(o::SizeObserver; bond, sweep, half_sweep, psi, projected_operator, kwargs...)
507507
if bond==1 && half_sweep==2
508508
psi_size = Base.format_bytes(Base.summarysize(psi))
509509
PH_size = Base.format_bytes(Base.summarysize(projected_operator))

0 commit comments

Comments
 (0)