Rename TensorNetwork to ITensorNetwork and adopt the v0.10 next-generation stack (#125)

## Summary

Renames the `TensorNetwork` type to `ITensorNetwork`, along with
`AbstractTensorNetwork` and the `TensorNetworkGenerators` submodule, to
match the package name and the naming used across the next-generation
stack.

Moves the package onto the v0.10 next-generation stack: ITensorBase
v0.7, TensorAlgebra v0.10, and GradedArrays v0.10. Factorization call
sites move to the namespaces where ITensorBase defines its named-tensor
methods (MatrixAlgebraKit for `qr_compact` and `svd_trunc`,
`TensorAlgebra.MatrixAlgebra` for the Gram factorizations), and the
named-axis helpers follow ITensorBase's v0.7 renames.

This is a breaking release (`0.7.0`).

Author: mtfishman

Project.toml

@@ -1,6 +1,6 @@
 name = "ITensorNetworksNext"
 uuid = "302f2e75-49f0-4526-aef7-d8ba550cb06c"
-version = "0.6.1"
+version = "0.7.0"
 authors = ["ITensor developers <support@itensor.org> and contributors"]
 
 [workspace]
@@ -30,13 +30,13 @@ Combinatorics = "1"
 DataGraphs = "0.4"
 Dictionaries = "0.4.5"
 Graphs = "1.13.1"
-ITensorBase = "0.6.3"
+ITensorBase = "0.7"
 LinearAlgebra = "1.10"
 MacroTools = "0.5.16"
 MatrixAlgebraKit = "0.6"
 NamedGraphs = "0.11"
 Random = "1.10"
 SimpleTraits = "0.9.5"
 SplitApplyCombine = "1.2.3"
-TensorAlgebra = "0.9.7"
+TensorAlgebra = "0.10"
 julia = "1.10"

docs/Project.toml

@@ -10,5 +10,5 @@ path = ".."
 [compat]
 Documenter = "1"
 ITensorFormatter = "0.2.27"
-ITensorNetworksNext = "0.6"
+ITensorNetworksNext = "0.7"
 Literate = "2"

docs/src/reference.md

@@ -1,5 +1,5 @@
 # Reference
 
 ```@autodocs
-Modules = [ITensorNetworksNext, ITensorNetworksNext.TensorNetworkGenerators]
+Modules = [ITensorNetworksNext, ITensorNetworksNext.ITensorNetworkGenerators]
 ```

examples/Project.toml

@@ -5,4 +5,4 @@ ITensorNetworksNext = "302f2e75-49f0-4526-aef7-d8ba550cb06c"
 path = ".."
 
 [compat]
-ITensorNetworksNext = "0.6"
+ITensorNetworksNext = "0.7"

…orkGenerators/TensorNetworkGenerators.jl …rkGenerators/ITensorNetworkGenerators.jlsrc/TensorNetworkGenerators/TensorNetworkGenerators.jl renamed to src/ITensorNetworkGenerators/ITensorNetworkGenerators.jl src/TensorNetworkGenerators/TensorNetworkGenerators.jl renamed to src/ITensorNetworkGenerators/ITensorNetworkGenerators.jl

@@ -1,4 +1,4 @@
-module TensorNetworkGenerators
+module ITensorNetworkGenerators
 
 export delta_network, ising_network
 

…TensorNetworkGenerators/delta_network.jl …TensorNetworkGenerators/delta_network.jlsrc/TensorNetworkGenerators/delta_network.jl renamed to src/ITensorNetworkGenerators/delta_network.jl src/TensorNetworkGenerators/delta_network.jl renamed to src/ITensorNetworkGenerators/delta_network.jl

@@ -1,6 +1,6 @@
-using ..ITensorNetworksNext: TensorNetwork
+using ..ITensorNetworksNext: ITensorNetwork
 using Graphs: AbstractGraph
-using ITensorBase: NamedUnitRange, denamed, name, nameddims
+using ITensorBase: NamedUnitRange, name, nameddims, unnamed
 using NamedGraphs.GraphsExtensions: incident_edges
 
 diaglength(a::AbstractArray) = minimum(size(a))
@@ -29,20 +29,20 @@ function diagonaltensor(
         diag::AbstractVector,
         is::Tuple{NamedUnitRange, Vararg{NamedUnitRange}}
     )
-    return nameddims(diagonaltensor(diag, denamed.(is)), name.(is))
+    return nameddims(diagonaltensor(diag, unnamed.(is)), name.(is))
 end
 
-delta(elt::Type, is) = diagonaltensor(ones(elt, minimum(length ∘ denamed, is)), is)
+delta(elt::Type, is) = diagonaltensor(ones(elt, minimum(length, is)), is)
 
 """
     delta_network(f, elt::Type = Float64, g::AbstractGraph)
 
-Construct a TensorNetwork on the graph `g` with element type `elt` that has delta tensors
+Construct a ITensorNetwork on the graph `g` with element type `elt` that has delta tensors
 on each vertex. Link dimensions are defined using the function `f(e)` that should take an
 edge `e` as an input and should output the link index on that edge.
 """
 function delta_network(f, elt::Type, g::AbstractGraph)
-    return tn = TensorNetwork(g) do v
+    return tn = ITensorNetwork(g) do v
         is = Tuple(f.(incident_edges(g, v)))
         return delta(elt, is)
     end

…TensorNetworkGenerators/ising_network.jl …TensorNetworkGenerators/ising_network.jlsrc/TensorNetworkGenerators/ising_network.jl renamed to src/ITensorNetworkGenerators/ising_network.jl src/TensorNetworkGenerators/ising_network.jl renamed to src/ITensorNetworkGenerators/ising_network.jl

@@ -18,7 +18,7 @@ end
 """
     ising_network(f, β::Number, g::AbstractGraph)
 
-Construct a TensorNetwork on the graph `g` with inverse temperature `β` that has Ising
+Construct a ITensorNetwork on the graph `g` with inverse temperature `β` that has Ising
 partition function tensors on each vertex. Link dimensions are defined using the function
 `f(e)` that should take an edge `e` as an input and should output the link index on that
 edge.

src/ITensorNetworksNext.jl

@@ -12,7 +12,7 @@ include("select_algorithm.jl")
 include("AlgorithmsInterfaceExtensions/AlgorithmsInterfaceExtensions.jl")
 include("abstracttensornetwork.jl")
 include("tensornetwork.jl")
-include("TensorNetworkGenerators/TensorNetworkGenerators.jl")
+include("ITensorNetworkGenerators/ITensorNetworkGenerators.jl")
 include("contract_network.jl")
 
 include("beliefpropagation/messagecache.jl")

src/abstracttensornetwork.jl

@@ -11,13 +11,13 @@ using NamedGraphs.GraphsExtensions: directed_graph, incident_edges, rem_edges!,
 using NamedGraphs.OrdinalIndexing: OrdinalSuffixedInteger
 using NamedGraphs: NamedGraphs, NamedGraph, not_implemented, similar_graph
 
-abstract type AbstractTensorNetwork{V, VD} <: AbstractDataGraph{V, VD, Nothing} end
+abstract type AbstractITensorNetwork{V, VD} <: AbstractDataGraph{V, VD, Nothing} end
 
 # Need to be careful about removing edges from tensor networks in case there is a bond
-Graphs.rem_edge!(::AbstractTensorNetwork, edge) = not_implemented()
+Graphs.rem_edge!(::AbstractITensorNetwork, edge) = not_implemented()
 
 # Graphs.jl overloads
-function Graphs.weights(graph::AbstractTensorNetwork)
+function Graphs.weights(graph::AbstractITensorNetwork)
     V = vertextype(graph)
     es = Tuple.(edges(graph))
     ws = Dictionary{Tuple{V, V}, Float64}(es, undef)
@@ -29,28 +29,28 @@ function Graphs.weights(graph::AbstractTensorNetwork)
 end
 
 # Copy
-Base.copy(::AbstractTensorNetwork) = not_implemented()
+Base.copy(::AbstractITensorNetwork) = not_implemented()
 
 # Iteration
-Base.iterate(tn::AbstractTensorNetwork, args...) = iterate(vertex_data(tn), args...)
-Base.keys(tn::AbstractTensorNetwork) = vertices(tn)
+Base.iterate(tn::AbstractITensorNetwork, args...) = iterate(vertex_data(tn), args...)
+Base.keys(tn::AbstractITensorNetwork) = vertices(tn)
 
 # TODO: This contrasts with the `DataGraphs.AbstractDataGraph` definition,
 # where it is defined as the `vertextype`. Does that cause problems or should it be changed?
-Base.eltype(tn::AbstractTensorNetwork) = eltype(vertex_data(tn))
+Base.eltype(tn::AbstractITensorNetwork) = eltype(vertex_data(tn))
 
 # Overload if needed
-Graphs.is_directed(::Type{<:AbstractTensorNetwork}) = false
+Graphs.is_directed(::Type{<:AbstractITensorNetwork}) = false
 
-DataGraphs.underlying_graph(::AbstractTensorNetwork) = not_implemented()
-function NamedGraphs.vertex_positions(tn::AbstractTensorNetwork)
+DataGraphs.underlying_graph(::AbstractITensorNetwork) = not_implemented()
+function NamedGraphs.vertex_positions(tn::AbstractITensorNetwork)
     return NamedGraphs.vertex_positions(underlying_graph(tn))
 end
-function NamedGraphs.ordered_vertices(tn::AbstractTensorNetwork)
+function NamedGraphs.ordered_vertices(tn::AbstractITensorNetwork)
     return NamedGraphs.ordered_vertices(underlying_graph(tn))
 end
 
-function Adapt.adapt_structure(to, tn::AbstractTensorNetwork)
+function Adapt.adapt_structure(to, tn::AbstractITensorNetwork)
     # TODO: Define and use:
     #
     # @preserve_graph map_vertex_data(adapt(to), tn)
@@ -135,14 +135,14 @@ macro preserve_graph(expr)
     return :(setindex_preserve_graph!($(esc(array)), $(esc(value)), $(esc.(indices)...)))
 end
 
-# Update the graph of the TensorNetwork `tn` to include
+# Update the graph of the ITensorNetwork `tn` to include
 # edges that should exist based on the tensor connectivity.
 function add_missing_edges!(tn::AbstractGraph)
     foreach(v -> add_missing_edges!(tn, v), vertices(tn))
     return tn
 end
 
-# Update the graph of the TensorNetwork `tn` to include
+# Update the graph of the ITensorNetwork `tn` to include
 # edges that should be incident to the vertex `v`
 # based on the tensor connectivity.
 function add_missing_edges!(tn::AbstractGraph, v)
@@ -157,13 +157,13 @@ function add_missing_edges!(tn::AbstractGraph, v)
     return tn
 end
 
-# Fix the edges of the TensorNetwork `tn` to match
+# Fix the edges of the ITensorNetwork `tn` to match
 # the tensor connectivity.
 function fix_edges!(tn::AbstractGraph)
     foreach(v -> fix_edges!(tn, v), vertices(tn))
     return tn
 end
-# Fix the edges of the TensorNetwork `tn` to match
+# Fix the edges of the ITensorNetwork `tn` to match
 # the tensor connectivity at vertex `v`.
 function fix_edges!(tn::AbstractGraph, v)
     for e in incident_edges(tn, v)
@@ -176,12 +176,12 @@ function fix_edges!(tn::AbstractGraph, v)
     return tn
 end
 
-using ITensorBase: denamedtype, named, nametype, uniquename
+using ITensorBase: named, nametype, uniquename, unnamedtype
 using TensorAlgebra: trivialrange
 function insertlink!(tn, e)
     add_edge!(tn, e)
     T = eltype(inds(tn[src(e)]))
-    l = named(trivialrange(denamedtype(T)), uniquename(nametype(T)))
+    l = named(trivialrange(unnamedtype(T)), uniquename(nametype(T)))
     x = fill!(similar(tn[src(e)], (l,)), one(eltype(tn[src(e)])))
     @preserve_graph tn[src(e)] = tn[src(e)] * x
     @preserve_graph tn[dst(e)] = tn[dst(e)] * conj(x)
@@ -202,28 +202,32 @@ function randlinknames(tn)
     return new_tn
 end
 
-function Base.setindex!(tn::AbstractTensorNetwork, value, v)
+function Base.setindex!(tn::AbstractITensorNetwork, value, v)
     @preserve_graph tn[v] = value
     fix_edges!(tn, v)
     return tn
 end
 # Fix ambiguity error.
-function Base.setindex!(graph::AbstractTensorNetwork, value, vertex::OrdinalSuffixedInteger)
+function Base.setindex!(
+        graph::AbstractITensorNetwork,
+        value,
+        vertex::OrdinalSuffixedInteger
+    )
     graph[vertices(graph)[vertex]] = value
     return graph
 end
-Base.setindex!(tn::AbstractTensorNetwork, value, edge::AbstractEdge) = not_implemented()
-Base.setindex!(tn::AbstractTensorNetwork, value, edge::Pair) = not_implemented()
+Base.setindex!(tn::AbstractITensorNetwork, value, edge::AbstractEdge) = not_implemented()
+Base.setindex!(tn::AbstractITensorNetwork, value, edge::Pair) = not_implemented()
 # Fix ambiguity error.
 function Base.setindex!(
-        tn::AbstractTensorNetwork,
+        tn::AbstractITensorNetwork,
         value,
         edge::Pair{<:OrdinalSuffixedInteger, <:OrdinalSuffixedInteger}
     )
     return not_implemented()
 end
 
-function Base.show(io::IO, mime::MIME"text/plain", graph::AbstractTensorNetwork)
+function Base.show(io::IO, mime::MIME"text/plain", graph::AbstractITensorNetwork)
     println(io, "$(typeof(graph)) with $(nv(graph)) vertices:")
     show(io, mime, vertices(graph))
     println(io, "\n")
@@ -238,4 +242,4 @@ function Base.show(io::IO, mime::MIME"text/plain", graph::AbstractTensorNetwork)
     return nothing
 end
 
-Base.show(io::IO, graph::AbstractTensorNetwork) = show(io, MIME"text/plain"(), graph)
+Base.show(io::IO, graph::AbstractITensorNetwork) = show(io, MIME"text/plain"(), graph)

src/apply/apply_operators.jl

@@ -5,8 +5,9 @@ using Graphs: dst, src, vertices
 using ITensorBase:
     ITensorBase as ITB, AbstractITensor, dimnames, domainnames, operator, replacedimnames
 using LinearAlgebra: norm
+using MatrixAlgebraKit: qr_compact, svd_trunc
 using NamedGraphs.GraphsExtensions: all_edges, boundary_edges
-using TensorAlgebra: TensorAlgebra as TA, gram_eigh_full, gram_eigh_full_with_pinv
+using TensorAlgebra.MatrixAlgebra: gram_eigh_full, gram_eigh_full_with_pinv
 
 # === Top-level user entry point ===
 
@@ -15,7 +16,7 @@ using TensorAlgebra: TensorAlgebra as TA, gram_eigh_full, gram_eigh_full_with_pi
 
 Apply each operator in `operators` (a sequence of single-tensor or two-tensor
 operators) to `state` in turn, updating `env` to reflect each application.
-`state` is an `AbstractTensorNetwork`, `env` is a per-edge environment cache
+`state` is an `AbstractITensorNetwork`, `env` is a per-edge environment cache
 (typically built by `identity_norm_message_env(state)` or one of the related
 `*_norm_message_env` constructors), and the returned `(state, env)` pair has
 the operators applied. `kwargs` are forwarded to the per-operator algorithm
@@ -205,8 +206,8 @@ end
 # === BP simple-update implementation ===
 
 function apply_gate_bp!(
-        dest::AbstractTensorNetwork, op::AbstractITensor,
-        state::AbstractTensorNetwork, env; kwargs...
+        dest::AbstractITensorNetwork, op::AbstractITensor,
+        state::AbstractITensorNetwork, env; kwargs...
     )
     op_in = domainnames(op)
     vs = [v for v in vertices(state) if !isempty(intersect(op_in, sitenames(state, v)))]
@@ -217,15 +218,15 @@ function apply_gate_bp!(
 end
 
 function apply_gate_bp_nsite!(
-        ::Val{N}, dest::AbstractTensorNetwork, op::AbstractITensor,
-        state::AbstractTensorNetwork, env, vs; kwargs...
+        ::Val{N}, dest::AbstractITensorNetwork, op::AbstractITensor,
+        state::AbstractITensorNetwork, env, vs; kwargs...
     ) where {N}
     return throw(ArgumentError("$N-site gate decomposition not implemented"))
 end
 
 function apply_gate_bp_nsite!(
-        ::Val{1}, dest::AbstractTensorNetwork, op::AbstractITensor,
-        state::AbstractTensorNetwork, env, vs;
+        ::Val{1}, dest::AbstractITensorNetwork, op::AbstractITensor,
+        state::AbstractITensorNetwork, env, vs;
         normalize, kwargs...
     )
     v = only(vs)
@@ -242,8 +243,8 @@ function apply_gate_bp_nsite!(
 end
 
 function apply_gate_bp_nsite!(
-        ::Val{2}, dest::AbstractTensorNetwork, op::AbstractITensor,
-        state::AbstractTensorNetwork, env, vs;
+        ::Val{2}, dest::AbstractITensorNetwork, op::AbstractITensor,
+        state::AbstractITensorNetwork, env, vs;
         trunc, normalize
     )
     v1, v2 = vs
@@ -258,10 +259,10 @@ function apply_gate_bp_nsite!(
     ψ_v1 = prod([[state[v1]]; gauges_v1])
     ψ_v2 = prod([[state[v2]]; gauges_v2])
 
-    Q_v1, R_v1 = TA.qr(ψ_v1, setdiff(dimnames(ψ_v1), dimnames(ψ_v2), dimnames(op)))
-    Q_v2, R_v2 = TA.qr(ψ_v2, setdiff(dimnames(ψ_v2), dimnames(ψ_v1), dimnames(op)))
+    Q_v1, R_v1 = qr_compact(ψ_v1, setdiff(dimnames(ψ_v1), dimnames(ψ_v2), dimnames(op)))
+    Q_v2, R_v2 = qr_compact(ψ_v2, setdiff(dimnames(ψ_v2), dimnames(ψ_v1), dimnames(op)))
     op_R_v1v2 = ITB.apply(op, R_v1 * R_v2)
-    U_v1, S, U_v2 = TA.svd(op_R_v1v2, setdiff(dimnames(R_v1), dimnames(R_v2)); trunc)
+    U_v1, S, U_v2 = svd_trunc(op_R_v1v2, setdiff(dimnames(R_v1), dimnames(R_v2)); trunc)
     if normalize
         S = S / norm(S)
     end