octave_packages/m/deprecated/cor.m

   1 ## Copyright (C) 1995-2012 Kurt Hornik
   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} {} cor (@var{x})
  21 ## @deftypefnx {Function File} {} cor (@var{x}, @var{y})
  22 ## Compute matrix of correlation coefficients.
  23 ##
  24 ## This is an alias for @code{corrcoef}.
  25 ## @seealso{corrcoef}
  26 ## @end deftypefn
  27
  28 function retval = cor (x, y = x)
  29
  30   persistent warned = false;
  31   if (! warned)
  32     warned = true;
  33     warning ("Octave:deprecated-function",
  34              "cor is obsolete and will be removed from a future version of Octave; please use corr instead");
  35   endif
  36
  37   if (nargin < 1 || nargin > 2)
  38     print_usage ();
  39   endif
  40
  41   retval = corrcoef (x, y);
  42
  43 endfunction
  44
  45
  46 %!test
  47 %! x = rand (10, 2);
  48 %! assert (cor (x), corrcoef (x), 5*eps);
  49 %! assert (cor (x(:,1), x(:,2)) == corrcoef (x(:,1), x(:,2)));
  50
  51 %% Test input validation
  52 %!error corrcoef ();
  53 %!error corrcoef (1, 2, 3);
  54