Mercurial > forge

changeset 10726:6005d2ebb778 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
control: doc enhancements
author paramaniac
date Sat, 25 Aug 2012 05:44:24 +0000
parents c573aaa8f2d4
children f3f41bef14b2
files main/control/inst/margin.m main/control/inst/sensitivity.m
diffstat 2 files changed, 9 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/main/control/inst/margin.m	Fri Aug 24 16:27:38 2012 +0000
+++ b/main/control/inst/margin.m	Sat Aug 25 05:44:24 2012 +0000
@@ -18,9 +18,11 @@
 ## -*- texinfo -*-
 ## @deftypefn{Function File} {[@var{gamma}, @var{phi}, @var{w_gamma}, @var{w_phi}] =} margin (@var{sys})
 ## @deftypefnx{Function File} {[@var{gamma}, @var{phi}, @var{w_gamma}, @var{w_phi}] =} margin (@var{sys}, @var{tol})
-## Gain and phase margin of a system.  If no output arguments are given, both gain and phase margin
-## are plotted on a bode diagram.  Otherwise, the margins and their corresponding frequencies are
-## computed and returned.
+## Gain and phase margin of a system.
+## If no output arguments are given, both gain and phase margin are plotted on a bode diagram.
+## Otherwise, the margins and their corresponding frequencies are computed and returned.
+## A more robust criterion to assess the stability of a feedback system is the sensitivity Ms
+## computed by command @command{sensitivity}.
 ##
 ## @strong{Inputs}
 ## @table @var
--- a/main/control/inst/sensitivity.m	Fri Aug 24 16:27:38 2012 +0000
+++ b/main/control/inst/sensitivity.m	Sat Aug 25 05:44:24 2012 +0000
@@ -37,7 +37,10 @@
 ##
 ## @end ifnottex
 ## If no output arguments are given, the critical distance 1/Ms
-## is plotted on a Nyquist diagram. 
+## is plotted on a Nyquist diagram.
+## In contrast to gain and phase margin as computed by command
+## @command{margin}, the sensitivity @var{Ms} is a more robust
+## criterion to assess the stability of a feedback system.
 ##
 ## @strong{Inputs}
 ## @table @var