view scripts/legacy/flipdim.m @ 25759:ecdced9fe445

flipdim.m: Make m-file a legacy function. * NEWS: Add flipdim to list of legacy functions. * scripts/general/module.mk, scripts/legacy/module.mk: Move flipdim.m from general/ directory to legacy/ directory. * func.tst: Change instances of flipdim to flip * flipdim.m: Add Octave:legacy-function warning. Remove all BIST tests. Update docstring.
author Rik <rik@octave.org>
date Thu, 09 Aug 2018 11:28:11 -0700
parents scripts/general/flipdim.m@6652d3823428
children 00f796120a6d
line wrap: on
line source

## Copyright (C) 2004-2018 David Bateman
## Copyright (C) 2009 VZLU Prague
##
## 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/>.

## -*- texinfo -*-
## @deftypefn  {} {} flipdim (@var{x})
## @deftypefnx {} {} flipdim (@var{x}, @var{dim})
## This function is obsolete.  Use @code{flip} instead.
## @seealso{flip, fliplr, flipud, rot90, rotdim}
## @end deftypefn

function y = flipdim (varargin)

  persistent warned = false;
  if (! warned)
    warned = true;
    warning ("Octave:legacy-function",
             "flipdim is obsolete; please use flip instead");
  endif

  y = flip (varargin{:});
endfunction