support fermion-spin coupled systems

Author: qyli

src/IntrTree/IntrIterator.jl

@@ -32,7 +32,7 @@ The local operator which tells both the operator and its site index.
 For bosonic operators.
      Z::AbstractTensorMap
 For fermionic operators. Assume all sites are fermionic therefore each site after `Op` will give `Z` operator.
-     Z::AbstractVector{<:AbstractTensorMap}
+     Z::AbstractVector
 Directly give the `Z` operator for each site to deal with the systems mixed with bosons and fermions.
 
 # Constructors
@@ -51,8 +51,8 @@ struct OnSiteInteractionIterator{L, T} <: AbstractInteractionIterator{L}
      Z::T
      function OnSiteInteractionIterator{L}(Op::AbstractLocalOperator,
           Z::T) where {L, T}
-          @assert T <: Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}}
-          if T <: AbstractVector{<:AbstractTensorMap}
+          @assert T <: Union{Nothing, AbstractTensorMap, AbstractVector}
+          if T <: AbstractVector
                @assert length(Z) == L
           end
           return new{L, T}(Op, Z)
@@ -109,7 +109,7 @@ The local operators.
 For bosonic operators.
      Z::AbstractTensorMap
 For fermionic operators. Note we assume both `O₁` and `O₂` are fermionic operators if `Z ≠ nothing`. 
-     Z::AbstractVector{<:AbstractTensorMap}
+     Z::AbstractVector
 Directly give the `Z` operator for each site to deal with the systems mixed with bosons and fermions.
 
 # Constructors
@@ -130,8 +130,8 @@ struct TwoSiteInteractionIterator{L, T} <: AbstractInteractionIterator{L}
      function TwoSiteInteractionIterator{L}(O₁::AbstractLocalOperator,
           O₂::AbstractLocalOperator,
           Z::T) where {L, T}
-          @assert T <: Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}}
-          if T <: AbstractVector{<:AbstractTensorMap}
+          @assert T <: Union{Nothing, AbstractTensorMap, AbstractVector}
+          if T <: AbstractVector
                @assert length(Z) == L
           end
           return new{L, T}(O₁, O₂, Z)
@@ -196,7 +196,7 @@ end
 """
      ArbitraryInteractionIterator{L} <: AbstractInteractionIterator{L}
           Ops::Vector{<:AbstractLocalOperator}
-          Z::Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}}
+          Z::Union{Nothing, AbstractTensorMap, AbstractVector}
           pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}}
      end
 
@@ -206,27 +206,27 @@ The iterator for an arbitrary interaction term.
      Ops::Vector{<:AbstractLocalOperator}
 A vector to store the local operators, `length(Ops) == N` means a `N`-site interaction term.
 
-     Z::Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}}
+     Z::Union{Nothing, AbstractTensorMap, AbstractVector}
      pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}}
 Provide the fermion parity operator `Z` and the local physical space `pspace`. Assume a site-independent `Z` or `pspace` if a single object is provided, otherwise, a length-`L` vector is expected to deal with the site-dependent cases.  
 
 # Constructors
      ArbitraryInteractionIterator{L}(Ops::Vector{<:AbstractLocalOperator},
-          Z::Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}},
+          Z::Union{Nothing, AbstractTensorMap, AbstractVector},
           pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}} = nothing)
 The direct constructor. 
 """
 struct ArbitraryInteractionIterator{L} <: AbstractInteractionIterator{L}
      Ops::Vector{<:AbstractLocalOperator}
-     Z::Union{Nothing, AbstractTensorMap, AbstractVector{<:AbstractTensorMap}}
+     Z::Union{Nothing, AbstractTensorMap, AbstractVector}
      pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}}
 end
 function iterate(iter::ArbitraryInteractionIterator{L}, st::Tuple{Int64, Int64, Bool, VectorSpace} = (1, 1, false, getLeftSpace(iter.Ops[1]))) where {L}
      i, idx, flag, aspace = st
      i > L && return nothing
 
      if idx > length(iter.Ops) || i < iter.Ops[idx].si
-          if flag 
+          if flag && !isnothing(_getZ(iter.Z, i))
                return LocalOperator(_getZ(iter.Z, i), :Z, i, false; aspace = (aspace, aspace)), (i + 1, idx, flag, aspace)
           else
                return IdentityOperator(_getpspace(iter.pspace, i), aspace, i), (i + 1, idx, flag, aspace)
@@ -241,10 +241,10 @@ end
 
 _getZ(::Nothing, ::Int64) = nothing
 _getZ(Z::AbstractTensorMap, ::Int64) = Z
-_getZ(Z::Vector{AbstractTensorMap}, i::Int64) = Z[i]
+_getZ(Z::Vector, i::Int64) = Z[i]
 _getpspace(::Nothing, ::Int64) = nothing
 _getpspace(pspace::VectorSpace, ::Int64) = pspace
-_getpspace(pspace::Vector{VectorSpace}, i::Int64) = pspace[i]
+_getpspace(pspace::AbstractVector{<:VectorSpace}, i::Int64) = pspace[i]
 
 _addZ!(O::LocalOperator, ::Nothing) = O
 function _addZ!(OR::LocalOperator{1, 1}, Z::AbstractTensorMap)

src/IntrTree/addIntr.jl

@@ -13,8 +13,8 @@
 Add an interaction characterized by `N` local operators at `si = (i, j, ...)` sites. `fermionic` indicates whether each operator is fermionic or not. 
 
 # Kwargs 
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}}
-Provide the parity operator to deal with the fermionic anti-commutation relations.If `Z == nothing`, assume all operators are bosonic. Otherwise, a uniform (single operator) `Z::AbstractTensorMap` or site-dependent (length `L` vector) `Z::Vector{<:AbstractTensorMap}` should be given.
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector}
+Provide the parity operator to deal with the fermionic anti-commutation relations.If `Z == nothing`, assume all operators are bosonic. Otherwise, a uniform (single operator) `Z::AbstractTensorMap` or site-dependent (length `L` vector) `Z::AbstractVector` should be given.
 
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}}
 Provide the local Hilbert space (`VectorSpace` in `TensorKit.jl`). This is not required in generating Hamiltonian, so the default value is set as `nothing`. But some processes like generating an identity MPO require this information. In such cases, a uniform or site-dependent (length `L` vector) `pspace` should be given.
@@ -30,7 +30,7 @@ function addIntr!(Tree::InteractionTree{L},
 	si::NTuple{N, Int64},
 	fermionic::NTuple{N, Bool},
 	strength::Number;
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}} = nothing,
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector} = nothing,
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}} = nothing,
 	name::NTuple{N, Union{Symbol, String}} = _default_IntrName(N),
 	IntrName::Union{Symbol, String} = prod(string.(name)),
@@ -93,7 +93,7 @@ end
 
 function addIntr!(Tree::InteractionTree{L},
 	S::StringOperator,
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}},
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector},
 	ref::Ref;
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}} = nothing,
 ) where L

src/Observables/addObs.jl

@@ -12,8 +12,8 @@
 Add an `N`-site observable to `Tree`, where the observable is characterized by `N`-tuples `Op`, `si` and `fermionic`. The implementation and usage is similar to `addIntr!`, except for the logic to deal with same operator which is added twice.
 
 # Kwargs 
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}}
-Provide the parity operator to deal with the fermionic anti-commutation relations.If `Z == nothing`, assume all operators are bosonic. Otherwise, a uniform (single operator) `Z::AbstractTensorMap` or site-dependent (length `L` vector) `Z::Vector{<:AbstractTensorMap}` should be given.
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector}
+Provide the parity operator to deal with the fermionic anti-commutation relations.If `Z == nothing`, assume all operators are bosonic. Otherwise, a uniform (single operator) `Z::AbstractTensorMap` or site-dependent (length `L` vector) `Z::AbstractVector` should be given.
 
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}}
 Provide the local Hilbert space (`VectorSpace` in `TensorKit.jl`). This is not required in generating Hamiltonian, so the default value is set as `nothing`. But some processes like generating an identity MPO require this information. In such cases, a uniform or site-dependent (length `L` vector) `pspace` should be given.
@@ -28,7 +28,7 @@ function addObs!(Tree::ObservableTree{L},
 	Op::NTuple{N, AbstractTensorMap},
 	si::NTuple{N, Int64},
 	fermionic::NTuple{N, Bool};
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}} = nothing,
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector} = nothing,
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}} = nothing,
 	name::NTuple{N, Union{Symbol, String}} = _default_IntrName(N),
 	IntrName::Union{Symbol, String} = prod(string.(name)),
@@ -78,7 +78,7 @@ end
 
 function addObs!(Tree::ObservableTree{L},
 	S::StringOperator,
-	Z::Union{Nothing, AbstractTensorMap, Vector{<:AbstractTensorMap}},
+	Z::Union{Nothing, AbstractTensorMap, AbstractVector},
 	ref::Ref;
 	pspace::Union{Nothing, VectorSpace, Vector{<:VectorSpace}} = nothing,
 ) where L