octave_packages/quaternion-2.0.0/@quaternion/norm.m

   1 ## Copyright (C) 2011   Lukas F. Reichlin
   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 3 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 WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR 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{n} =} norm (@var{q})
  18 ## Norm of a quaternion.
  19 ## @end deftypefn
  20
  21 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  22 ## Created: November 2011
  23 ## Version: 0.1
  24
  25 function n = norm (a)
  26
  27   if (nargin != 1)
  28     print_usage ();
  29   endif
  30
  31   if (! isscalar (a.w))
  32     warning ("norm: use 'abs' to calculate the lengths of quaternion arrays");
  33     error ("norm: only the 2-norm of scalar quaternions is implemented until now");
  34   endif
  35
  36   n = abs (a);
  37
  38 endfunction