0.27.7

Author: bartzbeielstein

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spotpython"
-version = "0.27.6"
+version = "0.27.7"
 authors = [
   { name="T. Bartz-Beielstein", email="tbb@bartzundbartz.de" }
 ]

src/spotpython/utils/stats.py

@@ -786,24 +786,36 @@ def preprocess_df_for_ols(df, independent_var_columns, target_col) -> tuple:
     return X_encoded, y
 
 
-def get_combinations(z_ind: list) -> list:
+def get_combinations(ind_list: list, type="indices") -> list:
     """
     Generates all possible combinations of two targets from a list of target indices. Order is not important.
 
     Args:
-        z_ind (list): A list of target indices.
+        ind_list (list): A list of target indices.
 
     Returns:
         list: A list of tuples, where each tuple contains a combination of two target indices.
              The order of the targets within a tuple is not important, and each combination
              appears only once.
+        type (str): The type of output, either 'values' or 'indices'. Default is 'indices'.
 
     Examples:
         >>> from spotpython.utils.stats import get_combinations
-        >>> z_ind = [0, 1, 2, 30]
-        >>> combinations = get_combinations(z_ind)
-        >>> print(combinations)
-        [(0, 1), (0, 2), (0, 30), (1, 2), (1, 30), (2, 30)]
+        >>> ind_list = [0, 10, 20, 30]
+        >>> combinations = get_combinations(ind_list)
+        >>> combinations = get_combinations(ind_list, type='indices')
+            [(0, 1), (0, 2), (0, 3), (1, 2), (1, 3), (2, 3)]
+        >>> print(combinations, type='values')
+            [(0, 10), (0, 20), (0, 30), (1, 20), (1, 30), (2, 30)]
     """
-    combinations = [(z_ind[i], z_ind[j]) for i in range(len(z_ind)) for j in range(i + 1, len(z_ind))]
+    # check that ind_list is a list
+    if not isinstance(ind_list, list):
+        raise ValueError("ind_list must be a list.")
+    m = len(ind_list)
+    if type == "values":
+        combinations = [(ind_list[i], ind_list[j]) for i in range(m) for j in range(i + 1, m)]
+    elif type == "indices":
+        combinations = [(i, j) for i in range(m) for j in range(i + 1, m)]
+    else:
+        raise ValueError("type must be either 'values' or 'indices'.")
     return combinations

test/test_get_combinations.py

@@ -4,23 +4,49 @@
 def test_get_combinations_empty_list():
     """Test get_combinations with an empty list."""
     assert get_combinations([]) == []
+    assert get_combinations([], type="indices") == []
+    assert get_combinations([], type="values") == []
 
 def test_get_combinations_single_element():
     """Test get_combinations with a single element."""
     assert get_combinations([0]) == []
+    assert get_combinations([0], type="indices") == []
+    assert get_combinations([0], type="values") == []
 
 def test_get_combinations_two_elements():
     """Test get_combinations with two elements."""
     assert get_combinations([0, 1]) == [(0, 1)]
+    assert get_combinations([0, 1], type="indices") == [(0, 1)]
+    assert get_combinations([0, 1], type="values") == [(0, 1)]
 
 def test_get_combinations_multiple_elements():
     """Test get_combinations with multiple elements."""
     z_ind = [0, 1, 2, 3]
-    expected = [(0, 1), (0, 2), (0, 3), (1, 2), (1, 3), (2, 3)]
-    assert get_combinations(z_ind) == expected
+    expected_indices = [(0, 1), (0, 2), (0, 3), (1, 2), (1, 3), (2, 3)]
+    expected_values = [(0, 1), (0, 2), (0, 3), (1, 2), (1, 3), (2, 3)]
+    assert get_combinations(z_ind) == expected_indices
+    assert get_combinations(z_ind, type="indices") == expected_indices
+    assert get_combinations(z_ind, type="values") == expected_values
 
 def test_get_combinations_non_sequential_indices():
     """Test get_combinations with non-sequential indices."""
     z_ind = [10, 20, 30]
-    expected = [(10, 20), (10, 30), (20, 30)]  # Indices are based on values, not indices
-    assert get_combinations(z_ind) == expected
+    expected_indices = [(0, 1), (0, 2), (1, 2)]
+    expected_values = [(10, 20), (10, 30), (20, 30)]
+    assert get_combinations(z_ind) == expected_indices
+    assert get_combinations(z_ind, type="indices") == expected_indices
+    assert get_combinations(z_ind, type="values") == expected_values
+
+def test_get_combinations_mixed_values():
+    """Test get_combinations with mixed values."""
+    z_ind = [0, 10, 20, 30]
+    expected_indices = [(0, 1), (0, 2), (0, 3), (1, 2), (1, 3), (2, 3)]
+    expected_values = [(0, 10), (0, 20), (0, 30), (10, 20), (10, 30), (20, 30)]
+    assert get_combinations(z_ind) == expected_indices
+    assert get_combinations(z_ind, type="indices") == expected_indices
+    assert get_combinations(z_ind, type="values") == expected_values
+
+def test_get_combinations_invalid_type():
+    """Test get_combinations with an invalid type."""
+    with pytest.raises(ValueError):
+        get_combinations([1, 2, 3], type="invalid")