changeset 6693:6bc6a08c3f7b octave-forge

control-oo: extend texinfo strings
author paramaniac
date Sat, 13 Feb 2010 14:53:52 +0000
parents 10edd71ae8cb
children 041ea4439bfb
files extra/control-oo/inst/care.m extra/control-oo/inst/dare.m
diffstat 2 files changed, 36 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/extra/control-oo/inst/care.m	Sat Feb 13 14:04:55 2010 +0000
+++ b/extra/control-oo/inst/care.m	Sat Feb 13 14:53:52 2010 +0000
@@ -23,6 +23,21 @@
 ## corresponding gain matrix g.
 ## Uses SLICOT SB02OD by courtesy of NICONET e.V.
 ## <http://www.slicot.org>
+## @example
+## @group
+##                -1
+## A'XA + XA - XBR  B'X + Q = 0
+## 
+##                       -1
+## A'XA + XA - (XB + S) R  (XB + L)' + Q = 0
+##
+##      -1
+## G = R  B'X
+##
+##      -1
+## G = R  (B'X + S')
+## @end group
+## @end example
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
@@ -31,6 +46,9 @@
 
 function [x, l, g] = care (a, b, q, r, s = [])
 
+  ## TODO : Add SLICOT SG02AD (Solution of continuous- or discrete-time
+  ##        algebraic Riccati equations for descriptor systems)
+
   if (nargin < 4 || nargin > 5)
     print_usage ();
   endif
--- a/extra/control-oo/inst/dare.m	Sat Feb 13 14:04:55 2010 +0000
+++ b/extra/control-oo/inst/dare.m	Sat Feb 13 14:53:52 2010 +0000
@@ -23,6 +23,21 @@
 ## corresponding gain matrix g.
 ## Uses SLICOT SB02OD by courtesy of NICONET e.V.
 ## <http://www.slicot.org>
+## @example
+## @group
+##                           -1
+## A'XA - X - A'XB (B'XB + R)   B'XA + Q = 0
+##
+##                                 -1
+## A'XA - X - (A'XB + S) (B'XB + R)   (A'XB + S)' + Q = 0
+##
+##               -1
+## G = (B'XB + R)   B'XA
+##
+##               -1
+## G = (B'XB + R)   (B'XA + S')
+## @end group
+## @end example
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
@@ -31,6 +46,9 @@
 
 function [x, l, g] = dare (a, b, q, r, s = [])
 
+  ## TODO : Add SLICOT SG02AD (Solution of continuous- or discrete-time
+  ##        algebraic Riccati equations for descriptor systems)
+
   if (nargin < 4 || nargin > 5)
     print_usage ();
   endif