From 6828c670be5b1f6c3c36e8fc87447e0cbb90f7fa Mon Sep 17 00:00:00 2001 From: Henrik Sandberg Date: Sun, 3 Mar 2024 15:48:13 +0100 Subject: [PATCH] * Added norm to the function reference in the sphinx documentation under Utility functions and conversions * Use round in the docstring examples --- control/sysnorm.py | 14 +++++++------- doc/control.rst | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/control/sysnorm.py b/control/sysnorm.py index 49873dbaf..f5e583dcf 100644 --- 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 index 96714bf7d..1b1b74069 100644 --- 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 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