-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Request For Comment: Arithemtic between Operators and LazyOperators #86
Changes from 3 commits
f9c3a8c
f4b872e
690fff2
64da84f
d34baa8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -56,6 +56,26 @@ isequal(x::LazyProduct{B1,B2}, y::LazyProduct{B1,B2}) where {B1,B2} = (samebases | |
# Arithmetic operations | ||
-(a::T) where T<:LazyProduct = T(a.operators,a.ket_l,a.bra_r, -a.factor) | ||
|
||
|
||
function +(a::LazyProduct{B1,B2},b::Operator{B1,B2}) where {B1,B2} | ||
LazySum(a) + b | ||
end | ||
function +(a::Operator{B1,B2},b::LazyProduct{B1,B2}) where {B1,B2} | ||
+(b,a) | ||
end | ||
function -(a::LazyProduct{B1,B2},b::LazyProduct{B1,B2}) where {B1,B2} | ||
LazySum(a) - b | ||
end | ||
function +(a::LazyProduct{B1,B2},b::LazyProduct{B1,B2}) where {B1,B2} | ||
LazySum(a) + LazySum(b) | ||
end | ||
function -(a::LazyProduct{B1,B2},b::Operator{B1,B2}) where {B1,B2} | ||
LazySum(a) - b | ||
end | ||
function -(a::Operator{B1,B2},b::LazyProduct{B1,B2}) where {B1,B2} | ||
a - LazySum(b) | ||
end | ||
|
||
*(a::LazyProduct{B1,B2}, b::LazyProduct{B2,B3}) where {B1,B2,B3} = LazyProduct((a.operators..., b.operators...), a.factor*b.factor) | ||
*(a::LazyProduct, b::Number) = LazyProduct(a.operators, a.factor*b) | ||
*(a::Number, b::LazyProduct) = LazyProduct(b.operators, a*b.factor) | ||
|
@@ -74,6 +94,16 @@ permutesystems(op::LazyProduct, perm::Vector{Int}) = LazyProduct(([permutesystem | |
identityoperator(::Type{LazyProduct}, ::Type{S}, b1::Basis, b2::Basis) where S<:Number = LazyProduct(identityoperator(S, b1, b2)) | ||
|
||
|
||
#Assume same basis | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What does "assume same basis" means here? Is it something that would lead to bugs if not followed? Can we have tests for it, even if the test is basically just checking that an error is thrown instead of silently continuing with the operation? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What I meant is that BL and BR are the same since I'm not sure the methods defined would work if one considered operators with BL != BR. This is already handled by the dispatch, and the user should just get an error saying that addition for these types of operators is not defined. I will look into this and create specific tests for it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. BL == BR is no longer assumed and code is updated accordingly |
||
function tensor(a::Operator{B1,B1},b::LazyProduct{B, B, F, T, KTL, BTR}) where {B1,B, F, T, KTL, BTR} | ||
ops = ([(i == 1 ? a : identityoperator(a)) ⊗ op for (i,op) in enumerate(b.operators)]...,) | ||
LazyProduct(ops,b.factor) | ||
end | ||
function tensor(a::LazyProduct{B, B, F, T, KTL, BTR},b::Operator{B1,B1}) where {B1,B, F, T, KTL, BTR} | ||
ops = ([op ⊗ (i == 1 ? b : identityoperator(b)) for (i,op) in enumerate(a.operators)]...,) | ||
LazyProduct(ops,a.factor) | ||
end | ||
|
||
function mul!(result::Ket{B1},a::LazyProduct{B1,B2},b::Ket{B2},alpha,beta) where {B1,B2} | ||
if length(a.operators)==1 | ||
mul!(result,a.operators[1],b,a.factor*alpha,beta) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -96,22 +96,48 @@ isequal(x::LazyTensor, y::LazyTensor) = samebases(x,y) && isequal(x.indices, y.i | |
# Arithmetic operations | ||
-(a::LazyTensor) = LazyTensor(a, -a.factor) | ||
|
||
function +(a::LazyTensor{B1,B2}, b::LazyTensor{B1,B2}) where {B1,B2} | ||
if length(a.indices) == 1 && a.indices == b.indices | ||
op = a.operators[1] * a.factor + b.operators[1] * b.factor | ||
return LazyTensor(a.basis_l, a.basis_r, a.indices, (op,)) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the only place I am not sure about defaulting to laziness. It's quite a special case, but I encounter it quite a bit. I suppose the reason to do lazy summing here is mainly to be consistent with the laziness-preserving principle. I have some code that makes use of the existing behavior, but of course I can still do this kind of concrete summing manually if I want to, so I'm not arguing hard to keep it. What are your thoughts? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My experience was that the previous implementation was very limiting. Especially since the custom operators I have been playing around with were not DataOperators but AbstractOperators, where the operation was defined via a function rather than a matrix. Therefore, these cannot be trivially added (except by using LazySum), and the above implementation fails. Also, length(a.indices) ==1 is required, and I could imagine situations where one would like to be able to add LazyTensors containing more than one operator. However, one could perhaps keep the original behavior by dispatching on LazyTensors containing only one DataOperator. That is adding a function like this (draft, I'm not entirely sure it works): const single_dataoperator{B1,B2} = LazyTensor{B1,B2,ComplexF64,Vector{Int64},Tuple{T}} where {B1,B2,T<:DataOperator}
function +(a::T1,b::T2) where {T1 <: single_dataoperator{B1,B2},T2 <: single_dataoperator{B1,B2}}
if length(a.indices) == 1 && a.indices == b.indices
op = a.operators[1] * a.factor + b.operators[1] * b.factor
return LazyTensor(a.basis_l, a.basis_r, a.indices, (op,))
end
throw(ArgumentError("Addition of LazyTensor operators is only defined in case both operators act nontrivially on the same, single tensor factor."))
end There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mabuni1998 I think it's worth trying to keep the original intact as you suggest. If we can handle it via dispatch, we won't lose anything. Or am I missing some case here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No I don't think we will lose anything. I have implemented to above as: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for finding a way to keep the original behavior. This is not type-stable, but I can't think of an obvious way to make it otherwise, except by letting LazyTensor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably won't be performance-critical no, as you are most likely creating the operators once at the beginning of the simulation and then not changing them as you do multiplications etc. |
||
end | ||
throw(ArgumentError("Addition of LazyTensor operators is only defined in case both operators act nontrivially on the same, single tensor factor.")) | ||
function +(a::LazyTensor{B1,B2},b::LazyTensor{B1,B2}) where {B1,B2} | ||
amilsted marked this conversation as resolved.
Show resolved
Hide resolved
|
||
LazySum(a,b) | ||
end | ||
function -(a::LazyTensor{B1,B2},b::LazyTensor{B1,B2}) where {B1,B2} | ||
LazySum((1,-1),(a,b)) | ||
end | ||
function +(a::LazyTensor{B1,B2},b::Operator{B1,B2}) where {B1,B2} | ||
LazySum(a) + b | ||
end | ||
function +(a::Operator{B1,B2},b::LazyTensor{B1,B2}) where {B1,B2} | ||
+(b,a) | ||
end | ||
function -(a::LazyTensor{B1,B2},b::Operator{B1,B2}) where {B1,B2} | ||
LazySum(a) - b | ||
end | ||
function -(a::Operator{B1,B2},b::LazyTensor{B1,B2}) where {B1,B2} | ||
a - LazySum(b) | ||
end | ||
|
||
function -(a::LazyTensor{B1,B2}, b::LazyTensor{B1,B2}) where {B1,B2} | ||
if length(a.indices) == 1 && a.indices == b.indices | ||
op = a.operators[1] * a.factor - b.operators[1] * b.factor | ||
return LazyTensor(a.basis_l, a.basis_r, a.indices, (op,)) | ||
function tensor(a::LazyTensor{B1,B1},b::Operator{B2,B2}) where {B1,B2} | ||
if isequal(b,identityoperator(basis(b))) | ||
btotal = basis(a) ⊗ basis(b) | ||
LazyTensor(btotal,btotal,a.indices,(a.operators...,),a.factor) | ||
elseif B2 <: CompositeBasis | ||
throw(ArgumentError("tensor(a::LazyTensor{B1,B1},b::Operator{B2,B2}) is not implemented for B2 being CompositeBasis ")) | ||
else | ||
a ⊗ LazyTensor(b.basis_l,b.basis_r,[1],(b,),1) | ||
end | ||
end | ||
function tensor(a::Operator{B1,B1},b::LazyTensor{B2,B2}) where {B1,B2} | ||
if isequal(a,identityoperator(basis(a))) | ||
btotal = basis(a) ⊗ basis(b) | ||
LazyTensor(btotal,btotal,b.indices.+length(basis(a).shape) ,(b.operators...,),b.factor) | ||
elseif B1 <: CompositeBasis | ||
throw(ArgumentError("tensor(a::Operator{B1,B1},b::LazyTensor{B2,B2}) is not implemented for B1 being CompositeBasis ")) | ||
else | ||
LazyTensor(a.basis_l,a.basis_r,[1],(a,),1) ⊗ b | ||
end | ||
throw(ArgumentError("Subtraction of LazyTensor operators is only defined in case both operators act nontrivially on the same, single tensor factor.")) | ||
end | ||
|
||
|
||
|
||
function *(a::LazyTensor{B1,B2}, b::LazyTensor{B2,B3}) where {B1,B2,B3} | ||
indices = sort(union(a.indices, b.indices)) | ||
# ops = Vector{AbstractOperator}(undef, length(indices)) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -412,9 +412,9 @@ x2 = Ket(b_r, rand(ComplexF64, length(b_r))) | |
xbra1 = Bra(b_l, rand(ComplexF64, length(b_l))) | ||
xbra2 = Bra(b_l, rand(ComplexF64, length(b_l))) | ||
|
||
# Addition | ||
@test_throws ArgumentError op1 + op2 | ||
@test_throws ArgumentError op1 - op2 | ||
# Addition Addition of LazyTensor now returns LazySum | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Before merge I would suggest deleting the commented-out tests. They would not be informative to future readers, long after this merge. Future readers should use Could you add tests for the failure modes of this contribution? E.g., There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated code to no longer assume anything about BL == BR and added test to ensure that errors are thrown if addition between operators is not allowed. |
||
#@test_throws ArgumentError op1 + op2 | ||
#@test_throws ArgumentError op1 - op2 | ||
@test D(-op1_, -op1, 1e-12) | ||
|
||
# Test multiplication | ||
|
@@ -448,7 +448,9 @@ xbra1 = Bra(b_l, rand(ComplexF64, length(b_l))) | |
xbra2 = Bra(b_l, rand(ComplexF64, length(b_l))) | ||
|
||
# Addition | ||
@test_throws ArgumentError op1 + op2 | ||
#Commented following line since addition of LazyProduct returns LazySum and is allowed. | ||
#@test_throws ArgumentError op1 + op2 | ||
@test D(2.1*op1 + 0.3*op2, 2.1*op1_+0.3*op2_) | ||
@test D(-op1_, -op1) | ||
|
||
# Test multiplication | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this probably should be deleted before merging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh yeah... Done that now ;)