Skip to content

Commit 23957ec

Browse files
committed
Remove references to set_orth_region in docstrings
1 parent 6fa8e43 commit 23957ec

3 files changed

Lines changed: 5 additions & 14 deletions

File tree

docs/src/tree_tensor_networks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and provides a convenient interface for 1D calculations.
2020

2121
```@example main
2222
using NamedGraphs.NamedGraphGenerators: named_comb_tree
23-
using ITensorNetworks: ITensorNetwork, TreeTensorNetwork, siteinds, ttn, random_ttn, mps, random_mps, orthogonalize, ortho_region, set_ortho_region, add
23+
using ITensorNetworks: ITensorNetwork, TreeTensorNetwork, siteinds, ttn, random_ttn, mps, random_mps, orthogonalize, ortho_region, add
2424
import ITensors
2525
using Graphs: vertices, edges
2626
using LinearAlgebra: norm

src/treetensornetworks/abstracttreetensornetwork.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ julia> psi = orthogonalize(psi, [vs[1], vs[2]]);
6969
7070
```
7171
72-
See also: [`set_ortho_region`](@ref), [`ortho_region`](@ref), [`truncate`](@ref).
72+
See also: [`ortho_region`](@ref), [`truncate`](@ref).
7373
"""
7474
function orthogonalize(ttn::AbstractTTN, region; kwargs...)
7575
return gauge(Algorithm("orthogonalize"), ttn, region; kwargs...)

src/treetensornetworks/treetensornetwork.jl

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ ITensorNetwork(tn::TTN) = getfield(tn, :tensornetwork)
9292
9393
Return the set of vertices that currently form the orthogonality center of `tn`.
9494
95-
See also: [`orthogonalize`](@ref), [`set_ortho_region`](@ref).
95+
See also: [`orthogonalize`](@ref).
9696
"""
9797
ortho_region(tn::TTN) = getfield(tn, :ortho_region)
9898

@@ -111,17 +111,8 @@ end
111111
# Constructor
112112
#
113113

114-
"""
115-
set_ortho_region(tn::TreeTensorNetwork, ortho_region) -> TreeTensorNetwork
116-
117-
Return a copy of `tn` with the `ortho_region` metadata updated to `ortho_region`,
118-
**without** performing any gauge transformations on the tensors.
119-
120-
This is a low-level bookkeeping update. To actually move the orthogonality center by
121-
applying QR decompositions along the tree, use [`orthogonalize`](@ref).
122-
123-
See also: [`ortho_region`](@ref), [`orthogonalize`](@ref).
124-
"""
114+
# set_ortho_region: low-level update of the ortho_region metadata only,
115+
# without any gauge transformations. To move the orthogonality center use orthogonalize.
125116
function set_ortho_region(tn::TTN, ortho_region)
126117
return ttn(ITensorNetwork(tn); ortho_region)
127118
end

0 commit comments

Comments
 (0)