Diamond cond with OrConjunction (#219)

* add check for pcs_new read

* flake8

* simplify code and flake8

* hierarchical diamond condition

* doc update

Author: dengdifan

ConfigSpace/c_util.pyx

@@ -267,6 +267,7 @@ cpdef np.ndarray change_hp_value(
     cdef Hyperparameter current
     cdef str current_name
     cdef list disabled
+    cdef set hps_to_be_activate
     cdef set visited
     cdef dict activated_values
     cdef int active
@@ -287,6 +288,12 @@ cpdef np.ndarray change_hp_value(
     # Hyperparameters which are going to be set to inactive
     disabled = []
 
+    # Hyperparameters which are going to be set activate, we introduce this to resolve the conflict that might be raised
+    # by OrConjunction:
+    # Suppose that we have a parent HP_p whose possible values are A, B, C; a child HP_d is activate if
+    # HP_p is A or B. Then when HP_p switches from A to B, HP_d needs to remain activate.
+    hps_to_be_activate = set()
+
     # Activate hyperparameters if their parent node got activated
     children = children_of[hp_name]
     if len(children) > 0:
@@ -301,7 +308,7 @@ cpdef np.ndarray change_hp_value(
             if current_name in visited:
                 continue
             visited.add(current_name)
-            if current_name in disabled:
+            if current_name in hps_to_be_activate:
                 continue
 
             current_idx = configuration_space._hyperparameter_idx[current_name]
@@ -315,6 +322,16 @@ cpdef np.ndarray change_hp_value(
                     active = False
                     break
 
+            if active:
+                hps_to_be_activate.add(current_idx)
+                if current_value == current_value:
+                    children_ = children_of[current_name]
+                    if len(children_) > 0:
+                        to_visit.extendleft(children_)
+
+            if current_name in disabled:
+                continue
+
             if active and not current_value == current_value:
                 default_value = current.normalized_default_value
                 configuration_array[current_idx] = default_value
@@ -343,6 +360,7 @@ cpdef np.ndarray change_hp_value(
                             to_disable.add(ch.name)
 
     for idx in disabled:
-        configuration_array[idx] = NaN
+        if idx not in hps_to_be_activate:
+            configuration_array[idx] = NaN
 
     return configuration_array

test/test_util.py

@@ -277,6 +277,35 @@ def test_check_neighbouring_config_diamond(self):
 
         np.testing.assert_almost_equal(new_array, expected_array)
 
+    def test_check_neighbouring_config_diamond_or_conjunction(self):
+        diamond = ConfigurationSpace()
+        top = CategoricalHyperparameter('top', [0, 1], 0)
+        middle = CategoricalHyperparameter('middle', [0, 1], 1)
+        bottom_left = CategoricalHyperparameter('bottom_left', [0, 1], 1)
+        bottom_right = CategoricalHyperparameter('bottom_right', [0, 1, 2, 3], 1)
+
+        diamond.add_hyperparameters([top, bottom_left, bottom_right, middle])
+        diamond.add_condition(EqualsCondition(middle, top, 0))
+        diamond.add_condition(EqualsCondition(bottom_left, middle, 0))
+        diamond.add_condition(OrConjunction(EqualsCondition(bottom_right, middle, 1),
+                                            EqualsCondition(bottom_right, top, 1)))
+
+        config = Configuration(diamond, {'top': 0, 'middle': 1, 'bottom_right': 1})
+        hp_name = "top"
+        index = diamond.get_idx_by_hyperparameter_name(hp_name)
+        neighbor_value = 1
+
+        new_array = ConfigSpace.c_util.change_hp_value(
+            diamond,
+            config.get_array(),
+            hp_name,
+            neighbor_value,
+            index
+        )
+        expected_array = np.array([1, np.nan, np.nan, 1])
+
+        np.testing.assert_almost_equal(new_array, expected_array)
+
     def test_check_neighbouring_config_diamond_str(self):
         diamond = ConfigurationSpace()
         head = CategoricalHyperparameter('head', ['red', 'green'])