From 875cc3078346498b9e3e3d04cba316cb515df4c6 Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Sun, 2 Feb 2025 22:54:31 -0800 Subject: [PATCH] add information on _ssmatrix, _check_shape --- README.rst | 4 +--- control/mateqn.py | 27 +++++++++++++++++++++++++++ control/statesp.py | 8 +++++--- doc/develop.rst | 2 ++ 4 files changed, 35 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 984862469..825693c91 100644 --- a/README.rst +++ b/README.rst @@ -110,7 +110,7 @@ from the github repository or archive, unpack, and run from within the toplevel `python-control` directory:: pip install . - + Article and Citation Information ================================ @@ -129,7 +129,6 @@ the library is available on IEEE Explore. If the Python Control Systems Library or the GitHub site: https://github.com/python-control/python-control - Development =========== @@ -178,4 +177,3 @@ Your contributions are welcome! Simply fork the GitHub repository and send a Please see the `Developer's Wiki`_ for detailed instructions. .. _Developer's Wiki: https://github.com/python-control/python-control/wiki - diff --git a/control/mateqn.py b/control/mateqn.py index 7f6580ac0..9d1349b0c 100644 --- a/control/mateqn.py +++ b/control/mateqn.py @@ -606,6 +606,33 @@ def _slycot_or_scipy(method): # Utility function to check matrix dimensions def _check_shape(M, n, m, square=False, symmetric=False, name="??"): + """Check the shape and properties of a 2D array. + + This function can be used to check to make sure a 2D array_like has the + right shape, along with other properties. If not, an appropriate error + message is generated. + + Parameters + ---------- + M : array_like + Array to be checked. + n : int + Expected number of rows. + m : int + Expected number of columns. + square : bool, optional + If True, check to make sure the matrix is square. + symmetric : bool, optional + If True, check to make sure the matrix is symmetric. + name : str + Name of the matrix (for use in error messages). + + Returns + ------- + M : 2D array + Input array, converted to 2D if needed. + + """ M = np.atleast_2d(M) if (square or symmetric) and M.shape[0] != M.shape[1]: diff --git a/control/statesp.py b/control/statesp.py index bafc196e6..93bee45da 100644 --- a/control/statesp.py +++ b/control/statesp.py @@ -2269,13 +2269,15 @@ def _parse_list(signals, signame='input', prefix='u'): def _ssmatrix(data, axis=1, square=None, rows=None, cols=None, name=None): """Convert argument to a (possibly empty) 2D state space matrix. - The axis keyword argument makes it convenient to specify that if the - input is a vector, it is a row (axis=1) or column (axis=0) vector. + This function can be used to process the matrices that define a + state-space system. The axis keyword argument makes it convenient + to specify that if the input is a vector, it is a row (axis=1) or + column (axis=0) vector. Parameters ---------- data : array, list, or string - Input data defining the contents of the 2D array + Input data defining the contents of the 2D array. axis : 0 or 1 If input data is 1D, which axis to use for return object. The default is 1, corresponding to a row matrix. diff --git a/doc/develop.rst b/doc/develop.rst index 2a14a6cc7..6386d6055 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -629,7 +629,9 @@ processing and parsing operations: exception.pandas_check exception.slycot_check iosys._process_iosys_keywords + mateqn._check_shape statesp._convert_to_statespace + statesp._ssmatrix xferfcn._convert_to_transfer_function pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy