changeset 19155:9220669832df

Undeprecate flipdim (prematurely deprecated in 995df67fc912). * general/flipdim.m, deprecated/flipdim.m: restore flipdim() from deprecated, and turn it into alias for flip(). * NEWS: remove flipdim from list of deprecated functions. * deprecated/module.mk: remove flipdim.m * general/module.mk: add flipdim.m * help/__unimplemented__.m: remove flip.
author Carnë Draug <carandraug@octave.org>
date Wed, 24 Sep 2014 00:06:59 +0100
parents 76baa2d10abb
children 38b9849cd907
files NEWS scripts/deprecated/flipdim.m scripts/deprecated/module.mk scripts/general/flipdim.m scripts/general/module.mk scripts/help/__unimplemented__.m
diffstat 6 files changed, 37 insertions(+), 64 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Mon Sep 22 21:41:04 2014 -0700
+++ b/NEWS	Wed Sep 24 00:06:59 2014 +0100
@@ -103,7 +103,6 @@
       bicubic            | interp2
       find_dir_in_path   | dir_in_loadpath
       finite             | isfinite
-      flipdim            | flip
       fmod               | rem
       fnmatch            | glob or regexp
       luinc              | ilu or ichol
--- a/scripts/deprecated/flipdim.m	Mon Sep 22 21:41:04 2014 -0700
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,61 +0,0 @@
-## Copyright (C) 2004-2013 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
-## <http://www.gnu.org/licenses/>.
-
-## -*- texinfo -*-
-## @deftypefn  {Function File} {} flipdim (@var{x})
-## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim})
-## Return a copy of @var{x} flipped about the dimension @var{dim}.
-## @var{dim} defaults to the first non-singleton dimension.
-##
-## @strong{Warning:} @code{flipdim} is scheduled for removal in version 4.6.
-## Use @code{flip} which can be used as a drop-in replacement.
-##
-## @seealso{fliplr, flipud, rot90, rotdim}
-## @end deftypefn
-
-## Author: David Bateman, Jaroslav Hajek
-
-function y = flipdim (x, dim)
-
-  persistent warned = false;
-  if (! warned)
-    warned = true;
-    warning ("Octave:deprecated-function",
-             "flipdim is deprecated and will be removed from a future version of Octave; please use flip (x, dim) instead");
-  endif
-
-  if (nargin != 1 && nargin != 2)
-    print_usage ();
-  endif
-
-  nd = ndims (x);
-  sz = size (x);
-  if (nargin == 1)
-    ## Find the first non-singleton dimension.
-    (dim = find (sz > 1, 1)) || (dim = 1);
-  elseif (! (isscalar (dim) && isindex (dim)))
-    error ("flipdim: DIM must be a positive integer");
-  endif
-
-  idx(1:max(nd, dim)) = {':'};
-  idx{dim} = size (x, dim):-1:1;
-  y = x(idx{:});
-
-endfunction
-
--- a/scripts/deprecated/module.mk	Mon Sep 22 21:41:04 2014 -0700
+++ b/scripts/deprecated/module.mk	Wed Sep 24 00:06:59 2014 +0100
@@ -4,7 +4,6 @@
   deprecated/bicubic.m \
   deprecated/find_dir_in_path.m \
   deprecated/finite.m \
-  deprecated/flipdim.m \
   deprecated/fmod.m \
   deprecated/fnmatch.m \
   deprecated/isstr.m \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/general/flipdim.m	Wed Sep 24 00:06:59 2014 +0100
@@ -0,0 +1,36 @@
+## Copyright (C) 2004-2013 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
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {} flipdim (@var{x})
+## @deftypefnx {Function File} {} flipdim (@var{x}, @var{dim})
+## Flip array across specific dimension.
+##
+## This function is an alias for @code{flip} and exists for backwards
+## and @sc{Matlab} compatibility.  See further details about its usage
+## on @code{flip} help text.
+##
+## @seealso{flip, fliplr, flipud, rot90, rotdim}
+## @end deftypefn
+
+## Author: David Bateman, Jaroslav Hajek
+
+function y = flipdim (varargin)
+  y = flip (varargin{:});
+endfunction
--- a/scripts/general/module.mk	Mon Sep 22 21:41:04 2014 -0700
+++ b/scripts/general/module.mk	Wed Sep 24 00:06:59 2014 +0100
@@ -29,6 +29,7 @@
   general/divergence.m \
   general/fieldnames.m \
   general/flip.m \
+  general/flipdim.m \
   general/fliplr.m \
   general/flipud.m \
   general/gradient.m \
--- a/scripts/help/__unimplemented__.m	Mon Sep 22 21:41:04 2014 -0700
+++ b/scripts/help/__unimplemented__.m	Wed Sep 24 00:06:59 2014 +0100
@@ -636,7 +636,6 @@
   "fitsinfo",
   "fitsread",
   "fitswrite",
-  "flip",
   "flow",
   "frame2im",
   "freqspace",