Rename split and combine to split_tf and combine_tf

sdahdah · sdahdah · commit 9f4bf4fdada6 · 2024-12-04T11:37:17.000-05:00
diff --git a/control/bdalg.py b/control/bdalg.py
@@ -10,8 +10,8 @@
 negate
 feedback
 connect
-combine
-split
+combine_tf
+split_tf
 
 """
 
@@ -65,16 +65,8 @@
 from . import xferfcn as tf
 from .iosys import InputOutputSystem
 
-__all__ = [
-    'series',
-    'parallel',
-    'negate',
-    'feedback',
-    'append',
-    'connect',
-    'combine',
-    'split',
-]
+__all__ = ['series', 'parallel', 'negate', 'feedback', 'append', 'connect',
+           'combine_tf', 'split_tf']
 
 
 def series(sys1, *sysn, **kwargs):
@@ -519,7 +511,7 @@ def connect(sys, Q, inputv, outputv):
 
     return Ytrim * sys * Utrim
 
-def combine(tf_array):
+def combine_tf(tf_array):
     """Combine array-like of transfer functions into MIMO transfer function.
 
     Parameters
@@ -551,7 +543,7 @@ def combine(tf_array):
     Combine two transfer functions
 
     >>> s = control.TransferFunction.s
-    >>> control.combine([
+    >>> control.combine_tf([
     ...     [1 / (s + 1)],
     ...     [s / (s + 2)],
     ... ])
@@ -611,7 +603,7 @@ def combine(tf_array):
     G_tf = tf.TransferFunction(num, den, dt=dt)
     return G_tf
 
-def split(transfer_function):
+def split_tf(transfer_function):
     """Split MIMO transfer function into NumPy array of SISO tranfer functions.
 
     Parameters
@@ -638,7 +630,7 @@ def split(transfer_function):
     ...         [[1, 1], [1, 1]],
     ...     ],
     ... )
-    >>> control.split(G)
+    >>> control.split_tf(G)
     array([[TransferFunction(array([87.8]), array([1, 1])),
             TransferFunction(array([-86.4]), array([1, 1]))],
            [TransferFunction(array([108.2]), array([1, 1])),
diff --git a/control/tests/bdalg_test.py b/control/tests/bdalg_test.py
@@ -466,7 +466,7 @@ def test_error_ensure(self, arraylike_or_tf, dt, exception):
 
 
 class TestTfCombineSplit:
-    """Test :func:`combine` and :func:`split`."""
+    """Test :func:`combine_tf` and :func:`split_tf`."""
 
     @pytest.mark.parametrize(
         "tf_array, tf",
@@ -621,9 +621,9 @@ class TestTfCombineSplit:
             ),
         ],
     )
-    def test_combine(self, tf_array, tf):
+    def test_combine_tf(self, tf_array, tf):
         """Test combining transfer functions."""
-        tf_combined = ctrl.combine(tf_array)
+        tf_combined = ctrl.combine_tf(tf_array)
         assert _tf_close_coeff(tf_combined, tf)
 
     @pytest.mark.parametrize(
@@ -706,9 +706,9 @@ def test_combine(self, tf_array, tf):
             ),
         ],
     )
-    def test_split(self, tf_array, tf):
+    def test_split_tf(self, tf_array, tf):
         """Test splitting transfer functions."""
-        tf_split = ctrl.split(tf)
+        tf_split = ctrl.split_tf(tf)
         # Test entry-by-entry
         for i in range(tf_split.shape[0]):
             for j in range(tf_split.shape[1]):
@@ -718,8 +718,8 @@ def test_split(self, tf_array, tf):
                 )
         # Test combined
         assert _tf_close_coeff(
-            ctrl.combine(tf_split),
-            ctrl.combine(tf_array),
+            ctrl.combine_tf(tf_split),
+            ctrl.combine_tf(tf_array),
         )
 
     @pytest.mark.parametrize(
@@ -817,10 +817,10 @@ def test_split(self, tf_array, tf):
             ),
         ],
     )
-    def test_error_combine(self, tf_array, exception):
+    def test_error_combine_tf(self, tf_array, exception):
         """Test error cases."""
         with pytest.raises(exception):
-            ctrl.combine(tf_array)
+            ctrl.combine_tf(tf_array)
 
 
 def _tf_close_coeff(tf_a, tf_b, rtol=1e-5, atol=1e-8):
