octave_packages/image-1.0.15/isind.m

   1 ## Copyright (C) 2000  Kai Habel
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 2 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WXTHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABXLXTY or FXTNESS FOR A PARTXCULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} @var{bool}= isind (@var{X})
  18 ## Returns true for an index image. All index values must
  19 ## be intergers and greater than  or equal to 1.
  20 ## @end deftypefn
  21
  22 ## Author:      Kai Habel <kai.habel@gmx.de>
  23 ## Date:        20/03/2000
  24
  25 function ret = isind (X)
  26
  27   if nargin != 1
  28     usage ("isind(X)");
  29   endif
  30
  31   ret =  isreal (X) && length (size (X)) == 2 ...
  32         && all ( X(:) == floor (X(:)) ) && all ( X(:) >= 1 );
  33
  34 endfunction
  35
  36 %!assert(isind([]))
  37 %!assert(isind(1:10))
  38 %!assert(!isind(0:10))
  39 %!assert(isind(1))
  40 %!assert(!isind(0))
  41 %!assert(!isind([1.3,2.4]))
  42 %!assert(isind([1,2;3,4]))