Skip to content

Allow numeric bounds when clipping dimensionless quantities #282

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

Open
antonsoo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow numeric bounds when clipping dimensionless quantities #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions CHANGES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ CHANGES
Unreleased
-----------

- Allow numeric bounds when clipping dimensionless quantities (`#108
<https://github.com/python-quantities/python-quantities/issues/108>`_).

- Correct the pond force unit to 0.00980665 N (one gram-force); it was
previously 1000 times too large (`#44 <https://github.com/python-quantities/python-quantities/issues/44>`_).

Expand Down
4 changes: 2 additions & 2 deletions quantities/quantity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -653,8 +653,8 @@ def clip(self, min=None, max=None, out=None):
)

clipped = self.magnitude.clip(
min.rescale(self._dimensionality).magnitude,
max.rescale(self._dimensionality).magnitude,
Quantity(min).rescale(self._dimensionality).magnitude,
Quantity(max).rescale(self._dimensionality).magnitude,
None if out is None else out.magnitude
)
dim = self.dimensionality
Expand Down
17 changes: 17 additions & 0 deletions quantities/tests/test_methods.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,23 @@ def test_clip(self):
self.assertRaises(ValueError, self.q.clip, pq.J)
self.assertRaises(ValueError, self.q.clip, 1)

def test_clip_dimensionless_numeric_bounds(self):
q = [[-2., 0.5], [1.5, 3.]] * pq.dimensionless
for lower, upper in ((0, 1), (None, 1), (0, None),
(np.array([[0.], [1.]]), [1., 2.])):
with self.subTest(lower=lower, upper=upper):
expected = q.magnitude.clip(lower, upper) * pq.dimensionless
self.assertQuantityEqual(q.clip(lower, upper), expected)
self.assertQuantityEqual(np.clip(q, lower, upper), expected)
out = np.empty(q.shape) * pq.dimensionless
self.assertIs(q.clip(lower, upper, out=out), out)
self.assertQuantityEqual(out, expected)
self.assertQuantityEqual(q.clip(0, 1 * pq.dimensionless),
[[0., 0.5], [1., 1.]] * pq.dimensionless)
self.assertRaises(ValueError, q.clip, 0 * pq.m, 1)
self.assertRaises(ValueError, self.q.clip, 0, 1 * pq.m)
self.assertQuantityEqual(q, [[-2., 0.5], [1.5, 3.]] * pq.dimensionless)

def test_round(self):
q = [1, 1.33, 5.67, 22] * pq.m
self.methodWithOut(
Expand Down
Loading