Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: support sum(LinearMixin) #8722

Merged
merged 2 commits into from
Sep 9, 2022
Merged

feat: support sum(LinearMixin) #8722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e02589
feat: support sum(LinearMixin)
mrossinek Sep 9, 2022
d16cadd
Add crossreferences to release note
jakelishman Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions qiskit/quantum_info/operators/mixins/linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,29 @@ class LinearMixin(MultiplyMixin, ABC):
"""

def __add__(self, other):
# enable easy use of sum(...)
if not isinstance(other, type(self)) and other == 0:
return self

qargs = getattr(other, "qargs", None)
return self._add(other, qargs=qargs)

def __radd__(self, other):
# enable easy use of sum(...)
if not isinstance(other, type(self)) and other == 0:
return self

qargs = getattr(other, "qargs", None)
return self._add(other, qargs=qargs)

def __sub__(self, other):
qargs = getattr(other, "qargs", None)
return self._add(-other, qargs=qargs)

def __rsub__(self, other):
qargs = getattr(other, "qargs", None)
return (-self)._add(other, qargs=qargs)

@abstractmethod
def _add(self, other, qargs=None):
"""Return the CLASS self + other.
Expand Down
5 changes: 5 additions & 0 deletions releasenotes/notes/base-operators-sums-d331e78a9fa4b5d8.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
features:
- |
``qiskit.quantum_info.BaseOperator`` subclasses (like :class:`.ScalarOp`,
:class:`.SparsePauliOp` and :class:`.PauliList`) can now be used with ``sum``.
32 changes: 32 additions & 0 deletions test/python/quantum_info/operators/test_scalar_op.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,27 @@ def test_add(self, coeff1, coeff2):
target = coeff1 + coeff2
self.assertScalarOp(val, dims, target)

@combine(coeff1=[0, 1, -3.1, 1 + 3j])
def test_radd(self, coeff1):
"""Test right-side addition with ScalarOp."""
dims = (3, 2)
op1 = ScalarOp(dims, coeff=coeff1)

val = op1 + 0
self.assertScalarOp(val, dims, coeff1)

@combine(coeff1=[0, 1, -3.1, 1 + 3j], coeff2=[-1, -5.1 - 2j])
def test_sum(self, coeff1, coeff2):
"""Test add operation with ScalarOp. ({coeff1} + {coeff2})"""
# Add two ScalarOps
dims = (3, 2)
op1 = ScalarOp(dims, coeff=coeff1)
op2 = ScalarOp(6, coeff=coeff2)

val = sum([op1, op2])
target = coeff1 + coeff2
self.assertScalarOp(val, dims, target)

@combine(coeff1=[0, 1, -3.1, 1 + 3j], coeff2=[-1, -5.1 - 2j])
def test_subtract(self, coeff1, coeff2):
"""Test add operation with ScalarOp. ({coeff1} - {coeff2})"""
Expand All @@ -179,6 +200,17 @@ def test_subtract(self, coeff1, coeff2):
target = coeff1 - coeff2
self.assertScalarOp(val, dims, target)

@combine(coeff1=[0, 1, -3.1, 1 + 3j], coeff2=[-1, -5.1 - 2j])
def test_rsub(self, coeff1, coeff2):
"""Test right-side subtraction with ScalarOp."""
dims = (3, 2)
op1 = ScalarOp(dims, coeff=coeff1)
op2 = ScalarOp(dims, coeff=coeff2)

val = op2.__rsub__(op1)
target = coeff1 - coeff2
self.assertScalarOp(val, dims, target)

@combine(
coeff1=[0, 1, -3.1, 1 + 3j],
coeff2=[-1, -5.1 - 2j],
Expand Down