Test activate parameter function

tests/utils/test_parameters.py

@@ -0,0 +1,199 @@
+"""Tests for parameter utilities."""
+
+import pytest
+from pytest import param
+
+from baybe.parameters import NumericalContinuousParameter
+from baybe.parameters.numerical import _FixedNumericalContinuousParameter
+from baybe.parameters.utils import activate_parameter
+from baybe.utils.interval import Interval
+
+
+def mirror_interval(interval: Interval) -> Interval:
+    """Return an interval copy mirrored around the origin."""
+    return Interval(lower=-interval.upper, upper=-interval.lower)
+
+
+@pytest.mark.parametrize(
+    (
+        "bounds",
+        "thresholds",
+        "is_valid",
+        "expected_bounds",
+    ),
+    [
+        # one-side bounds, two-side thresholds
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=-1.0, upper=1.5),
+            False,
+            None,
+            id="oneside_bounds_in_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=-1.0, upper=1.0),
+            True,
+            Interval(lower=1.0, upper=1.0),
+            id="oneside_bounds_in_twoside_thresholds_fixed_value",
+        ),
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=-1.0, upper=0.5),
+            True,
+            Interval(lower=0.5, upper=1.0),
+            id="oneside_bounds_intersected_with_twoside_thresholds",
+        ),
+        # one-side bounds, one-side thresholds
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=-1.0, upper=0.0),
+            True,
+            Interval(lower=0.0, upper=1.0),
+            id="oneside_bounds_intersected_on_single_point_with_oneside_thresholds",
+        ),
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=0.0, upper=0.5),
+            True,
+            Interval(lower=0.5, upper=1.0),
+            id="oneside_bounds_cover_oneside_thresholds",
+        ),
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=0.0, upper=1.0),
+            True,
+            Interval(lower=1.0, upper=1.0),
+            id="oneside_bounds_match_oneside_thresholds",
+        ),
+        param(
+            Interval(lower=0.0, upper=1.0),
+            Interval(lower=0.0, upper=1.1),
+            False,
+            None,
+            id="oneside_bounds_in_oneside_thresholds",
+        ),
+        # Two-side bounds. One-side thresholds do not differ from two-side threshold
+        # in these cases. Hence, use two-side thresholds.
+        param(
+            Interval(lower=-0.5, upper=1.0),
+            Interval(lower=-1.0, upper=1.1),
+            False,
+            None,
+            id="twoside_bounds_in_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=-0.5, upper=1.0),
+            Interval(lower=-0.5, upper=1.0),
+            True,
+            Interval(lower=-0.5, upper=1.0),
+            id="twoside_bounds_match_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=-0.6, upper=1.1),
+            Interval(lower=-0.5, upper=1.0),
+            True,
+            Interval(lower=-0.6, upper=1.1),
+            id="twoside_bounds_cover_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=-0.6, upper=1.1),
+            Interval(lower=-1.0, upper=0.5),
+            True,
+            Interval(lower=0.5, upper=1.1),
+            id="twoside_bounds_intersected_with_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=-0.6, upper=0.5),
+            Interval(lower=-1.0, upper=0.5),
+            True,
+            Interval(lower=0.5, upper=0.5),
+            id="twoside_bounds_partial_in_twoside_thresholds",
+        ),
+        param(
+            Interval(lower=-1.0, upper=0.5),
+            Interval(lower=-0.6, upper=0.5),
+            True,
+            Interval(lower=-1.0, upper=0.5),
+            id="twoside_bounds_partial_cover_twoside_thresholds",
+        ),
+    ],
+)
+@pytest.mark.parametrize("mirror", [False, True])
+def test_activate_parameter(
+    bounds: Interval,
+    thresholds: Interval,
+    is_valid: bool,
+    expected_bounds: Interval | None,
+    mirror: bool,
+) -> None:
+    """Test that the utility correctly activate a parameter.
+
+    Args:
+        bounds: the bounds of the parameter to activate
+        thresholds: the thresholds of inactive range
+        is_valid: boolean variable indicating whether a parameter is returned from
+            activate_parameter
+        expected_bounds: the bounds of the activated parameter if one is returned
+        mirror: if true both bounds and thresholds get mirrored
+
+    Returns:
+        None
+    """
+    if mirror:
+        bounds = mirror_interval(bounds)
+        thresholds = mirror_interval(thresholds)
+    if mirror and is_valid:
+        expected_bounds = mirror_interval(expected_bounds)
+
+    parameter = NumericalContinuousParameter("parameter", bounds=bounds)
+
+    if is_valid:
+        activated_parameter = activate_parameter(parameter, thresholds)
+        assert activated_parameter.bounds == expected_bounds
+        if expected_bounds.is_degenerate:
+            assert isinstance(activated_parameter, _FixedNumericalContinuousParameter)
+    else:
+        with pytest.raises(ValueError, match="cannot be set active"):
+            activate_parameter(parameter, thresholds)
+
+
+@pytest.mark.parametrize(
+    ("bounds", "thresholds", "match"),
+    [
+        param(
+            Interval(lower=-0.5, upper=0.5),
+            Interval(lower=0.5, upper=1.0),
+            "The thresholds must cover zero",
+            id="invalid_thresholds",
+        ),
+        param(
+            Interval(lower=0.5, upper=1.0),
+            Interval(lower=-0.5, upper=0.5),
+            "The parameter bounds must cover zero",
+            id="invalid_bounds",
+        ),
+    ],
+)
+@pytest.mark.parametrize("mirror", [False, True])
+def test_invalid_activate_parameter(
+    bounds: Interval, thresholds: Interval, match: str, mirror: bool
+) -> None:
+    """Test that invalid bounds or thresholds are given.
+
+    Args:
+        bounds: the bounds of the parameter to activate
+        thresholds: the thresholds of inactive range
+        match: error message to match
+        mirror: if true both bounds and thresholds get mirrored
+
+    Returns:
+        None
+    """
+    if mirror:
+        bounds = mirror_interval(bounds)
+        thresholds = mirror_interval(thresholds)
+
+    parameter = NumericalContinuousParameter("parameter", bounds=bounds)
+    with pytest.raises(ValueError, match=match):
+        activate_parameter(parameter, thresholds)