Mercurial > octave-nkf
annotate scripts/polynomial/conv.m @ 19627:446c46af4b42 stable
strip trailing whitespace from most source files
* Makefile.am, NEWS, build-aux/common.mk, configure.ac,
doc/Makefile.am, doc/doxyhtml/Makefile.am,
doc/interpreter/Makefile.am, doc/interpreter/arith.txi,
doc/interpreter/audio.txi, doc/interpreter/basics.txi,
doc/interpreter/bugs.txi, doc/interpreter/container.txi,
doc/interpreter/cp-idx.txi, doc/interpreter/data.txi,
doc/interpreter/debug.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README,
doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi,
doc/interpreter/errors.txi, doc/interpreter/eval.txi,
doc/interpreter/expr.txi, doc/interpreter/external.txi,
doc/interpreter/fn-idx.txi, doc/interpreter/func.txi,
doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m,
doc/interpreter/gpl.txi, doc/interpreter/grammar.txi,
doc/interpreter/gui.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/interpimages.m, doc/interpreter/intro.txi,
doc/interpreter/io.txi, doc/interpreter/java.txi,
doc/interpreter/linalg.txi, doc/interpreter/macros.texi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi,
doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1,
doc/interpreter/octave.texi, doc/interpreter/oop.txi,
doc/interpreter/op-idx.txi, doc/interpreter/optim.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/poly.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/set.txi,
doc/interpreter/signal.txi, doc/interpreter/sparse.txi,
doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m,
doc/interpreter/stats.txi, doc/interpreter/stmt.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/testfun.txi, doc/interpreter/tips.txi,
doc/interpreter/var.txi, doc/interpreter/vectorize.txi,
doc/liboctave/Makefile.am, doc/liboctave/array.texi,
doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi,
doc/liboctave/dae.texi, doc/liboctave/diffeq.texi,
doc/liboctave/error.texi, doc/liboctave/factor.texi,
doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi,
doc/liboctave/install.texi, doc/liboctave/intro.texi,
doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi,
doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi,
doc/liboctave/ode.texi, doc/liboctave/optim.texi,
doc/liboctave/preface.texi, doc/liboctave/quad.texi,
doc/liboctave/range.texi, doc/refcard/Makefile.am,
doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2,
etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog,
etc/OLD-ChangeLogs/doc-ChangeLog,
etc/OLD-ChangeLogs/scripts-ChangeLog,
etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog,
etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW,
etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am,
examples/@polynomial/end.m, examples/@polynomial/subsasgn.m,
examples/Makefile.am, examples/standalonebuiltin.cc,
libgui/Makefile.am, libgui/qterminal/libqterminal/README,
libgui/qterminal/libqterminal/unix/BlockArray.cpp,
libgui/qterminal/libqterminal/unix/BlockArray.h,
libgui/qterminal/libqterminal/unix/Character.h,
libgui/qterminal/libqterminal/unix/CharacterColor.h,
libgui/qterminal/libqterminal/unix/Emulation.cpp,
libgui/qterminal/libqterminal/unix/Emulation.h,
libgui/qterminal/libqterminal/unix/Filter.cpp,
libgui/qterminal/libqterminal/unix/Filter.h,
libgui/qterminal/libqterminal/unix/History.cpp,
libgui/qterminal/libqterminal/unix/History.h,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.h,
libgui/qterminal/libqterminal/unix/LineFont.h,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h,
libgui/qterminal/libqterminal/unix/Screen.cpp,
libgui/qterminal/libqterminal/unix/Screen.h,
libgui/qterminal/libqterminal/unix/ScreenWindow.cpp,
libgui/qterminal/libqterminal/unix/ScreenWindow.h,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h,
libgui/qterminal/libqterminal/unix/Vt102Emulation.h,
libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp,
libgui/qterminal/qterminal/main.cpp,
libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc,
libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc,
libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc,
libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy,
libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc,
libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc,
libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl,
libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add,
libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs,
libinterp/mkops, libinterp/octave-value/ov-java.cc,
libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/octave.gperf, liboctave/Makefile.am,
liboctave/array/Array.cc, liboctave/array/module.mk,
liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f,
liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f,
liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f,
liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f,
liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f,
liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f,
liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f,
liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f,
liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f,
liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f,
liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f,
liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f,
liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f,
liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f,
liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f,
liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f,
liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk,
liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f,
liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f,
liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f,
liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f,
liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f,
liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc,
liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f,
liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f,
liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f,
liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f,
liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc,
liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for,
liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f,
liboctave/cruft/slatec-fn/datanh.f,
liboctave/cruft/slatec-fn/xgmainc.f,
liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk,
liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops,
liboctave/operators/sparse-mk-ops.awk,
liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops,
liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m,
scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m,
scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m,
scripts/deprecated/java_new.m,
scripts/deprecated/java_unsigned_conversion.m,
scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m,
scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m,
scripts/general/display.m, scripts/general/fieldnames.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/isa.m,
scripts/general/methods.m, scripts/general/sortrows.m,
scripts/geometry/convhull.m, scripts/geometry/delaunay.m,
scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m,
scripts/geometry/griddata.m, scripts/geometry/griddatan.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/gui/guihandles.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m,
scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m,
scripts/image/bone.m, scripts/image/cmpermute.m,
scripts/image/cmunique.m, scripts/image/colorcube.m,
scripts/image/colormap.m, scripts/image/contrast.m,
scripts/image/gray2ind.m, scripts/image/image.m,
scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m,
scripts/image/rgb2ntsc.m, scripts/image/spinmap.m,
scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m,
scripts/io/textscan.m, scripts/java/java_get.m,
scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m,
scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m,
scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m,
scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m,
scripts/mk-pkg-add, scripts/mkdoc.pl,
scripts/optimization/fminsearch.m, scripts/optimization/optimset.m,
scripts/optimization/sqp.m, scripts/pkg/pkg.m,
scripts/pkg/private/create_pkgadddel.m,
scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m,
scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m,
scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m,
scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m,
scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m,
scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m,
scripts/plot/draw/area.m, scripts/plot/draw/bar.m,
scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m,
scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m,
scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m,
scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m,
scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m,
scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m,
scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m,
scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m,
scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m,
scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m,
scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m,
scripts/plot/draw/private/__contour__.m,
scripts/plot/draw/private/__errplot__.m,
scripts/plot/draw/private/__ezplot__.m,
scripts/plot/draw/private/__patch__.m,
scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m,
scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m,
scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m,
scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m,
scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m,
scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m,
scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m,
scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m,
scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m,
scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m,
scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m,
scripts/plot/util/__gnuplot_drawnow__.m,
scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m,
scripts/plot/util/clf.m, scripts/plot/util/copyobj.m,
scripts/plot/util/figure.m, scripts/plot/util/gcbo.m,
scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m,
scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m,
scripts/plot/util/print.m,
scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/private/__fltk_print__.m,
scripts/plot/util/private/__gnuplot_print__.m,
scripts/plot/util/private/__print_parse_opts__.m,
scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m,
scripts/polynomial/conv.m, scripts/polynomial/poly.m,
scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m,
scripts/polynomial/polyval.m,
scripts/polynomial/private/__splinefit__.m,
scripts/polynomial/spline.m, scripts/prefs/prefdir.m,
scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m,
scripts/prefs/rmpref.m, scripts/signal/freqz.m,
scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m,
scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m,
scripts/specfun/expint.m, scripts/specfun/factor.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m,
scripts/special-matrix/toeplitz.m, scripts/startup/inputrc,
scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m,
scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m,
scripts/statistics/distributions/betarnd.m,
scripts/statistics/distributions/binoinv.m,
scripts/statistics/distributions/binopdf.m,
scripts/statistics/distributions/binornd.m,
scripts/statistics/distributions/cauchy_rnd.m,
scripts/statistics/distributions/chi2rnd.m,
scripts/statistics/distributions/discrete_pdf.m,
scripts/statistics/distributions/discrete_rnd.m,
scripts/statistics/distributions/empirical_rnd.m,
scripts/statistics/distributions/exprnd.m,
scripts/statistics/distributions/frnd.m,
scripts/statistics/distributions/gamrnd.m,
scripts/statistics/distributions/geornd.m,
scripts/statistics/distributions/hygernd.m,
scripts/statistics/distributions/kolmogorov_smirnov_cdf.m,
scripts/statistics/distributions/laplace_cdf.m,
scripts/statistics/distributions/laplace_pdf.m,
scripts/statistics/distributions/logistic_cdf.m,
scripts/statistics/distributions/logistic_pdf.m,
scripts/statistics/distributions/lognrnd.m,
scripts/statistics/distributions/nbincdf.m,
scripts/statistics/distributions/nbininv.m,
scripts/statistics/distributions/nbinpdf.m,
scripts/statistics/distributions/nbinrnd.m,
scripts/statistics/distributions/normrnd.m,
scripts/statistics/distributions/poissinv.m,
scripts/statistics/distributions/poissrnd.m,
scripts/statistics/distributions/tinv.m,
scripts/statistics/distributions/trnd.m,
scripts/statistics/distributions/unidcdf.m,
scripts/statistics/distributions/unidpdf.m,
scripts/statistics/distributions/unidrnd.m,
scripts/statistics/distributions/unifrnd.m,
scripts/statistics/distributions/wblrnd.m,
scripts/statistics/models/module.mk,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/strings/base2dec.m, scripts/strings/deblank.m,
scripts/strings/dec2base.m, scripts/strings/dec2bin.m,
scripts/strings/dec2hex.m, scripts/strings/mat2str.m,
scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m,
scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjoin.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m,
scripts/testfun/test.m, scripts/time/asctime.m,
scripts/time/datenum.m, scripts/time/datevec.m,
scripts/time/weekday.m, src/Makefile.am, test/Makefile.am,
test/build-bc-overload-tests.sh, test/build-sparse-tests.sh,
test/jit.tst, test/line-continue.tst: Strip trailing whitespace.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 20 Jan 2015 08:26:57 -0500 |
parents | d63878346099 |
children | 4197fc428c7d |
rev | line source |
---|---|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17281
diff
changeset
|
1 ## Copyright (C) 1994-2013 John W. Eaton |
2313 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
1025 | 18 |
3368 | 19 ## -*- texinfo -*- |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
20 ## @deftypefn {Function File} {} conv (@var{a}, @var{b}) |
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
21 ## @deftypefnx {Function File} {} conv (@var{a}, @var{b}, @var{shape}) |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
22 ## Convolve two vectors @var{a} and @var{b}. |
3426 | 23 ## |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
24 ## The output convolution is a vector with length equal to |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
25 ## @code{length (@var{a}) + length (@var{b}) - 1}. |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
26 ## When @var{a} and @var{b} are the coefficient vectors of two polynomials, the |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
27 ## convolution represents the coefficient vector of the product polynomial. |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
28 ## |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
29 ## The optional @var{shape} argument may be |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
30 ## |
11084 | 31 ## @table @asis |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
32 ## @item @var{shape} = @qcode{"full"} |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
33 ## Return the full convolution. (default) |
11084 | 34 ## |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
35 ## @item @var{shape} = @qcode{"same"} |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
36 ## Return the central part of the convolution with the same size as @var{a}. |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
37 ## @end table |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
38 ## |
14104
614505385171
doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents:
13295
diff
changeset
|
39 ## @seealso{deconv, conv2, convn, fftconv} |
3368 | 40 ## @end deftypefn |
2311 | 41 |
3202 | 42 ## Author: Tony Richardson <arichard@stark.cc.oh.us> |
2312 | 43 ## Created: June 1994 |
44 ## Adapted-By: jwe | |
45 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
46 function y = conv (a, b, shape = "full") |
2325 | 47 |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
48 if (nargin < 2 || nargin > 3) |
6046 | 49 print_usage (); |
787 | 50 endif |
51 | |
4030 | 52 if (! (isvector (a) && isvector (b))) |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
53 error ("conv: both arguments A and B must be vectors"); |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
54 elseif (nargin == 3 && ! any (strcmpi (shape, {"full", "same", "valid"}))) |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
55 error ('conv: SHAPE argument must be "full", "same", or "valid"'); |
787 | 56 endif |
57 | |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 la = la_orig = length (a); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
59 lb = lb_orig = length (b); |
787 | 60 |
61 ly = la + lb - 1; | |
62 | |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
63 if (ly == 0) |
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
64 y = zeros (1, 0); |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
65 return; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
66 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
67 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
68 ## Use shortest vector as the coefficent vector to filter. |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
69 if (la > lb) |
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
70 [a, b] = deal (b, a); # Swap vectors |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
71 lb = la; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
72 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
73 x = b; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
74 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
75 ## Pad longer vector to convolution length. |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
76 if (ly > lb) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
77 x(end+1:end+ly-lb) = 0; |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
78 endif |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
79 |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
80 y = filter (a, 1, x); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
81 |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
82 if (strcmpi (shape, "same")) |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
83 idx = ceil ((ly - la) / 2); |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
84 y = y(idx+1:idx+la); |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
85 elseif (strcmpi (shape, "valid")) |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
86 len = la_orig - lb_orig; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
87 y = y(lb_orig:lb_orig+len); |
787 | 88 endif |
89 | |
90 endfunction | |
7411 | 91 |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
92 |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
93 %!test |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
94 %! x = ones (3,1); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
95 %! y = ones (1,3); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
96 %! b = 2; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
97 %! c = 3; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
98 %! assert (conv (x, x), [1; 2; 3; 2; 1]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
99 %! assert (conv (y, y), [1, 2, 3, 2, 1]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
100 %! assert (conv (x, y), [1, 2, 3, 2, 1]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
101 %! assert (conv (y, x), [1; 2; 3; 2; 1]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
102 %! assert (conv (c, x), [3; 3; 3]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
103 %! assert (conv (c, y), [3, 3, 3]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
104 %! assert (conv (x, c), [3; 3; 3]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
105 %! assert (conv (y, c), [3, 3, 3]); |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
106 %! assert (conv (b, c), 6); |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
107 |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
108 %!shared a,b |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
109 %!test |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
110 %! a = 1:10; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
111 %! b = 1:3; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
112 %!assert (size (conv (a,b)), [1, numel(a)+numel(b)-1]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
113 %!assert (size (conv (b,a)), [1, numel(a)+numel(b)-1]) |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
114 |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
115 %!test |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
116 %! a = (1:10).'; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
117 %!assert (size (conv (a,b)), [numel(a)+numel(b)-1, 1]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
118 %!assert (size (conv (b,a)), [numel(a)+numel(b)-1, 1]) |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
119 |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
120 %!test |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
121 %! a = 1:10; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
122 %! b = (1:3).'; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
123 %!assert (size (conv (a,b)), [1, numel(a)+numel(b)-1]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
124 %!assert (size (conv (b,a)), [1, numel(a)+numel(b)-1]) |
9433
38a0f9dc0ab4
conv.m: fix Matlab incompatibility; new tests
Robert T. Short <octave@phaselockedsystems.com>
parents:
8920
diff
changeset
|
125 |
8158
15e4a450bf84
conv.m: Correct row/col orientation of output
Ben Abbott <bpabbott@mac.com>
parents:
7411
diff
changeset
|
126 %!test |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
127 %! a = 1:10; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
128 %! b = 1:3; |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
129 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
130 %!assert (conv (a,b,"full"), conv (a,b)) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
131 %!assert (conv (b,a,"full"), conv (b,a)) |
11124 | 132 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
133 %!assert (conv (a,b,"same"), [4, 10, 16, 22, 28, 34, 40, 46, 52, 47]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
134 %!assert (conv (b,a,"same"), [28, 34, 40]) |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
135 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
136 %!assert (conv (a,b,"valid"), [10, 16, 22, 28, 34, 40, 46, 52]) |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14352
diff
changeset
|
137 %!assert (conv (b,a,"valid"), zeros (1,0)) |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
138 |
11082
4558aad4c41d
conv.m: handle "same" shape argument
John W. Eaton <jwe@octave.org>
parents:
10224
diff
changeset
|
139 |
11085
2beacd515e09
Update docstrings for convolution family of functions (conv, conv2, fftconv)
Rik <octave@nomad.inbox5.com>
parents:
11084
diff
changeset
|
140 %% Test input validation |
13295
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
141 %!error conv (1) |
96c7143304d9
conv.m: Simplify algorithm and add more input validation and tests
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
142 %!error conv (1,2,3,4) |
14347
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
143 %!error <A and B must be vectors> conv ([1, 2; 3, 4], 3) |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
144 %!error <A and B must be vectors> conv (3, [1, 2; 3, 4]) |
12c70d00c04e
conv.m: Add "valid" as possible SHAPE parameter (Bug #34893)
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
145 %!error <SHAPE argument must be> conv (2, 3, "INVALID_SHAPE") |
11124 | 146 |