remove use_numpy_matrix

murrayrm · murrayrm · commit aa106ba47096 · 2023-06-10T09:42:15.000-07:00
diff --git a/control/config.py b/control/config.py
@@ -14,7 +14,7 @@
 
 __all__ = ['defaults', 'set_defaults', 'reset_defaults',
            'use_matlab_defaults', 'use_fbs_defaults',
-           'use_legacy_defaults', 'use_numpy_matrix']
+           'use_legacy_defaults']
 
 # Package level default values
 _control_defaults = {
@@ -211,7 +211,6 @@ def use_matlab_defaults():
 
     """
     set_defaults('freqplot', dB=True, deg=True, Hz=False, grid=True)
-    set_defaults('statesp', use_numpy_matrix=True)
 
 
 # Set defaults to match FBS (Astrom and Murray)
@@ -233,41 +232,6 @@ def use_fbs_defaults():
     set_defaults('nyquist', mirror_style='--')
 
 
-# Decide whether to use numpy.matrix for state space operations
-def use_numpy_matrix(flag=True, warn=True):
-    """Turn on/off use of Numpy `matrix` class for state space operations.
-
-    Parameters
-    ----------
-    flag : bool
-        If flag is `True` (default), use the deprecated Numpy
-        `matrix` class to represent matrices in the `~control.StateSpace`
-        class and functions.  If flat is `False`, then matrices are
-        represented by a 2D `ndarray` object.
-
-    warn : bool
-        If flag is `True` (default), issue a warning when turning on the use
-        of the Numpy `matrix` class.  Set `warn` to false to omit display of
-        the warning message.
-
-    Notes
-    -----
-    Prior to release 0.9.x, the default type for 2D arrays is the Numpy
-    `matrix` class.  Starting in release 0.9.0, the default type for state
-    space operations is a 2D array.
-
-    Examples
-    --------
-    >>> ct.use_numpy_matrix(True, False)
-    >>> # do some legacy calculations using np.matrix
-
-    """
-    if flag and warn:
-        warnings.warn("Return type numpy.matrix is deprecated.",
-                      stacklevel=2, category=DeprecationWarning)
-    set_defaults('statesp', use_numpy_matrix=flag)
-
-
 def use_legacy_defaults(version):
     """ Sets the defaults to whatever they were in a given release.
 
@@ -331,7 +295,7 @@ def use_legacy_defaults(version):
     # Version 0.9.0:
     if major == 0 and minor < 9:
         # switched to 'array' as default for state space objects
-        set_defaults('statesp', use_numpy_matrix=True)
+        warnings.warn("NumPy matrix class no longer supported")
 
         # switched to 0 (=continuous) as default timestep
         set_defaults('control', default_dt=None)
diff --git a/control/mateqn.py b/control/mateqn.py
@@ -126,14 +126,9 @@ def lyap(A, Q, C=None, E=None, method=None):
 
     Returns
     -------
-    X : 2D array (or matrix)
+    X : 2D array
         Solution to the Lyapunov or Sylvester equation
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     """
     # Decide what method to use
     method = _slycot_or_scipy(method)
@@ -260,11 +255,6 @@ def dlyap(A, Q, C=None, E=None, method=None):
     X : 2D array (or matrix)
         Solution to the Lyapunov or Sylvester equation
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     """
     # Decide what method to use
     method = _slycot_or_scipy(method)
@@ -395,11 +385,6 @@ def care(A, B, Q, R=None, S=None, E=None, stabilizing=True, method=None,
     G : 2D array (or matrix)
         Gain matrix
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     """
     # Decide what method to use
     method = _slycot_or_scipy(method)
@@ -554,11 +539,6 @@ def dare(A, B, Q, R, S=None, E=None, stabilizing=True, method=None,
     G : 2D array (or matrix)
         Gain matrix
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     """
     # Decide what method to use
     method = _slycot_or_scipy(method)
diff --git a/control/statefbk.py b/control/statefbk.py
@@ -110,9 +110,6 @@ def place(A, B, p):
         The algorithm will not place poles at the same location more
         than rank(B) times.
 
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     References
     ----------
     .. [1] A.L. Tits and Y. Yang, "Globally convergent algorithms for robust
@@ -193,11 +190,6 @@ def place_varga(A, B, p, dtime=False, alpha=None):
     [1] Varga A. "A Schur method for pole assignment."  IEEE Trans. Automatic
         Control, Vol. AC-26, pp. 517-519, 1981.
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> A = [[-1, -1], [0, 1]]
@@ -279,10 +271,6 @@ def acker(A, B, poles):
     K : 2D array (or matrix)
         Gains such that A - B K has given eigenvalues
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
     """
     # Convert the inputs to matrices
     a = _ssmatrix(A)
@@ -366,13 +354,10 @@ def lqr(*args, **kwargs):
 
     Notes
     -----
-    1. If the first argument is an LTI object, then this object will be used
-       to define the dynamics and input matrices.  Furthermore, if the LTI
-       object corresponds to a discrete time system, the ``dlqr()`` function
-       will be called.
-
-    2. The return type for 2D arrays depends on the default class set for
-       state space operations.  See :func:`~control.use_numpy_matrix`.
+    If the first argument is an LTI object, then this object will be used
+    to define the dynamics and input matrices.  Furthermore, if the LTI
+    object corresponds to a discrete time system, the ``dlqr()`` function
+    will be called.
 
     Examples
     --------
@@ -514,11 +499,6 @@ def dlqr(*args, **kwargs):
     --------
     lqr, lqe, dlqe
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> K, S, E = dlqr(dsys, Q, R, [N])                         # doctest: +SKIP
@@ -971,11 +951,6 @@ def ctrb(A, B):
     C : 2D array (or matrix)
         Controllability matrix
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> G = ct.tf2ss([1], [1, 2, 3])
@@ -1010,11 +985,6 @@ def obsv(A, C):
     O : 2D array (or matrix)
         Observability matrix
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> G = ct.tf2ss([1], [1, 2, 3])
@@ -1063,11 +1033,6 @@ def gram(sys, type):
         if slycot routine sb03md cannot be found
         if slycot routine sb03od cannot be found
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> G = ct.rss(4)
diff --git a/control/statesp.py b/control/statesp.py
@@ -77,7 +77,6 @@
 
 # Define module default parameter values
 _statesp_defaults = {
-    'statesp.use_numpy_matrix': False,  # False is default in 0.9.0 and above
     'statesp.remove_useless_states': False,
     'statesp.latex_num_format': '.3g',
     'statesp.latex_repr_type': 'partitioned',
@@ -104,11 +103,8 @@ def _ssmatrix(data, axis=1):
     arr : 2D array, with shape (0, 0) if a is empty
 
     """
-    # Convert the data into an array or matrix, as configured
-    if config.defaults['statesp.use_numpy_matrix']:
-        arr = np.matrix(data, dtype=float)
-    else:
-        arr = np.array(data, dtype=float)
+    # Convert the data into an array
+    arr = np.array(data, dtype=float)
     ndim = arr.ndim
     shape = arr.shape
 
@@ -202,12 +198,7 @@ class StateSpace(LTI):
     -----
     The main data members in the ``StateSpace`` class are the A, B, C, and D
     matrices.  The class also keeps track of the number of states (i.e.,
-    the size of A).  The data format used to store state space matrices is
-    set using the value of `config.defaults['use_numpy_matrix']`.  If True
-    (default), the state space elements are stored as `numpy.matrix` objects;
-    otherwise they are `numpy.ndarray` objects.  The
-    :func:`~control.use_numpy_matrix` function can be used to set the storage
-    type.
+    the size of A).
 
     A discrete time system is created by specifying a nonzero 'timebase', dt
     when the system is constructed:
@@ -355,10 +346,8 @@ def __init__(self, *args, init_namedio=True, **kwargs):
         elif kwargs:
             raise TypeError("unrecognized keyword(s): ", str(kwargs))
 
-        # Reset shapes (may not be needed once np.matrix support is removed)
+        # Reset shape if system is static
         if self._isstatic():
-            # static gain
-            # matrix's default "empty" shape is 1x0
             A.shape = (0, 0)
             B.shape = (0, self.ninputs)
             C.shape = (self.noutputs, 0)
@@ -927,18 +916,17 @@ def horner(self, x, warn_infinite=True):
         x_arr = np.atleast_1d(x).astype(complex, copy=False)
 
         # return fast on systems with 0 or 1 state
-        if not config.defaults['statesp.use_numpy_matrix']:
-            if self.nstates == 0:
-                return self.D[:, :, np.newaxis] \
-                    * np.ones_like(x_arr, dtype=complex)
-            if self.nstates == 1:
-                with np.errstate(divide='ignore', invalid='ignore'):
-                    out = self.C[:, :, np.newaxis] \
-                          / (x_arr - self.A[0, 0]) \
-                          * self.B[:, :, np.newaxis] \
-                          + self.D[:, :, np.newaxis]
-                out[np.isnan(out)] = complex(np.inf, np.nan)
-                return out
+        if self.nstates == 0:
+            return self.D[:, :, np.newaxis] \
+                * np.ones_like(x_arr, dtype=complex)
+        elif self.nstates == 1:
+            with np.errstate(divide='ignore', invalid='ignore'):
+                out = self.C[:, :, np.newaxis] \
+                    / (x_arr - self.A[0, 0]) \
+                    * self.B[:, :, np.newaxis] \
+                    + self.D[:, :, np.newaxis]
+            out[np.isnan(out)] = complex(np.inf, np.nan)
+            return out
 
         try:
             out = self.slycot_laub(x_arr)
diff --git a/control/stochsys.py b/control/stochsys.py
@@ -101,13 +101,10 @@ def lqe(*args, **kwargs):
 
     Notes
     -----
-    1. If the first argument is an LTI object, then this object will be used
-       to define the dynamics, noise and output matrices.  Furthermore, if
-       the LTI object corresponds to a discrete time system, the ``dlqe()``
-       function will be called.
-
-    2. The return type for 2D arrays depends on the default class set for
-       state space operations.  See :func:`~control.use_numpy_matrix`.
+    If the first argument is an LTI object, then this object will be used
+    to define the dynamics, noise and output matrices.  Furthermore, if the
+    LTI object corresponds to a discrete time system, the ``dlqe()``
+    function will be called.
 
     Examples
     --------
@@ -236,11 +233,6 @@ def dlqe(*args, **kwargs):
     E : 1D array
         Eigenvalues of estimator poles eig(A - L C)
 
-    Notes
-    -----
-    The return type for 2D arrays depends on the default class set for
-    state space operations.  See :func:`~control.use_numpy_matrix`.
-
     Examples
     --------
     >>> L, P, E = dlqe(A, G, C, QN, RN)                         # doctest: +SKIP
diff --git a/control/tests/config_test.py b/control/tests/config_test.py
@@ -242,15 +242,13 @@ def test_reset_defaults(self):
         assert ct.config.defaults['freqplot.feature_periphery_decades'] == 1.0
 
     def test_legacy_defaults(self):
-        with pytest.deprecated_call():
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
             ct.use_legacy_defaults('0.8.3')
-            assert(isinstance(ct.ss(0, 0, 0, 1).D, np.matrix))
-        ct.reset_defaults()
-        assert isinstance(ct.ss(0, 0, 0, 1).D, np.ndarray)
-        assert not isinstance(ct.ss(0, 0, 0, 1).D, np.matrix)
+            ct.reset_defaults()
 
-        ct.use_legacy_defaults('0.8.4')
-        assert ct.config.defaults['forced_response.return_x'] is True
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
+            ct.use_legacy_defaults('0.8.4')
+            assert ct.config.defaults['forced_response.return_x'] is True
 
         ct.use_legacy_defaults('0.9.0')
         assert isinstance(ct.ss(0, 0, 0, 1).D, np.ndarray)
diff --git a/control/tests/iosys_test.py b/control/tests/iosys_test.py
@@ -252,10 +252,10 @@ def test_linearize_named_signals(self, kincar):
         assert linearized_newnames.find_output('y') is None
 
         # Test legacy version as well
-        ct.use_legacy_defaults('0.8.4')
-        ct.config.use_numpy_matrix(False)       # np.matrix deprecated
-        linearized = kincar.linearize([0, 0, 0], [0, 0], copy_names=True)
-        assert linearized.name == kincar.name + '_linearized'
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
+            ct.use_legacy_defaults('0.8.4')
+            linearized = kincar.linearize([0, 0, 0], [0, 0], copy_names=True)
+            assert linearized.name == kincar.name + '_linearized'
 
     def test_connect(self, tsys):
         # Define a couple of (linear) systems to interconnection
@@ -1059,8 +1059,8 @@ def test_sys_naming_convention(self, tsys):
         """Enforce generic system names 'sys[i]' to be present when systems are
         created without explicit names."""
 
-        ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
-        ct.config.use_numpy_matrix(False)       # np.matrix deprecated
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
+            ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
 
         # Create a system with a known ID
         ct.namedio.NamedIOSystem._idCounter = 0
@@ -1127,8 +1127,8 @@ def test_signals_naming_convention_0_8_4(self, tsys):
         output: 'y[i]'
         """
 
-        ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
-        ct.config.use_numpy_matrix(False)       # np.matrix deprecated
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
+            ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
 
         # Create a system with a known ID
         ct.namedio.NamedIOSystem._idCounter = 0
@@ -1433,8 +1433,8 @@ def test_duplicates(self, tsys):
             ios_series = nlios * nlios
 
         # Nonduplicate objects
-        ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
-        ct.config.use_numpy_matrix(False)       # np.matrix deprecated
+        with pytest.warns(UserWarning, match="NumPy matrix class no longer"):
+            ct.config.use_legacy_defaults('0.8.4')  # changed delims in 0.9.0
         nlios1 = nlios.copy()
         nlios2 = nlios.copy()
         with pytest.warns(UserWarning, match="duplicate name"):
diff --git a/control/tests/timeresp_test.py b/control/tests/timeresp_test.py
