octave_packages/quaternion-2.0.0/@quaternion/unit.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{qn} =} unit (@var{q})
  18 ## Normalize quaternion to length 1 (unit quaternion).
  19 ##
  20 ## @example
  21 ## q = w + x*i + y*j + z*k
  22 ## unit (q) = q ./ sqrt (w.^2 + x.^2 + y.^2 + z.^2)
  23 ## @end example
  24 ## @end deftypefn
  25
  26 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  27 ## Created: November 2011
  28 ## Version: 0.1
  29
  30 function q = unit (a)
  31
  32   if (nargin != 1)
  33     print_usage ();
  34   endif
  35
  36   q = a ./ abs (a);
  37
  38 endfunction