Contractnetwork -> contract_network

Author: JoeyT1994

Project.toml

@@ -1,7 +1,7 @@
 name = "ITensorNetworksNext"
 uuid = "302f2e75-49f0-4526-aef7-d8ba550cb06c"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.1.10"
+version = "0.1.11"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

src/ITensorNetworksNext.jl

@@ -3,6 +3,6 @@ module ITensorNetworksNext
 include("lazynameddimsarrays.jl")
 include("abstracttensornetwork.jl")
 include("tensornetwork.jl")
-include("contractnetwork.jl")
+include("contract_network.jl")
 
 end

src/contractnetwork.jl renamed to src/contract_network.jl

@@ -27,7 +27,7 @@ function contraction_sequence(tn::Vector{<:AbstractArray}; sequence_alg = defaul
     return contraction_sequence(Algorithm(sequence_alg), tn)
 end
 
-function contractnetwork(alg::Algorithm"exact", tn::Vector{<:AbstractArray})
+function contract_network(alg::Algorithm"exact", tn::Vector{<:AbstractArray})
     if !isnothing(alg.sequence)
         sequence = alg.sequence
     else
@@ -38,10 +38,10 @@ function contractnetwork(alg::Algorithm"exact", tn::Vector{<:AbstractArray})
     return materialize(sequence)
 end
 
-function contractnetwork(alg::Algorithm"exact", tn::AbstractTensorNetwork)
-    return contractnetwork(alg, [tn[v] for v in vertices(tn)])
+function contract_network(alg::Algorithm"exact", tn::AbstractTensorNetwork)
+    return contract_network(alg, [tn[v] for v in vertices(tn)])
 end
 
-function contractnetwork(tn; alg, kwargs...)
-    return contractnetwork(set_default_kwargs(Algorithm(alg; kwargs...)), tn)
+function contract_network(tn; alg, kwargs...)
+    return contract_network(set_default_kwargs(Algorithm(alg; kwargs...)), tn)
 end

test/test_contractnetwork.jl renamed to test/test_contract_network.jl

@@ -3,20 +3,20 @@ using NamedGraphs.GraphsExtensions: arranged_edges, incident_edges
 using NamedGraphs.NamedGraphGenerators: named_grid
 using ITensorBase: Index, ITensor
 using ITensorNetworksNext:
-    TensorNetwork, linkinds, siteinds, contractnetwork
+    TensorNetwork, linkinds, siteinds, contract_network
 using TensorOperations: TensorOperations
 using Test: @test, @testset
 
-@testset "ContractNetwork" begin
+@testset "contract_network" begin
     @testset "Contract Vectors of ITensors" begin
         i, j, k = Index(2), Index(2), Index(5)
         A = ITensor([1.0 1.0; 0.5 1.0], i, j)
         B = ITensor([2.0, 1.0], i)
         C = ITensor([5.0, 1.0], j)
         D = ITensor([-2.0, 3.0, 4.0, 5.0, 1.0], k)
 
-        ABCD_1 = contractnetwork([A, B, C, D]; alg = "exact", sequence_alg = "leftassociative")
-        ABCD_2 = contractnetwork([A, B, C, D]; alg = "exact", sequence_alg = "optimal")
+        ABCD_1 = contract_network([A, B, C, D]; alg = "exact", sequence_alg = "leftassociative")
+        ABCD_2 = contract_network([A, B, C, D]; alg = "exact", sequence_alg = "optimal")
 
         @test ABCD_1 == ABCD_2
     end
@@ -31,8 +31,8 @@ using Test: @test, @testset
             return randn(Tuple(is))
         end
 
-        z1 = contractnetwork(tn; alg = "exact", sequence_alg = "optimal")[]
-        z2 = contractnetwork(tn; alg = "exact", sequence_alg = "leftassociative")[]
+        z1 = contract_network(tn; alg = "exact", sequence_alg = "optimal")[]
+        z2 = contract_network(tn; alg = "exact", sequence_alg = "leftassociative")[]
 
         @test abs(z1 - z2) / abs(z1) <= 1.0e3 * eps(Float64)
     end