Skip to content

Commit f2ebe8c

Browse files
committed
Remove redudant constructor from interface
1 parent ad24342 commit f2ebe8c

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

docs/src/deprecated_methods.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ Suggestions of methods which could be deleted.
1111
ITensorNetwork{V}()
1212
```
1313

14+
* (Only actually deprecate / delete this function if the more generic constructor `ITensorNetwork(tensors)` can also handle this case.)
15+
From a vector of `ITensor`s, with vertex labels auto-assigned to `eachindex(ts)`.
16+
Edges are inferred from shared indices (`itensornetwork.jl`):
17+
```julia
18+
ITensorNetwork(ts::AbstractVector{ITensor})
19+
```
20+
1421
* From a collection of ITensorNetworks. Merges (Kronecker or tensor product) of input networks (`itensornetwork.jl`):
1522
```julia
1623
ITensorNetwork(itns::Vector{ITensorNetwork})

docs/src/interface_methods.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Recommended methods for building applications on top of ITensorNetworks.
77
These ITensorNetwork constructor interfaces are foundational to other constructors:
88

99
* From dictionary-like objects, including other `ITensorNetwork` objects, or a `Dict`
10-
from vertices to `ITensor`.
10+
from vertices to `ITensor`. The `tensors` can be a collection of `ITensor`s in which case
11+
the vertex labels are auto-assigned to `eachindex(tensors)` and edges are inferred
12+
from shared indices between the `ITensor`s.
1113
```julia
1214
# `keys(tensors)` are vertices, `values(tensors)` are tensors on those vertices
1315
ITensorNetwork(tensors)
@@ -20,11 +22,6 @@ These ITensorNetwork constructor interfaces are foundational to other constructo
2022
ITensorNetwork{V}(vertices, tensors)
2123
```
2224

23-
* From a vector of `ITensor`s, with vertex labels auto-assigned to `eachindex(ts)`.
24-
Edges are inferred from shared indices (`itensornetwork.jl`):
25-
```julia
26-
ITensorNetwork(ts::AbstractVector{ITensor})
27-
```
2825

2926
## Analyzing ITensorNetworks
3027

0 commit comments

Comments
 (0)