Mercurial > octave
view scripts/statistics/movmin.m @ 26244:58b3107a00bc
Update documentation for movXXX functions (bug #48774).
* NEWS: Announce new movXXX functions.
* octave.texi: Add new submenu "Statistics on Sliding Windows of Data".
* stats.txi: Add @DOCSTRING entries for movfun, movmin, movslice.
* scripts/signal/__parse_movargs__.m: Function moved from
signal/private/parse_moveargs.m. Use standard Octave copyright block.
* movfun.m, movslice.m: Use standard Octave copyright block. Rewrite
documentation using more Texinfo features.
* scripts/signal/module.mk: Remove movmin.m, add __parse_movargs__.m to.
build system.
* scripts/statistics/movmin.m: Function moved from scripts/signal/ dir.
Use standard Octave copyright block. Rewrite documentation using more Texinfo
features.
* scripts/statistics/module.mk: Add movmin.m to build system.
author | Juan Pablo Carbajal <ajuanpi+dev@gmail.com> |
---|---|
date | Sun, 16 Dec 2018 00:13:55 -0800 |
parents | |
children | 86217421a37f |
line wrap: on
line source
## Copyright (C) 2018 Juan Pablo Carbajal ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## Author: Juan Pablo Carbajal <ajuanpi+dev@gmail.com> ## Created: 2018-08-13 ## -*- texinfo -*- ## @deftypefn {} {@var{y} =} movmin (@var{x}, @var{wlen}) ## @deftypefnx {} {@var{y} =} movmin (@var{x}, [@var{na}, @var{nb}]) ## @deftypefnx {} {@var{y} =} movmin (@dots{}, @var{dim}) ## @deftypefnx {} {@var{y} =} movmin (@dots{}, @var{nanstr}) ## @deftypefnx {} {@var{y} =} movmin (@dots{}, @var{property}, @var{value}) ## Minimum of @var{x} over a sliding window of length @var{wlen}. ## ## FIXME: Need explanation of all options. Write once and then replicate. ## ## @seealso{movfun} ## @end deftypefn function y = movmin (x, wlen, varargin) y = movfun (@min, x, wlen, __parse_movargs__ (varargin{:}){:}); endfunction ## FIXME: Need BIST tests