view scripts/strings/strcmpi.m @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents 502e58a0d44f
children 58604c45ca74
line wrap: on
line source

## Copyright (C) 2000, 2005, 2006, 2007, 2009 Bill Lash
##
## 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} {} strcmpi (@var{s1}, @var{s2})
## Ignoring case, return 1 if the character strings (or character
## arrays) @var{s1} and @var{s2} are the same, and 0 otherwise.
##
## If either @var{s1} or @var{s2} is a cell array of strings, then an array
## of the same size is returned, containing the values described above for
## every member of the cell array. The other argument may also be a cell
## array of strings (of the same size or with only one element), char matrix
## or character string.
##
## @strong{Caution:} For compatibility with @sc{Matlab}, Octave's strcmpi
## function returns 1 if the character strings are equal, and 0 otherwise.
## This is just the opposite of the corresponding C library function.
## @seealso{strcmp, strncmp, strncmpi}
## @end deftypefn

## Author: Bill Lash <lash@tellabs.com>
## Adapted-by: jwe

function retval = strcmpi (s1, s2)

  if (nargin == 2)
    if ((ischar(s1) || iscellstr(s1)) && (ischar(s2) || iscellstr(s2)))
      ## Note that we don't use tolower here because we need to be able
      ## to handle cell arrays of strings.
      retval = strcmp (lower (s1), lower (s2));
    else
      retval = false;
    endif
  else
    print_usage ();
  endif

endfunction

%!assert (strcmpi("abc123", "ABC123"), logical(1));