changeset 5460:eaedbf469316

[project @ 2005-09-20 19:27:07 by jwe]
author jwe
date Tue, 20 Sep 2005 19:27:07 +0000
parents ff40c78cebf0
children 8d8fc8eff9e6
files scripts/ChangeLog scripts/control/base/rlocus.m
diffstat 2 files changed, 14 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,7 @@
+2005-09-20  "Orestes Mas"  <orestes@tsc.upc.edu>
+
+	* control/base/rlocus.m: Doc fix.
+
 2005-09-20  John W. Eaton  <jwe@octave.org>
 
 	* general/isvector.m: Improve compatibility.
--- a/scripts/control/base/rlocus.m
+++ b/scripts/control/base/rlocus.m
@@ -18,9 +18,9 @@
 ## 02110-1301 USA.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[@var{rldata}, @var{k}] =} rlocus (@var{sys}[, @var{increment}, @var{min_k}, @var{max_k}])
+## @deftypefn {Function File} {[@var{rldata}, @var{k_break}, @var{rlpol}, @var{gvec}, @var{real_ax_pts}] =} rlocus (@var{sys}[, @var{increment}, @var{min_k}, @var{max_k}])
 ##
-## Displays root locus plot of the specified @acronym{SISO} system.
+## Display root locus plot of the specified @acronym{SISO} system.
 ## @example
 ## @group
 ##        -----   ---     --------
@@ -49,8 +49,15 @@
 ## @table @var 
 ## @item rldata
 ## Data points plotted: in column 1 real values, in column 2 the imaginary values.
-## @item k
+## @item k_break
 ## Gains for real axis break points.
+## @item rlpol
+## Closed-loop roots for each gain value: 1 locus branch per row; 1 pole
+## set per column
+## @item gvec
+## Gains vector
+## @item real_ax_pts
+## Real axis breakpoints
 ## @end table
 ## @end deftypefn