Mercurial > forge

changeset 11556:b4e9aff80a68 octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
signal: documented optional gain argument and its default value * sos2tf.m, sos2zp.m, zp2sos.m: Documented optional gain argument and the default value if not given.
author mtmiller
date Sun, 17 Mar 2013 20:57:34 +0000
parents 287d045b28c8
children c2c46401c207
files main/signal/NEWS main/signal/inst/sos2tf.m main/signal/inst/sos2zp.m main/signal/inst/zp2sos.m
diffstat 4 files changed, 14 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/main/signal/NEWS	Sun Mar 17 19:32:31 2013 +0000
+++ b/main/signal/NEWS	Sun Mar 17 20:57:34 2013 +0000
@@ -27,6 +27,12 @@
     window for a length argument of 1, and making all arguments after the
     length optional.
 
+ ** Documented the optional gain argument for the following functions:
+
+      sos2tf
+      sos2zp
+      zp2sos
+
  ** signal is no longer dependent on the optim package.
 
 ===============================================================================
--- a/main/signal/inst/sos2tf.m	Sun Mar 17 19:32:31 2013 +0000
+++ b/main/signal/inst/sos2tf.m	Sun Mar 17 20:57:34 2013 +0000
@@ -14,7 +14,8 @@
 %% this program; if not, see <http://www.gnu.org/licenses/>.
 
 %% -*- texinfo -*-
-%% @deftypefn {Function File} {[@var{B}, @var{A}] =} sos2tf (@var{sos}, @var{Bscale})
+%% @deftypefn {Function File} {[@var{B}, @var{A}] =} sos2tf (@var{sos})
+%% @deftypefnx {Function File} {[@var{B}, @var{A}] =} sos2tf (@var{sos}, @var{Bscale})
 %% Convert series second-order sections to direct form @math{H(z) = B(z)/A(z)}.
 %%
 %% INPUTS:
@@ -32,6 +33,7 @@
 %% @item
 %% @var{Bscale} is an overall gain factor that effectively scales
 %% the output @var{B} vector (or any one of the input @var{B}i vectors).
+%% If not given the gain is assumed to be 1.
 %% @end itemize
 %%
 %% RETURNED:
--- a/main/signal/inst/sos2zp.m	Sun Mar 17 19:32:31 2013 +0000
+++ b/main/signal/inst/sos2zp.m	Sun Mar 17 20:57:34 2013 +0000
@@ -14,7 +14,8 @@
 %% this program; if not, see <http://www.gnu.org/licenses/>.
 
 %% -*- texinfo -*-
-%% @deftypefn {Function File} {[@var{z}, @var{p}, @var{g}] =} sos2zp (@var{sos}, @var{Bscale})
+%% @deftypefn {Function File} {[@var{z}, @var{p}, @var{g}] =} sos2zp (@var{sos})
+%% @deftypefnx {Function File} {[@var{z}, @var{p}, @var{g}] =} sos2zp (@var{sos}, @var{Bscale})
 %% Convert series second-order sections to zeros, poles, and gains
 %% (pole residues).
 %%
@@ -33,6 +34,7 @@
 %% @item
 %% @var{Bscale} is an overall gain factor that effectively scales
 %% any one of the input @var{B}i vectors.
+%% If not given the gain is assumed to be 1.
 %% @end itemize
 %%
 %% RETURNED:
--- a/main/signal/inst/zp2sos.m	Sun Mar 17 19:32:31 2013 +0000
+++ b/main/signal/inst/zp2sos.m	Sun Mar 17 20:57:34 2013 +0000
@@ -15,6 +15,7 @@
 
 %% -*- texinfo -*-
 %% @deftypefn {Function File} {[@var{sos}, @var{g}] =} zp2sos (@var{z}, @var{p})
+%% @deftypefnx {Function File} {[@var{sos}, @var{g}] =} zp2sos (@var{z}, @var{p}, @var{g})
 %% Convert filter poles and zeros to second-order sections.
 %%
 %% INPUTS:@*
@@ -25,6 +26,7 @@
 %%   @var{p} = column-vector containing the filter poles@*
 %% @item
 %%   @var{g} = overall filter gain factor
+%%   If not given the gain is assumed to be 1.
 %% @end itemize
 %%
 %% RETURNED: