0.27.6

Author: bartzbeielstein

pyproject.toml

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

src/spotpython/utils/stats.py

@@ -784,3 +784,26 @@ def preprocess_df_for_ols(df, independent_var_columns, target_col) -> tuple:
         raise ValueError(f"Mismatch in rows: predictors (X_encoded) have {X_encoded.shape[0]} rows, " f"but target (y) has {y.shape[0]} rows.")
 
     return X_encoded, y
+
+
+def get_combinations(z_ind: list) -> 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.
+
+    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.
+
+    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)]
+    """
+    combinations = [(z_ind[i], z_ind[j]) for i in range(len(z_ind)) for j in range(i + 1, len(z_ind))]
+    return combinations

test/test_get_combinations.py

@@ -0,0 +1,26 @@
+import pytest
+from spotpython.utils.stats import get_combinations
+
+def test_get_combinations_empty_list():
+    """Test get_combinations with an empty list."""
+    assert get_combinations([]) == []
+
+def test_get_combinations_single_element():
+    """Test get_combinations with a single element."""
+    assert get_combinations([0]) == []
+
+def test_get_combinations_two_elements():
+    """Test get_combinations with two elements."""
+    assert get_combinations([0, 1]) == [(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
+
+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