Mercurial > octave
diff libinterp/corefcn/filter.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | aba2e6293dd8 |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/filter.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/filter.cc Tue Jun 21 16:07:51 2016 -0400 @@ -228,107 +228,107 @@ } DEFUN (filter, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{y} =} filter (@var{b}, @var{a}, @var{x})\n\ -@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si})\n\ -@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, [], @var{dim})\n\ -@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si}, @var{dim})\n\ -Apply a 1-D digital filter to the data @var{x}.\n\ -\n\ -@code{filter} returns the solution to the following linear, time-invariant\n\ -difference equation:\n\ -@tex\n\ -$$\n\ -\\sum_{k=0}^N a_{k+1} y_{n-k} = \\sum_{k=0}^M b_{k+1} x_{n-k}, \\qquad\n\ - 1 \\le n \\le P\n\ -$$\n\ -@end tex\n\ -@ifnottex\n\ -@c Set example in small font to prevent overfull line\n\ -\n\ -@smallexample\n\ -@group\n\ - N M\n\ -SUM a(k+1) y(n-k) = SUM b(k+1) x(n-k) for 1<=n<=length(x)\n\ -k=0 k=0\n\ -@end group\n\ -@end smallexample\n\ -\n\ -@end ifnottex\n\ -\n\ -@noindent\n\ -where\n\ -@ifnottex\n\ -N=length(a)-1 and M=length(b)-1.\n\ -@end ifnottex\n\ -@tex\n\ -$a \\in \\Re^{N-1}$, $b \\in \\Re^{M-1}$, and $x \\in \\Re^P$.\n\ -@end tex\n\ -The result is calculated over the first non-singleton dimension of @var{x}\n\ -or over @var{dim} if supplied.\n\ -\n\ -An equivalent form of the equation is:\n\ -@tex\n\ -$$\n\ -y_n = -\\sum_{k=1}^N c_{k+1} y_{n-k} + \\sum_{k=0}^M d_{k+1} x_{n-k}, \\qquad\n\ - 1 \\le n \\le P\n\ -$$\n\ -@end tex\n\ -@ifnottex\n\ -@c Set example in small font to prevent overfull line\n\ -\n\ -@smallexample\n\ -@group\n\ - N M\n\ -y(n) = - SUM c(k+1) y(n-k) + SUM d(k+1) x(n-k) for 1<=n<=length(x)\n\ - k=1 k=0\n\ -@end group\n\ -@end smallexample\n\ -\n\ -@end ifnottex\n\ -\n\ -@noindent\n\ -where\n\ -@ifnottex\n\ - c = a/a(1) and d = b/a(1).\n\ -@end ifnottex\n\ -@tex\n\ -$c = a/a_1$ and $d = b/a_1$.\n\ -@end tex\n\ -\n\ -If the fourth argument @var{si} is provided, it is taken as the\n\ -initial state of the system and the final state is returned as\n\ -@var{sf}. The state vector is a column vector whose length is\n\ -equal to the length of the longest coefficient vector minus one.\n\ -If @var{si} is not supplied, the initial state vector is set to all\n\ -zeros.\n\ -\n\ -In terms of the Z Transform, @var{y} is the result of passing the\n\ -discrete-time signal @var{x} through a system characterized by the following\n\ -rational system function:\n\ -@tex\n\ -$$\n\ -H(z) = {\\displaystyle\\sum_{k=0}^M d_{k+1} z^{-k}\n\ - \\over 1 + \\displaystyle\\sum_{k+1}^N c_{k+1} z^{-k}}\n\ -$$\n\ -@end tex\n\ -@ifnottex\n\ -\n\ -@example\n\ -@group\n\ - M\n\ - SUM d(k+1) z^(-k)\n\ - k=0\n\ -H(z) = ---------------------\n\ - N\n\ - 1 + SUM c(k+1) z^(-k)\n\ - k=1\n\ -@end group\n\ -@end example\n\ -\n\ -@end ifnottex\n\ -@seealso{filter2, fftfilt, freqz}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{y} =} filter (@var{b}, @var{a}, @var{x}) +@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si}) +@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, [], @var{dim}) +@deftypefnx {} {[@var{y}, @var{sf}] =} filter (@var{b}, @var{a}, @var{x}, @var{si}, @var{dim}) +Apply a 1-D digital filter to the data @var{x}. + +@code{filter} returns the solution to the following linear, time-invariant +difference equation: +@tex +$$ +\sum_{k=0}^N a_{k+1} y_{n-k} = \sum_{k=0}^M b_{k+1} x_{n-k}, \qquad + 1 \le n \le P +$$ +@end tex +@ifnottex +@c Set example in small font to prevent overfull line + +@smallexample +@group + N M +SUM a(k+1) y(n-k) = SUM b(k+1) x(n-k) for 1<=n<=length(x) +k=0 k=0 +@end group +@end smallexample + +@end ifnottex + +@noindent +where +@ifnottex +N=length(a)-1 and M=length(b)-1. +@end ifnottex +@tex +$a \in \Re^{N-1}$, $b \in \Re^{M-1}$, and $x \in \Re^P$. +@end tex +The result is calculated over the first non-singleton dimension of @var{x} +or over @var{dim} if supplied. + +An equivalent form of the equation is: +@tex +$$ +y_n = -\sum_{k=1}^N c_{k+1} y_{n-k} + \sum_{k=0}^M d_{k+1} x_{n-k}, \qquad + 1 \le n \le P +$$ +@end tex +@ifnottex +@c Set example in small font to prevent overfull line + +@smallexample +@group + N M +y(n) = - SUM c(k+1) y(n-k) + SUM d(k+1) x(n-k) for 1<=n<=length(x) + k=1 k=0 +@end group +@end smallexample + +@end ifnottex + +@noindent +where +@ifnottex + c = a/a(1) and d = b/a(1). +@end ifnottex +@tex +$c = a/a_1$ and $d = b/a_1$. +@end tex + +If the fourth argument @var{si} is provided, it is taken as the +initial state of the system and the final state is returned as +@var{sf}. The state vector is a column vector whose length is +equal to the length of the longest coefficient vector minus one. +If @var{si} is not supplied, the initial state vector is set to all +zeros. + +In terms of the Z Transform, @var{y} is the result of passing the +discrete-time signal @var{x} through a system characterized by the following +rational system function: +@tex +$$ +H(z) = {\displaystyle\sum_{k=0}^M d_{k+1} z^{-k} + \over 1 + \displaystyle\sum_{k+1}^N c_{k+1} z^{-k}} +$$ +@end tex +@ifnottex + +@example +@group + M + SUM d(k+1) z^(-k) + k=0 +H(z) = --------------------- + N + 1 + SUM c(k+1) z^(-k) + k=1 +@end group +@end example + +@end ifnottex +@seealso{filter2, fftfilt, freqz} +@end deftypefn */) { int nargin = args.length ();