test: combine do with another do or scalar value tests

Author: bobleesj

tests/conftest.py

@@ -47,6 +47,12 @@ def do_minimal_tth():
     return DiffractionObject(wavelength=2 * np.pi, xarray=np.array([30, 60]), yarray=np.array([1, 2]), xtype="tth")
 
 
+@pytest.fixture
+def do_minimal_d():
+    # Create an instance of DiffractionObject with non-empty xarray, yarray, and wavelength values
+    return DiffractionObject(wavelength=1.54, xarray=np.array([1, 2]), yarray=np.array([1, 2]), xtype="d")
+
+
 @pytest.fixture
 def wavelength_warning_msg():
     return (
@@ -70,13 +76,13 @@ def invalid_add_type_error_msg():
     return (
         "You may only add a DiffractionObject with another DiffractionObject or a scalar value. "
         "Please rerun by adding another DiffractionObject instance or a scalar value. "
-        "e.g., my_do_1 + my_do_2 or my_do + 10"
+        "e.g., my_do_1 + my_do_2 or my_do + 10 or 10 + my_do"
     )
 
 
 @pytest.fixture
-def x_grid_size_mismatch_error_msg():
+def y_grid_size_mismatch_error_msg():
     return (
-        "The two objects have different x-array lengths. "
-        "Please ensure the length of the x-value during initialization is identical."
+        "The two objects have different y-array lengths. "
+        "Please ensure the length of the y-value during initialization is identical."
     )

tests/test_diffraction_objects.py

@@ -715,47 +715,57 @@ def test_copy_object(do_minimal):
 @pytest.mark.parametrize(
     "starting_all_arrays, scalar_to_add, expected_all_arrays",
     [
-        # Test scalar addition to xarray values (q, tth, d) and expect no change to yarray values
-        (  # C1: Add integer of 5, expect xarray to increase by by 5
+        # Test scalar addition to yarray values (intensity) and expect no change to xarrays (q, tth, d)
+        (  # C1: Add integer of 5, expect yarray to increase by by 5
             np.array([[1.0, 0.51763809, 30.0, 12.13818192], [2.0, 1.0, 60.0, 6.28318531]]),
             5,
-            np.array([[1.0, 5.51763809, 35.0, 17.13818192], [2.0, 6.0, 65.0, 11.28318531]]),
+            np.array([[6.0, 0.51763809, 30.0, 12.13818192], [7.0, 1.0, 60.0, 6.28318531]]),
         ),
-        (  # C2: Add float of 5.1, expect xarray to be added by 5.1
+        (  # C2: Add float of 5.1, expect yarray to be added by 5.1
             np.array([[1.0, 0.51763809, 30.0, 12.13818192], [2.0, 1.0, 60.0, 6.28318531]]),
             5.1,
-            np.array([[1.0, 5.61763809, 35.1, 17.23818192], [2.0, 6.1, 65.1, 11.38318531]]),
+            np.array([[6.1, 0.51763809, 30.0, 12.13818192], [7.1, 1.0, 60.0, 6.28318531]]),
         ),
     ],
 )
 def test_addition_operator_by_scalar(starting_all_arrays, scalar_to_add, expected_all_arrays, do_minimal_tth):
     do = do_minimal_tth
     assert np.allclose(do.all_arrays, starting_all_arrays)
-    do_sum_RHS = do + scalar_to_add
-    do_sum_LHS = scalar_to_add + do
-    assert np.allclose(do_sum_RHS.all_arrays, expected_all_arrays)
-    assert np.allclose(do_sum_LHS.all_arrays, expected_all_arrays)
+    do_scalar_right_sum = do + scalar_to_add
+    assert np.allclose(do_scalar_right_sum.all_arrays, expected_all_arrays)
+    do_scalar_left_sum = scalar_to_add + do
+    assert np.allclose(do_scalar_left_sum.all_arrays, expected_all_arrays)
 
 
 @pytest.mark.parametrize(
-    "LHS_all_arrays, RHS_all_arrays, expected_all_arrays_sum",
+    "do_1_all_arrays, "
+    "do_2_all_arrays, "
+    "expected_do_1_all_arrays_with_y_summed, "
+    "expected_do_2_all_arrays_with_y_summed",
     [
         # Test addition of two DO objects, expect combined xarray values (q, tth, d) and no change to yarray
-        (  # C1: Add two DO objects with identical xarray values, expect sum of xarray values
+        (  # C1: Add two DO objects, expect sum of yarray values
             (np.array([[1.0, 0.51763809, 30.0, 12.13818192], [2.0, 1.0, 60.0, 6.28318531]]),),
-            (np.array([[1.0, 0.51763809, 30.0, 12.13818192], [2.0, 1.0, 60.0, 6.28318531]]),),
-            np.array([[1.0, 1.03527618, 60.0, 24.27636384], [2.0, 2.0, 120.0, 12.56637061]]),
+            (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]]),),
         ),
     ],
 )
-def test_addition_operator_by_another_do(LHS_all_arrays, RHS_all_arrays, expected_all_arrays_sum, do_minimal_tth):
-    assert np.allclose(do_minimal_tth.all_arrays, LHS_all_arrays)
-    do_LHS = do_minimal_tth
-    do_RHS = do_minimal_tth
-    do_sum = do_LHS + do_RHS
-    assert np.allclose(do_LHS.all_arrays, LHS_all_arrays)
-    assert np.allclose(do_RHS.all_arrays, RHS_all_arrays)
-    assert np.allclose(do_sum.all_arrays, expected_all_arrays_sum)
+def test_addition_operator_by_another_do(
+    do_1_all_arrays,
+    do_2_all_arrays,
+    expected_do_1_all_arrays_with_y_summed,
+    expected_do_2_all_arrays_with_y_summed,
+    do_minimal_tth,
+    do_minimal_d,
+):
+    do_1 = do_minimal_tth
+    assert np.allclose(do_1.all_arrays, do_1_all_arrays)
+    do_2 = do_minimal_d
+    assert np.allclose(do_2.all_arrays, do_2_all_arrays)
+    assert np.allclose((do_1 + do_2).all_arrays, expected_do_1_all_arrays_with_y_summed)
+    assert np.allclose((do_2 + do_1).all_arrays, expected_do_2_all_arrays_with_y_summed)
 
 
 def test_addition_operator_invalid_type(do_minimal_tth, invalid_add_type_error_msg):
@@ -767,9 +777,11 @@ def test_addition_operator_invalid_type(do_minimal_tth, invalid_add_type_error_m
         "string_value" + do
 
 
-def test_addition_operator_invalid_xarray_length(do_minimal, do_minimal_tth, x_grid_size_mismatch_error_msg):
+def test_addition_operator_invalid_yarray_length(do_minimal, do_minimal_tth, y_grid_size_mismatch_error_msg):
     # Combine two DO objects, one with empty xarrays (do_minimal) and the other with non-empty xarrays
-    do_LHS = do_minimal
-    do_RHS = do_minimal_tth
-    with pytest.raises(ValueError, match=re.escape(x_grid_size_mismatch_error_msg)):
-        do_LHS + do_RHS
+    do_1 = do_minimal
+    do_2 = do_minimal_tth
+    assert len(do_1.all_arrays[:, 0]) == 0
+    assert len(do_2.all_arrays[:, 0]) == 2
+    with pytest.raises(ValueError, match=re.escape(y_grid_size_mismatch_error_msg)):
+        do_1 + do_2