octave_packages/quaternion-2.0.0/qi.m

   1 ## Copyright (C) 2010   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 ## @deftypefn {Function File} {} qi
  17 ## Create x-component of a quaternion's vector part.
  18 ##
  19 ## @example
  20 ## q = w + x*qi + y*qj + z*qk
  21 ## @end example
  22 ##
  23 ## @strong{Example}
  24 ## @example
  25 ## @group
  26 ## octave:1> q1 = quaternion (1, 2, 3, 4)
  27 ## q1 = 1 + 2i + 3j + 4k
  28 ## octave:2> q2 = 1 + 2*qi + 3*qj + 4*qk
  29 ## q2 = 1 + 2i + 3j + 4k
  30 ## octave:3>
  31 ## @end group
  32 ## @end example
  33 ##
  34 ## @end deftypefn
  35
  36 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  37 ## Created: May 2010
  38 ## Version: 0.1
  39
  40 function q = qi
  41
  42   if (nargin != 0)
  43     print_usage ();
  44   endif
  45
  46   q = quaternion (0, 1, 0, 0);
  47
  48 endfunction