Depricate equal_bases

Author: akirakyle

CHANGELOG.md

@@ -1,6 +1,11 @@
 # News
 
+## v0.3.9 - 2025-04-03
+
+- Deprecate `equal_bases`.
+
 ## v0.3.8 - 2025-03-08
+
 - Introduce `metrics.jl` file for metric declarations.
 
 ## v0.3.7 - 2025-01-16

Project.toml

@@ -1,7 +1,7 @@
 name = "QuantumInterface"
 uuid = "5717a53b-5d69-4fa3-b976-0bf2f97ca1e5"
 authors = ["QuantumInterface.jl contributors"]
-version = "0.3.8"
+version = "0.3.9"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

src/QuantumInterface.jl

@@ -103,4 +103,6 @@ include("express.jl")
 
 include("metrics.jl")
 
+include("deprecated.jl")
+
 end # module

src/bases.jl

@@ -120,23 +120,6 @@ function equal_shape(a, b)
     return true
 end
 
-"""
-    equal_bases(a, b)
-
-Check if two subbases vectors are identical.
-"""
-function equal_bases(a, b)
-    if a===b
-        return true
-    end
-    for i=1:length(a)
-        if a[i]!=b[i]
-            return false
-        end
-    end
-    return true
-end
-
 """
 Exception that should be raised for an illegal algebraic operation.
 """

src/deprecated.jl

@@ -0,0 +1,12 @@
+function equal_bases(a, b)
+    Base.depwarn("`==` should be preferred over `equal_bases`!", :equal_bases)
+    if a===b
+        return true
+    end
+    for i=1:length(a)
+        if a[i]!=b[i]
+            return false
+        end
+    end
+    return true
+end

test/test_bases.jl

@@ -1,5 +1,5 @@
 using Test
-using QuantumInterface: tensor, ⊗, ptrace, reduced, permutesystems, equal_bases, multiplicable
+using QuantumInterface: tensor, ⊗, ptrace, reduced, permutesystems, multiplicable
 using QuantumInterface: GenericBasis, CompositeBasis, NLevelBasis, FockBasis
 
 @testset "basis" begin
@@ -49,7 +49,7 @@ comp1 = tensor(b1, b2, b3)
 comp2 = tensor(b2, b1, b3)
 @test permutesystems(comp1, [2,1,3]) == comp2
 
-@test !equal_bases([b1, b2], [b1, b3])
+@test [b1, b2] != [b1, b3]
 @test !multiplicable(comp1, b1 ⊗ b2 ⊗ NLevelBasis(prod(b3.shape)))
 
 end # testset