Mercurial > hg > octave-nkf
changeset 14842:aa4c25ca498e
doc: Improve docstring for filter.
* filter.cc (filter): Clarify dimension that filter will act on. Stop
double-space in middle of Texinfo sentence.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Thu, 05 Jul 2012 20:03:01 -0700 |
parents | afa5e1d20671 |
children | 7d4f87c75dbb |
files | src/DLD-FUNCTIONS/filter.cc |
diffstat | 1 files changed, 6 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/filter.cc +++ b/src/DLD-FUNCTIONS/filter.cc @@ -315,13 +315,15 @@ @noindent\n\ where\n\ @ifnottex\n\ - N=length(a)-1 and M=length(b)-1.\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\ +$a \\in \\Re^{N-1}$, $b \\in \\Re^{M-1}$, and $x \\in \\Re^P$.\n\ @end tex\n\ -over the first non-singleton dimension of @var{x} or over @var{dim} if\n\ -supplied. An equivalent form of this equation is:\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\