feat: Support *, /, - operations between two DiffractionObjects or scalar #293
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bobleesj
commented
Dec 29, 2024
| def _check_operation_compatibility(self, other): | ||
| if not isinstance(other, (DiffractionObject, int, float)): | ||
| raise TypeError(invalid_add_type_emsg) | ||
| if isinstance(other, DiffractionObject): | ||
| self_yarray = self.all_arrays[:, 0] | ||
| other_yarray = other.all_arrays[:, 0] | ||
| if len(self_yarray) != len(other_yarray): | ||
| if self_yarray.shape != other_yarray.shape: |
There was a problem hiding this comment.
@sbillinge as suggested - using shape
There was a problem hiding this comment.
the idea for using shape was to shorten code and make it more readable, so
self_yarray = self.all_arrays[:, 0]
other_yarray = other.all_arrays[:, 0]
if len(self_yarray) != len(other_yarray):
raise ValueError(y_grid_length_mismatch_emsg)
is replaced by
if shape(self.all_arrays) != shape(other.all_arrays):
raise ValueError(y_grid_length_mismatch_emsg)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #293 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 8
Lines 446 483 +37
=========================================
+ Hits 446 483 +37
|
bobleesj
commented
Dec 29, 2024
| @@ -713,75 +713,176 @@ def test_copy_object(do_minimal): | |||
|
|
|||
|
|
|||
| @pytest.mark.parametrize( | |||
| "starting_all_arrays, scalar_to_add, expected_all_arrays", | |||
| "operation, starting_yarray, scalar_value, expected_yarray", | |||
There was a problem hiding this comment.
operation b/w scalar and do
bobleesj
commented
Dec 29, 2024
| (np.array([[1.0, 6.28318531, 100.70777771, 1], [2.0, 3.14159265, 45.28748053, 2.0]]),), | ||
| (np.array([[2.0, 0.51763809, 30.0, 12.13818192], [4.0, 1.0, 60.0, 6.28318531]]),), | ||
| (np.array([[2.0, 6.28318531, 100.70777771, 1], [4.0, 3.14159265, 45.28748053, 2.0]]),), | ||
| # Test addition, subtraction, multiplication, and division of two DO objects |
There was a problem hiding this comment.
operation b/w do1 and do2
bobleesj
commented
Dec 29, 2024
|
|
||
|
|
||
| def test_operator_invalid_type(do_minimal_tth, invalid_add_type_error_msg): | ||
| # Add a string to a DiffractionObject, expect TypeError |
There was a problem hiding this comment.
invalid case - add string
bobleesj
commented
Dec 29, 2024
|
|
||
| @pytest.mark.parametrize("operation", ["add", "sub", "mul", "div"]) | ||
| def test_operator_invalid_yarray_length(operation, do_minimal, do_minimal_tth, y_grid_size_mismatch_error_msg): | ||
| # Add two DO objects with different yarray lengths, expect ValueError |
There was a problem hiding this comment.
invalid case - add different lengths of yarray between 2 DOs
|
@sbillinge ready for review! |
|
Do we want to add both metadata to the resulting diffraction object? |
sbillinge
reviewed
Dec 30, 2024
| def _check_operation_compatibility(self, other): | ||
| if not isinstance(other, (DiffractionObject, int, float)): | ||
| raise TypeError(invalid_add_type_emsg) | ||
| if isinstance(other, DiffractionObject): | ||
| self_yarray = self.all_arrays[:, 0] | ||
| other_yarray = other.all_arrays[:, 0] | ||
| if len(self_yarray) != len(other_yarray): | ||
| if self_yarray.shape != other_yarray.shape: |
There was a problem hiding this comment.
the idea for using shape was to shorten code and make it more readable, so
self_yarray = self.all_arrays[:, 0]
other_yarray = other.all_arrays[:, 0]
if len(self_yarray) != len(other_yarray):
raise ValueError(y_grid_length_mismatch_emsg)
is replaced by
if shape(self.all_arrays) != shape(other.all_arrays):
raise ValueError(y_grid_length_mismatch_emsg)
|
@sbillinge ah yes. Great! Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #187 -
No docstrings made at the moment, but I will do in the next PR working on the issue #239