Merge pull request #976 from henriks76/system-norms-doc

bnavigator · web-flow · commit 7a70be1b7782 · 2024-03-05T10:28:10.000+01:00
norm added to the sphinx documentation
diff --git a/control/sysnorm.py b/control/sysnorm.py
@@ -94,13 +94,13 @@ def norm(system, p=2, tol=1e-6, print_warning=True, method=None):
         Type of norm to be computed. ``p=2`` gives the H2 norm, and ``p='inf'`` gives the L-infinity norm.
     tol : float
         Relative tolerance for accuracy of L-infinity norm computation. Ignored
-        unless p='inf'.
+        unless ``p='inf'``.
     print_warning : bool
         Print warning message in case norm value may be uncertain.
     method : str, optional
         Set the method used for computing the result.  Current methods are
-        'slycot' and 'scipy'. If set to None (default), try 'slycot' first
-        and then 'scipy'.
+        ``'slycot'`` and ``'scipy'``. If set to ``None`` (default), try ``'slycot'`` first
+        and then ``'scipy'``.
     
     Returns
     -------
@@ -114,10 +114,10 @@ def norm(system, p=2, tol=1e-6, print_warning=True, method=None):
     Examples
     --------
     >>> Gc = ct.tf([1], [1, 2, 1])
-    >>> ct.norm(Gc, 2)
-    0.5000000000000001
-    >>> ct.norm(Gc, 'inf', tol=1e-11, method='scipy')
-    1.000000000007276
+    >>> round(ct.norm(Gc, 2), 3)
+    0.5
+    >>> round(ct.norm(Gc, 'inf', tol=1e-5, method='scipy'), 3)
+    1.0
     """
            
     if not isinstance(system, (ct.StateSpace, ct.TransferFunction)):
diff --git a/doc/control.rst b/doc/control.rst
@@ -179,6 +179,7 @@ Utility functions and conversions
     issys
     mag2db
     modal_form
+    norm
     observable_form
     pade
     reachable_form
