octave_packages/m/linear-algebra/subspace.m

   1 ## Copyright (C) 2008-2012 VZLU Prague, a.s., Czech Republic
   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} {@var{angle} =} subspace (@var{A}, @var{B})
  21 ## Determine the largest principal angle between two subspaces
  22 ## spanned by the columns of matrices @var{A} and @var{B}.
  23 ## @end deftypefn
  24
  25 ## Author: Jaroslav Hajek <highegg@gmail.com>
  26
  27 ## reference:
  28 ## [1]  Andrew V. Knyazev, Merico E. Argentati:
  29 ##   Principal Angles between Subspaces in an A-Based Scalar Product:
  30 ##  Algorithms and Perturbation Estimates.
  31 ##  SIAM Journal on Scientific Computing, Vol. 23 no. 6, pp. 2008-2040
  32 ##
  33 ## other texts are also around...
  34
  35 function ang = subspace (A, B)
  36
  37   if (nargin != 2)
  38     print_usage ();
  39   elseif (ndims (A) != 2 || ndims (B) != 2)
  40     error ("subspace: expecting A and B to be 2-dimensional arrays");
  41   elseif (rows (A) != rows (B))
  42     error ("subspace: column dimensions of A and B must match");
  43   endif
  44
  45   A = orth (A);
  46   B = orth (B);
  47   c = A'*B;
  48   scos = min (svd (c));
  49   if (scos^2 > 1/2)
  50     if (columns (A) >= columns (B))
  51       c = B - A*c;
  52     else
  53       c = A - B*c';
  54     endif
  55     ssin = max (svd (c));
  56     ang = asin (min (ssin, 1));
  57   else
  58     ang = acos (scos);
  59   endif
  60
  61 endfunction