Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[7849] trunk/octave-forge/main/control/inst
|
From: <par...@us...> - 2010-10-16 20:46:26
|
Revision: 7849
http://octave.svn.sourceforge.net/octave/?rev=7849&view=rev
Author: paramaniac
Date: 2010-10-16 20:46:18 +0000 (Sat, 16 Oct 2010)
Log Message:
-----------
control: doc fixes
Modified Paths:
--------------
trunk/octave-forge/main/control/inst/@lti/feedback.m
trunk/octave-forge/main/control/inst/@lti/lft.m
trunk/octave-forge/main/control/inst/@lti/mconnect.m
trunk/octave-forge/main/control/inst/@lti/parallel.m
trunk/octave-forge/main/control/inst/@lti/series.m
trunk/octave-forge/main/control/inst/@tf/tf.m
trunk/octave-forge/main/control/inst/augw.m
trunk/octave-forge/main/control/inst/care.m
trunk/octave-forge/main/control/inst/dare.m
trunk/octave-forge/main/control/inst/dlqr.m
trunk/octave-forge/main/control/inst/dlyap.m
trunk/octave-forge/main/control/inst/dlyapchol.m
trunk/octave-forge/main/control/inst/dss.m
trunk/octave-forge/main/control/inst/h2syn.m
trunk/octave-forge/main/control/inst/hinfsyn.m
trunk/octave-forge/main/control/inst/initial.m
trunk/octave-forge/main/control/inst/isstabilizable.m
trunk/octave-forge/main/control/inst/kalman.m
trunk/octave-forge/main/control/inst/lqr.m
trunk/octave-forge/main/control/inst/lyap.m
trunk/octave-forge/main/control/inst/lyapchol.m
trunk/octave-forge/main/control/inst/margin.m
trunk/octave-forge/main/control/inst/mixsyn.m
trunk/octave-forge/main/control/inst/place.m
trunk/octave-forge/main/control/inst/rlocus.m
Modified: trunk/octave-forge/main/control/inst/@lti/feedback.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/feedback.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@lti/feedback.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -23,6 +23,8 @@
## @deftypefnx {Function File} {@var{sys} =} feedback (@var{sys1}, @var{sys2}, @var{feedin}, @var{feedout})
## @deftypefnx {Function File} {@var{sys} =} feedback (@var{sys1}, @var{sys2}, @var{feedin}, @var{feedout}, @var{"+"})
## Feedback connection of two LTI models.
+##
+## @strong{Block Diagram}
## @example
## @group
## u + +--------+ y
Modified: trunk/octave-forge/main/control/inst/@lti/lft.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/lft.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@lti/lft.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -40,6 +40,7 @@
## Resulting LTI model.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
## .............sys..............
Modified: trunk/octave-forge/main/control/inst/@lti/mconnect.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/mconnect.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@lti/mconnect.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -38,6 +38,7 @@
## Interconnected system.
## @end table
##
+## @strong{Example}
## @example
## @group
## Solve the system equations of
Modified: trunk/octave-forge/main/control/inst/@lti/parallel.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/parallel.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@lti/parallel.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -18,6 +18,8 @@
## -*- texinfo -*-
## @deftypefn{Function File} {@var{sys} =} parallel (@var{sys1}, @var{sys2})
## Parallel connection of two LTI systems.
+##
+## @strong{Block Diagram}
## @example
## @group
## ..........................
Modified: trunk/octave-forge/main/control/inst/@lti/series.m
===================================================================
--- trunk/octave-forge/main/control/inst/@lti/series.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@lti/series.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -19,6 +19,8 @@
## @deftypefn {Function File} {@var{sys} =} series (@var{sys1}, @var{sys2})
## @deftypefnx {Function File} {@var{sys} =} series (@var{sys1}, @var{sys2}, @var{outputs1}, @var{inputs2})
## Series connection of two LTI models.
+##
+## @strong{Block Diagram}
## @example
## @group
## .....................................
Modified: trunk/octave-forge/main/control/inst/@tf/tf.m
===================================================================
--- trunk/octave-forge/main/control/inst/@tf/tf.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/@tf/tf.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -45,10 +45,27 @@
## Transfer function model.
## @end table
##
+## @strong{Example}
## @example
## @group
-## s = tf ("s");
-## G = 1/(s+1)
+## octave:1> s = tf ("s");
+## octave:2> G = 1/(s+1)
+##
+## Transfer function "G" from input "u1" to output ...
+## 1
+## y1: -----
+## s + 1
+##
+## octave:3> z = tf ("z", 0.2);
+## octave:4> H = 0.095/(z-0.9)
+##
+## Transfer function "H" from input "u1" to output ...
+## 0.095
+## y1: -------
+## z - 0.9
+##
+## Sampling time: 0.2 s
+## octave:5>
## @end group
## @end example
##
Modified: trunk/octave-forge/main/control/inst/augw.m
===================================================================
--- trunk/octave-forge/main/control/inst/augw.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/augw.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -41,6 +41,7 @@
## State-space model of augmented plant.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
##
Modified: trunk/octave-forge/main/control/inst/care.m
===================================================================
--- trunk/octave-forge/main/control/inst/care.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/care.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -50,6 +50,7 @@
## Corresponding gain matrix (m-by-n).
## @end table
##
+## @strong{Equations}
## @example
## @group
## -1
Modified: trunk/octave-forge/main/control/inst/dare.m
===================================================================
--- trunk/octave-forge/main/control/inst/dare.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/dare.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -50,6 +50,7 @@
## Corresponding gain matrix (m-by-n).
## @end table
##
+## @strong{Equations}
## @example
## @group
## -1
Modified: trunk/octave-forge/main/control/inst/dlqr.m
===================================================================
--- trunk/octave-forge/main/control/inst/dlqr.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/dlqr.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -52,6 +52,7 @@
## Closed-loop poles.
## @end table
##
+## @strong{Equations}
## @example
## @group
## x[k+1] = A x[k] + B u[k], x[0] = x0
Modified: trunk/octave-forge/main/control/inst/dlyap.m
===================================================================
--- trunk/octave-forge/main/control/inst/dlyap.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/dlyap.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -23,6 +23,7 @@
## Uses SLICOT SB03MD, SB04QD and SG03AD by courtesy of NICONET e.V.
## <http://www.slicot.org>
##
+## @strong{Equations}
## @example
## @group
## AXA' - X + B = 0 (Lyapunov Equation)
Modified: trunk/octave-forge/main/control/inst/dlyapchol.m
===================================================================
--- trunk/octave-forge/main/control/inst/dlyapchol.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/dlyapchol.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -22,6 +22,7 @@
## Uses SLICOT SB03OD and SG03BD by courtesy of NICONET e.V.
## <http://www.slicot.org>
##
+## @strong{Equations}
## @example
## @group
## A U' U A' - U' U + B B' = 0 (Lyapunov Equation)
Modified: trunk/octave-forge/main/control/inst/dss.m
===================================================================
--- trunk/octave-forge/main/control/inst/dss.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/dss.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -48,6 +48,7 @@
## Descriptor state-space model.
## @end table
##
+## @strong{Equations}
## @example
## @group
## .
Modified: trunk/octave-forge/main/control/inst/h2syn.m
===================================================================
--- trunk/octave-forge/main/control/inst/h2syn.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/h2syn.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -45,6 +45,7 @@
## H-2 norm of @var{N}.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
##
Modified: trunk/octave-forge/main/control/inst/hinfsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/hinfsyn.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/hinfsyn.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -49,6 +49,7 @@
## L-infinity norm of @var{N}.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
##
Modified: trunk/octave-forge/main/control/inst/initial.m
===================================================================
--- trunk/octave-forge/main/control/inst/initial.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/initial.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -51,7 +51,7 @@
## State trajectories array. Has length(t) rows and as many columns as states.
## @end table
##
-## @seealso{impulse, lsim, step}
+## @strong{Example}
## @example
## @group
## .
@@ -60,6 +60,8 @@
## Discrete Time: x[k+1] = A x[k] , y[k] = C x[k] , x[0] = x0
## @end group
## @end example
+##
+## @seealso{impulse, lsim, step}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/isstabilizable.m
===================================================================
--- trunk/octave-forge/main/control/inst/isstabilizable.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/isstabilizable.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -56,9 +56,9 @@
## System is stabilizable.
## @end table
##
+## @strong{Method}
## @example
## @group
-## Method
## * Calculate staircase form (SLICOT AB01OD)
## * Extract unobservable part of state transition matrix
## * Calculate eigenvalues of unobservable part
Modified: trunk/octave-forge/main/control/inst/kalman.m
===================================================================
--- trunk/octave-forge/main/control/inst/kalman.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/kalman.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -49,6 +49,7 @@
## Solution of the Riccati equation.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
## u +-------+ ^
Modified: trunk/octave-forge/main/control/inst/lqr.m
===================================================================
--- trunk/octave-forge/main/control/inst/lqr.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/lqr.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -52,6 +52,7 @@
## Closed-loop poles.
## @end table
##
+## @strong{Equations}
## @example
## @group
## .
Modified: trunk/octave-forge/main/control/inst/lyap.m
===================================================================
--- trunk/octave-forge/main/control/inst/lyap.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/lyap.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -23,6 +23,7 @@
## Uses SLICOT SB03MD, SB04MD and SG03AD by courtesy of NICONET e.V.
## <http://www.slicot.org>
##
+## @strong{Equations}
## @example
## @group
## AX + XA' + B = 0 (Lyapunov Equation)
Modified: trunk/octave-forge/main/control/inst/lyapchol.m
===================================================================
--- trunk/octave-forge/main/control/inst/lyapchol.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/lyapchol.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -22,6 +22,7 @@
## Uses SLICOT SB03OD and SG03BD by courtesy of NICONET e.V.
## <http://www.slicot.org>
##
+## @strong{Equations}
## @example
## @group
## A U' U + U' U A' + B B' = 0 (Lyapunov Equation)
Modified: trunk/octave-forge/main/control/inst/margin.m
===================================================================
--- trunk/octave-forge/main/control/inst/margin.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/margin.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -43,8 +43,7 @@
## Frequency for the phase margin (in rad/s).
## @end table
##
-## @seealso{roots}
-##
+## @strong{Equations}
## @example
## @group
## CONTINUOUS SYSTEMS
@@ -115,6 +114,8 @@
## = ( e z + d z + c z + b z + a ) / ( z )
## @end group
## @end example
+##
+## @seealso{roots}
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/main/control/inst/mixsyn.m
===================================================================
--- trunk/octave-forge/main/control/inst/mixsyn.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/mixsyn.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -49,6 +49,7 @@
## L-infinity norm of @var{N}.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
##
Modified: trunk/octave-forge/main/control/inst/place.m
===================================================================
--- trunk/octave-forge/main/control/inst/place.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/place.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -55,6 +55,7 @@
## eigenvalue assignment algorithm.
## @end table
##
+## @strong{Note}
## @example
## @group
## Place is also suitable to design estimator gains:
Modified: trunk/octave-forge/main/control/inst/rlocus.m
===================================================================
--- trunk/octave-forge/main/control/inst/rlocus.m 2010-10-16 09:41:22 UTC (rev 7848)
+++ trunk/octave-forge/main/control/inst/rlocus.m 2010-10-16 20:46:18 UTC (rev 7849)
@@ -41,6 +41,7 @@
## Gains for real axis break points.
## @end table
##
+## @strong{Block Diagram}
## @example
## @group
## u + +---+ +------+ y
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
