octave_packages/m/deprecated/is_duplicate_entry.m

   1 ## Copyright (C) 1996-2012 A. S. Hodel
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} is_duplicate_entry (@var{x})
  21 ## Return non-zero if any entries in @var{x} are duplicates of one
  22 ## another.
  23 ## @seealso{unique}
  24 ## @end deftypefn
  25
  26 ## Author: A. S. Hodel <scotte@eng.auburn.edu>
  27
  28 function retval = is_duplicate_entry (x)
  29
  30   persistent warned = false;
  31   if (! warned)
  32     warned = true;
  33     warning ("Octave:deprecated-function",
  34              "is_duplicate_entry is obsolete and will be removed from a future version of Octave; see the function unique for equivalent functionality");
  35   endif
  36
  37
  38   if (nargin == 1)
  39     if (ismatrix (x))
  40       lx = numel (x);
  41       lx1 = lx-1;
  42       x = sort (reshape (x, 1, lx));
  43       dx = x(1:lx1) - x(2:lx);
  44       retval = sum (dx == 0);
  45     else
  46       error ("is_duplicate_entry: expecting matrix argument");
  47     endif
  48   else
  49     print_usage ();
  50   endif
  51
  52 endfunction
  53