From: <par...@us...> - 2011-12-16 10:00:19
|
Revision: 9408 http://octave.svn.sourceforge.net/octave/?rev=9408&view=rev Author: paramaniac Date: 2011-12-16 10:00:12 +0000 (Fri, 16 Dec 2011) Log Message: ----------- control-devel: use single quotes in texinfo strings Modified Paths: -------------- trunk/octave-forge/extra/control-devel/inst/bstmodred.m trunk/octave-forge/extra/control-devel/inst/btaconred.m trunk/octave-forge/extra/control-devel/inst/btamodred.m trunk/octave-forge/extra/control-devel/inst/cfconred.m trunk/octave-forge/extra/control-devel/inst/fwcfconred.m trunk/octave-forge/extra/control-devel/inst/hnamodred.m trunk/octave-forge/extra/control-devel/inst/spaconred.m trunk/octave-forge/extra/control-devel/inst/spamodred.m Modified: trunk/octave-forge/extra/control-devel/inst/bstmodred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/bstmodred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/bstmodred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -113,7 +113,7 @@ ## @item nr ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -147,28 +147,28 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "nr" +## @item 'order', 'nr' ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is the sum of NU and the number of ## Hankel singular values greater than @code{MAX(TOL1,NS*EPS)}; ## @var{nr} can be further reduced to ensure that ## @code{HSV(NR-NU) > HSV(NR+1-NU)}. ## -## @item "method" +## @item 'method' ## Approximation method for the H-infinity norm. ## Valid values corresponding to this key are: ## @table @var -## @item "sr-bta", "b" +## @item 'sr-bta', 'b' ## Use the square-root Balance & Truncate method. -## @item "bfsr-bta", "f" +## @item 'bfsr-bta', 'f' ## Use the balancing-free square-root Balance & Truncate method. Default method. -## @item "sr-spa", "s" +## @item 'sr-spa', 's' ## Use the square-root Singular Perturbation Approximation method. -## @item "bfsr-spa", "p" +## @item 'bfsr-spa', 'p' ## Use the balancing-free square-root Singular Perturbation Approximation method. ## @end table ## -## @item "alpha" +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{G.A}. For a continuous-time ## system, ALPHA <= 0 is the boundary value for @@ -179,7 +179,7 @@ ## Default value is 0 for continuous-time systems and ## 1 for discrete-time systems. ## -## @item "beta" +## @item 'beta' ## Use @code{[G, beta*I]} as new system @var{G} to combine ## absolute and relative error methods. ## BETA > 0 specifies the absolute/relative error weighting @@ -192,8 +192,8 @@ ## the feedthrough matrice must not be rank-deficient. ## Default value is 0. ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of reduced system. ## For model reduction, the recommended value of @var{tol1} lies ## in the interval [0.00001, 0.001]. @var{tol1} < 1. @@ -201,17 +201,17 @@ ## @var{tol1} = NS*EPS, where NS is the number of ## ALPHA-stable eigenvalues of A and EPS is the machine ## precision. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the phase system (see METHOD) corresponding ## to the ALPHA-stable part of the given system. ## The recommended value is TOL2 = NS*EPS. TOL2 <= TOL1 < 1. -## This value is used by default if @var{"tol2"} is not specified +## This value is used by default if @var{'tol2'} is not specified ## or if TOL2 <= 0 on entry. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on system @var{G} prior to order reduction. ## Default value is true if @code{G.scaled == false} and Modified: trunk/octave-forge/extra/control-devel/inst/btaconred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/btaconred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/btaconred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -34,7 +34,7 @@ ## @item ncr ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -62,37 +62,37 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "ncr" +## @item 'order', 'ncr' ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr", "b" +## @item 'sr', 'b' ## Use the square-root Balance & Truncate method. -## @item "bfsr", "f" +## @item 'bfsr', 'f' ## Use the balancing-free square-root Balance & Truncate method. Default method. ## @end table ## -## @item "weight" +## @item 'weight' ## Specifies the type of frequency-weighting as follows: ## @table @var -## @item "none" +## @item 'none' ## No weightings are used (V = I, W = I). Default value. -## @item "left", "output" +## @item 'left', 'output' ## Use stability enforcing left (output) weighting ## @example ## -1 ## V = (I-G*K) *G , (W = I) ## @end example -## @item "right", "input" +## @item 'right', 'input' ## Use stability enforcing right (input) weighting ## @example ## -1 ## W = (I-G*K) *G , (V = I) ## @end example -## @item "both", "performance" +## @item 'both', 'performance' ## Use stability and performance enforcing weightings ## @example ## -1 -1 @@ -100,7 +100,7 @@ ## @end example ## @end table ## -## @item "alpha" +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{K.A}. For a continuous-time ## controller, ALPHA <= 0 is the boundary value for @@ -111,20 +111,20 @@ ## Default value is 0 for continuous-time controllers and ## 1 for discrete-time controllers. ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced controller. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsvc(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the ALPHA-stable part of the given ## controller. TOL2 <= TOL1. ## If not specified, ncs*eps*info.hsvc(1) is chosen. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on @var{G} and @var{K} prior to order reduction. ## Default value is false if both @code{G.scaled == true, K.scaled == true} Modified: trunk/octave-forge/extra/control-devel/inst/btamodred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/btamodred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/btamodred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -70,7 +70,7 @@ ## @item nr ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -104,28 +104,28 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "nr" +## @item 'order', 'nr' ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is chosen automatically. ## -## @item "left", "output" +## @item 'left', 'output' ## LTI model of the left/output frequency weighting. ## Default value is an identity matrix. ## -## @item "right", "input" +## @item 'right', 'input' ## LTI model of the right/input frequency weighting. ## Default value is an identity matrix. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr", "b" +## @item 'sr', 'b' ## Use the square-root Balance & Truncate method. -## @item "bfsr", "f" +## @item 'bfsr', 'f' ## Use the balancing-free square-root Balance & Truncate method. Default method. ## @end table ## -## @item "alpha" +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{G.A}. For a continuous-time ## system, ALPHA <= 0 is the boundary value for @@ -136,20 +136,20 @@ ## Default value is 0 for continuous-time systems and ## 1 for discrete-time systems. ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced model. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsv(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the ALPHA-stable part of the given ## model. TOL2 <= TOL1. ## If not specified, ns*eps*info.hsv(1) is chosen. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on system @var{G} prior to order reduction. ## Default value is true if @code{G.scaled == false} and Modified: trunk/octave-forge/extra/control-devel/inst/cfconred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/cfconred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/cfconred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -35,7 +35,7 @@ ## @item ncr ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -61,47 +61,47 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "ncr" +## @item 'order', 'ncr' ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr-bta", "b" +## @item 'sr-bta', 'b' ## Use the square-root Balance & Truncate method. -## @item "bfsr-bta", "f" +## @item 'bfsr-bta', 'f' ## Use the balancing-free square-root Balance & Truncate method. Default method. -## @item "sr-spa", "s" +## @item 'sr-spa', 's' ## Use the square-root Singular Perturbation Approximation method. -## @item "bfsr-spa", "p" +## @item 'bfsr-spa', 'p' ## Use the balancing-free square-root Singular Perturbation Approximation method. ## @end table ## -## @item "cf" +## @item 'cf' ## Specifies whether left or right coprime factorization is ## to be used as follows: ## @table @var -## @item "left", "l" +## @item 'left', 'l' ## Use left coprime factorization. Default method. -## @item "right", "r" +## @item 'right', 'r' ## Use right coprime factorization. ## @end table ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced system. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsv(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the coprime factorization controller. ## TOL2 <= TOL1. ## If not specified, n*eps*info.hsv(1) is chosen. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on system @var{G} prior to order reduction. ## Default value is true if @code{G.scaled == false} and Modified: trunk/octave-forge/extra/control-devel/inst/fwcfconred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/fwcfconred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/fwcfconred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -35,7 +35,7 @@ ## @item ncr ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -61,35 +61,35 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "ncr" +## @item 'order', 'ncr' ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr", "b" +## @item 'sr', 'b' ## Use the square-root Balance & Truncate method. -## @item "bfsr", "f" +## @item 'bfsr', 'f' ## Use the balancing-free square-root Balance & Truncate method. Default method. ## @end table ## -## @item "cf" +## @item 'cf' ## Specifies whether left or right coprime factorization is ## to be used as follows: ## @table @var -## @item "left", "l" +## @item 'left', 'l' ## Use left coprime factorization. Default method. -## @item "right", "r" +## @item 'right', 'r' ## Use right coprime factorization. ## @end table ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced system. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsv(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## @end table ## ## @strong{Algorithm}@* Modified: trunk/octave-forge/extra/control-devel/inst/hnamodred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/hnamodred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/hnamodred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -106,26 +106,34 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "nr" +## @item 'order', 'nr' ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is the sum of NU and the number of ## Hankel singular values greater than @code{MAX(TOL1,NS*EPS*HNORM(As,Bs,Cs))}; ## -## @item "method" +## @item 'method' ## Specifies the computational approach to be used. ## Valid values corresponding to this key are: ## @table @var -## @item "descriptor" +## @item 'descriptor' ## Use the inverse free descriptor system approach. -## @item "standard" +## @item 'standard' ## Use the inversion based standard approach. -## @item "auto" +## @item 'auto' ## Switch automatically to the inverse free ## descriptor approach in case of badly conditioned ## feedthrough matrices in V or W. Default method. ## @end table ## -## @item "alpha" +## @item 'left', 'output' +## LTI model of the left/output frequency weighting. +## Default value is an identity matrix. +## +## @item 'right', 'input' +## LTI model of the right/input frequency weighting. +## Default value is an identity matrix. +## +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{G.A}. For a continuous-time ## system, ALPHA <= 0 is the boundary value for @@ -136,7 +144,7 @@ ## Default value is 0 for continuous-time systems and ## 1 for discrete-time systems. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on system @var{G} prior to order reduction. ## Default value is true if @code{G.scaled == false} and Modified: trunk/octave-forge/extra/control-devel/inst/spaconred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/spaconred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/spaconred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -34,7 +34,7 @@ ## @item ncr ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -62,37 +62,37 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "ncr" +## @item 'order', 'ncr' ## The desired order of the resulting reduced order controller @var{Kr}. ## If not specified, @var{ncr} is chosen automatically. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr", "s" +## @item 'sr', 's' ## Use the square-root Singular Perturbation Approximation method. -## @item "bfsr", "p" +## @item 'bfsr', 'p' ## Use the balancing-free square-root Singular Perturbation Approximation method. Default method. ## @end table ## -## @item "weight" +## @item 'weight' ## Specifies the type of frequency-weighting as follows: ## @table @var -## @item "none" +## @item 'none' ## No weightings are used (V = I, W = I). Default value. -## @item "left", "output" +## @item 'left', 'output' ## Use stability enforcing left (output) weighting ## @example ## -1 ## V = (I-G*K) *G , (W = I) ## @end example -## @item "right", "input" +## @item 'right', 'input' ## Use stability enforcing right (input) weighting ## @example ## -1 ## W = (I-G*K) *G , (V = I) ## @end example -## @item "both", "performance" +## @item 'both', 'performance' ## Use stability and performance enforcing weightings ## @example ## -1 -1 @@ -100,7 +100,7 @@ ## @end example ## @end table ## -## @item "alpha" +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{K.A}. For a continuous-time ## controller, ALPHA <= 0 is the boundary value for @@ -111,20 +111,20 @@ ## Default value is 0 for continuous-time controllers and ## 1 for discrete-time controllers. ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced controller. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsvc(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the ALPHA-stable part of the given ## controller. TOL2 <= TOL1. ## If not specified, ncs*eps*info.hsvc(1) is chosen. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on @var{G} and @var{K} prior to order reduction. ## Default value is false if both @code{G.scaled == true, K.scaled == true} Modified: trunk/octave-forge/extra/control-devel/inst/spamodred.m =================================================================== --- trunk/octave-forge/extra/control-devel/inst/spamodred.m 2011-12-16 07:21:08 UTC (rev 9407) +++ trunk/octave-forge/extra/control-devel/inst/spamodred.m 2011-12-16 10:00:12 UTC (rev 9408) @@ -30,7 +30,7 @@ ## @item nr ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is chosen automatically according -## to the description of key @var{"order"}. +## to the description of key @var{'order'}. ## @item @dots{} ## Optional pairs of keys and values. @code{"key1", value1, "key2", value2}. ## @item opt @@ -64,28 +64,28 @@ ## ## @strong{Option Keys and Values} ## @table @var -## @item "order", "nr" +## @item 'order', 'nr' ## The desired order of the resulting reduced order system @var{Gr}. ## If not specified, @var{nr} is chosen automatically. ## -## @item "left", "output" +## @item 'left', 'output' ## LTI model of the left/output frequency weighting. ## Default value is an identity matrix. ## -## @item "right", "input" +## @item 'right', 'input' ## LTI model of the right/input frequency weighting. ## Default value is an identity matrix. ## -## @item "method" +## @item 'method' ## Order reduction approach to be used as follows: ## @table @var -## @item "sr", "s" +## @item 'sr', 's' ## Use the square-root Singular Perturbation Approximation method. -## @item "bfsr", "p" +## @item 'bfsr', 'p' ## Use the balancing-free square-root Singular Perturbation Approximation method. Default method. ## @end table ## -## @item "alpha" +## @item 'alpha' ## Specifies the ALPHA-stability boundary for the eigenvalues ## of the state dynamics matrix @var{G.A}. For a continuous-time ## system, ALPHA <= 0 is the boundary value for @@ -96,20 +96,20 @@ ## Default value is 0 for continuous-time systems and ## 1 for discrete-time systems. ## -## @item "tol1" -## If @var{"order"} is not specified, @var{tol1} contains the tolerance for +## @item 'tol1' +## If @var{'order'} is not specified, @var{tol1} contains the tolerance for ## determining the order of the reduced model. ## For model reduction, the recommended value of @var{tol1} is ## c*info.hsv(1), where c lies in the interval [0.00001, 0.001]. -## If @var{"order"} is specified, the value of @var{tol1} is ignored. +## If @var{'order'} is specified, the value of @var{tol1} is ignored. ## -## @item "tol2" +## @item 'tol2' ## The tolerance for determining the order of a minimal ## realization of the ALPHA-stable part of the given ## model. TOL2 <= TOL1. ## If not specified, ns*eps*info.hsv(1) is chosen. ## -## @item "equil", "scale" +## @item 'equil', 'scale' ## Boolean indicating whether equilibration (scaling) should be ## performed on system @var{G} prior to order reduction. ## Default value is true if @code{G.scaled == false} and This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |