Move current basis checking to new file deprecated.jl

This is in anticipation of new basis checking interface
and eventual future deprecation of current basis checking

Author: akirakyle

src/bases.jl

@@ -45,26 +45,6 @@ CompositeBasis(bases::Vector) = CompositeBasis((bases...,))
 
 Base.:(==)(b1::T, b2::T) where T<:CompositeBasis = equal_shape(b1.shape, b2.shape)
 
-"""
-    equal_shape(a, b)
-
-Check if two shape vectors are the same.
-"""
-function equal_shape(a, b)
-    if a === b
-        return true
-    end
-    if length(a) != length(b)
-        return false
-    end
-    for i=1:length(a)
-        if a[i]!=b[i]
-            return false
-        end
-    end
-    return true
-end
-
 ##
 # Common bases
 ##

src/deprecated.jl

@@ -12,3 +12,61 @@ function equal_bases(a, b)
 end
 
 Base.@deprecate PauliBasis(num_qubits) NQubitBasis(num_qubits) false
+
+function equal_shape(a, b)
+    if a === b
+        return true
+    end
+    if length(a) != length(b)
+        return false
+    end
+    for i=1:length(a)
+        if a[i]!=b[i]
+            return false
+        end
+    end
+    return true
+end
+
+macro samebases(ex)
+    return quote
+        BASES_CHECK.x = false
+        local val = $(esc(ex))
+        BASES_CHECK.x = true
+        val
+    end
+end
+
+function check_samebases(b1, b2)
+    if BASES_CHECK[] && !samebases(b1, b2)
+        throw(IncompatibleBases())
+    end
+end
+
+function check_multiplicable(b1, b2)
+    if BASES_CHECK[] && !multiplicable(b1, b2)
+        throw(IncompatibleBases())
+    end
+end
+
+samebases(b1::Basis, b2::Basis) = b1==b2
+samebases(b1::Tuple{Basis, Basis}, b2::Tuple{Basis, Basis}) = b1==b2 # for checking superoperators
+samebases(a::AbstractOperator) = samebases(a.basis_l, a.basis_r)::Bool # FIXME issue #12
+samebases(a::AbstractOperator, b::AbstractOperator) = samebases(a.basis_l, b.basis_l)::Bool && samebases(a.basis_r, b.basis_r)::Bool # FIXME issue #12
+check_samebases(a::Union{AbstractOperator, AbstractSuperOperator}) = check_samebases(a.basis_l, a.basis_r) # FIXME issue #12
+
+multiplicable(b1::Basis, b2::Basis) = b1==b2
+
+function multiplicable(b1::CompositeBasis, b2::CompositeBasis)
+    if !equal_shape(b1.shape,b2.shape)
+        return false
+    end
+    for i=1:length(b1.shape)
+        if !multiplicable(b1.bases[i], b2.bases[i])
+            return false
+        end
+    end
+    return true
+end
+
+multiplicable(a::AbstractOperator, b::AbstractOperator) = multiplicable(a.basis_r, b.basis_l) # FIXME issue #12

src/linalg.jl

@@ -4,78 +4,6 @@
 
 const BASES_CHECK = Ref(true)
 
-"""
-    @samebases
-
-Macro to skip checks for same bases. Useful for `*`, `expect` and similar
-functions.
-"""
-macro samebases(ex)
-    return quote
-        BASES_CHECK.x = false
-        local val = $(esc(ex))
-        BASES_CHECK.x = true
-        val
-    end
-end
-
-"""
-    samebases(a, b)
-
-Test if two objects have the same bases.
-"""
-samebases(b1::Basis, b2::Basis) = b1==b2
-samebases(b1::Tuple{Basis, Basis}, b2::Tuple{Basis, Basis}) = b1==b2 # for checking superoperators
-
-"""
-    check_samebases(a, b)
-
-Throw an [`IncompatibleBases`](@ref) error if the objects don't have
-the same bases.
-"""
-function check_samebases(b1, b2)
-    if BASES_CHECK[] && !samebases(b1, b2)
-        throw(IncompatibleBases())
-    end
-end
-
-
-"""
-    multiplicable(a, b)
-
-Check if two objects are multiplicable.
-"""
-multiplicable(b1::Basis, b2::Basis) = b1==b2
-
-function multiplicable(b1::CompositeBasis, b2::CompositeBasis)
-    if !equal_shape(b1.shape,b2.shape)
-        return false
-    end
-    for i=1:length(b1.shape)
-        if !multiplicable(b1.bases[i], b2.bases[i])
-            return false
-        end
-    end
-    return true
-end
-
-"""
-    check_multiplicable(a, b)
-
-Throw an [`IncompatibleBases`](@ref) error if the objects are
-not multiplicable.
-"""
-function check_multiplicable(b1, b2)
-    if BASES_CHECK[] && !multiplicable(b1, b2)
-        throw(IncompatibleBases())
-    end
-end
-
-samebases(a::AbstractOperator) = samebases(a.basis_l, a.basis_r)::Bool # FIXME issue #12
-samebases(a::AbstractOperator, b::AbstractOperator) = samebases(a.basis_l, b.basis_l)::Bool && samebases(a.basis_r, b.basis_r)::Bool # FIXME issue #12
-check_samebases(a::Union{AbstractOperator, AbstractSuperOperator}) = check_samebases(a.basis_l, a.basis_r) # FIXME issue #12
-multiplicable(a::AbstractOperator, b::AbstractOperator) = multiplicable(a.basis_r, b.basis_l) # FIXME issue #12
-
 ##
 # tensor, reduce, ptrace
 ##