Mercurial > forge

changeset 6448:5fc9f1814e80 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
control-oo: add/update texinfo strings
author paramaniac
date Fri, 11 Dec 2009 17:29:52 +0000
parents df4f8bcee6b9
children 040df11ece1a
files extra/control-oo/inst/care.m extra/control-oo/inst/dare.m extra/control-oo/inst/dlqr.m extra/control-oo/inst/lqr.m
diffstat 4 files changed, 23 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/extra/control-oo/inst/care.m	Fri Dec 11 14:24:53 2009 +0000
+++ b/extra/control-oo/inst/care.m	Fri Dec 11 17:29:52 2009 +0000
@@ -16,6 +16,12 @@
 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{x}, @var{l}, @var{g}] =} care (@var{a}, @var{b}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{x}, @var{l}, @var{g}] =} care (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
+## Return unique stabilizing solution x of the continuous-time
+## riccati equation as well as the closed-loop poles l and the
+## corresponding gain matrix g.
+## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
 ## Created: November 2009
--- a/extra/control-oo/inst/dare.m	Fri Dec 11 14:24:53 2009 +0000
+++ b/extra/control-oo/inst/dare.m	Fri Dec 11 17:29:52 2009 +0000
@@ -17,8 +17,9 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{x} =} dare (@var{a}, @var{b}, @var{q}, @var{r}, @var{opt})
-##
+## @deftypefn {Function File} {[@var{x}, @var{l}, @var{g}] =} dare (@var{a}, @var{b}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{x}, @var{l}, @var{g}] =} dare (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
+## @deftypefnx {Function File} {[@var{x}, @var{l}, @var{g}] =} dare (@var{a}, @var{b}, @var{q}, @var{r}, @var{s}, @var{opt})
 ## Return the solution, @var{x} of the discrete-time algebraic Riccati
 ## equation
 ## @iftex
--- a/extra/control-oo/inst/dlqr.m	Fri Dec 11 14:24:53 2009 +0000
+++ b/extra/control-oo/inst/dlqr.m	Fri Dec 11 17:29:52 2009 +0000
@@ -16,6 +16,13 @@
 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{sys}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{sys}, @var{q}, @var{r}, @var{s})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{a}, @var{b}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} dlqr (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
+## Return linear-quadratic state-feedback gain matrix g for a LTI system as well as
+## the solution x of the associated riccati equation and the closed-loop poles l.
+## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
 ## Created: November 2009
--- a/extra/control-oo/inst/lqr.m	Fri Dec 11 14:24:53 2009 +0000
+++ b/extra/control-oo/inst/lqr.m	Fri Dec 11 17:29:52 2009 +0000
@@ -16,6 +16,13 @@
 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{sys}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{sys}, @var{q}, @var{r}, @var{s})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{a}, @var{b}, @var{q}, @var{r})
+## @deftypefnx {Function File} {[@var{g}, @var{x}, @var{l}] =} lqr (@var{a}, @var{b}, @var{q}, @var{r}, @var{s})
+## Return linear-quadratic state-feedback gain matrix g for a LTI system as well as
+## the solution x of the associated riccati equation and the closed-loop poles l.
+## @end deftypefn
 
 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
 ## Created: November 2009