Skip to content

Drop stale doc references #370

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
mtfishman merged 2 commits into from
May 13, 2026
+2 −13
Merged

Drop stale doc references #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01d9f73
Drop stale visualize(::IndsNetwork) doc entry
mtfishman May 12, 2026
5b4d02e
Drop more stale doc references: data_graph_type, edge_data_eltype, se…
mtfishman May 13, 2026
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
5 changes: 0 additions & 5 deletions docs/src/developer_methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
* Graph plumbing forwarded to the underlying tensor network (`formnetworks/abstractformnetwork.jl`):
```julia
data_graph(f::AbstractFormNetwork)
data_graph_type(f::AbstractFormNetwork)
```

* Lists of vertices in each role: those tagged with the operator/bra/ket suffix (`formnetworks/abstractformnetwork.jl`):
Expand Down Expand Up @@ -142,7 +141,6 @@
ket_vertex_suffix(qf::QuadraticFormNetwork)
tensornetwork(qf::QuadraticFormNetwork)
data_graph(qf::QuadraticFormNetwork)
data_graph_type(qf::QuadraticFormNetwork)
```

* Copy a `QuadraticFormNetwork` (deep-copies the inner bilinear form) (`formnetworks/quadraticformnetwork.jl`):
Expand Down Expand Up @@ -185,7 +183,6 @@
(`caches/abstractbeliefpropagationcache.jl`):
```julia
# How many of these are user-facing versus internal?
setindex!(bpc::AbstractBeliefPropagationCache, factor::ITensor, vertex)
partitioned_tensornetwork(bpc::AbstractBeliefPropagationCache)
messages(bpc::AbstractBeliefPropagationCache)
copy(bpc::AbstractBeliefPropagationCache)
Expand All @@ -201,7 +198,6 @@
network behind a cache (`caches/abstractbeliefpropagationcache.jl`):
```julia
similar_type(bpc::AbstractBeliefPropagationCache)
data_graph_type(bpc::AbstractBeliefPropagationCache)
data_graph(bpc::AbstractBeliefPropagationCache)
tensornetwork(bpc::AbstractBeliefPropagationCache)
scalartype(bpc::AbstractBeliefPropagationCache)
Expand Down Expand Up @@ -372,7 +368,6 @@
```julia
copy(bp_cache::BeliefPropagationCache)
messages(bp_cache::BeliefPropagationCache)
setindex!(bpc::BeliefPropagationCache, factor::ITensor, vertex)
```

* Partition-graph related queries — list partitions, quotient edges between partitions, and
Expand Down
10 changes: 2 additions & 8 deletions docs/src/experimental_methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Methods which still need to be discussed, modified, or deprecated.
set_ortho_region(tn::AbstractTTN, new_region)
```

* Underlying-graph type forwarded to `data_graph_type` (`treetensornetworks/abstracttreetensornetwork.jl`):
* Underlying-graph type for `AbstractTTN` (`treetensornetworks/abstracttreetensornetwork.jl`):
```julia
underlying_graph_type(G::Type{<:AbstractTTN})
```
Expand Down Expand Up @@ -135,7 +135,6 @@ Methods which still need to be discussed, modified, or deprecated.
* `AbstractITensorNetwork` interface, forwarded to the wrapped `ITensorNetwork` (`treetensornetworks/treetensornetwork.jl`):
```julia
data_graph(tn::TTN)
data_graph_type(G::Type{<:TTN})
copy(tn::TTN)
```

Expand Down Expand Up @@ -179,7 +178,7 @@ Methods which still need to be discussed, modified, or deprecated.
```julia
vertex_data(graph::AbstractIndsNetwork, args...)
edge_data(graph::AbstractIndsNetwork, args...)
edge_data_eltype(::Type{<:AbstractIndsNetwork{V, I}}) where {V, I}
edge_data_type(::Type{<:AbstractIndsNetwork{V, I}}) where {V, I}
```

* Merge two `AbstractIndsNetwork`s, returning an `IndsNetwork` over the merged graph (`abstractindsnetwork.jl`):
Expand Down Expand Up @@ -261,11 +260,6 @@ Methods which still need to be discussed, modified, or deprecated.
map_inds(f, is::IndsNetwork, args...; sites = nothing, links = nothing, kwargs...)
```

* Visualize an `IndsNetwork` by wrapping it in a default `ITensorNetwork` (`indsnetwork.jl`):
```julia
visualize(is::IndsNetwork, args...; kwargs...)
```


## ProjTTN System

Expand Down
Loading