basis/math/quaternions/quaternions-docs.factor

   1 USING: help.markup help.syntax math math.vectors vectors ;
   2 IN: math.quaternions
   3
   4 HELP: q+
   5 { $values { "u" "a quaternion" } { "v" "a quaternion" } { "u+v" "a quaternion" } }
   6 { $description "Add quaternions." }
   7 { $examples { $example "USING: math.quaternions prettyprint ;" "{ C{ 0 1 } 0 } { 0 1 } q+ ." "{ C{ 0 1 } 1 }" } } ;
   8
   9 HELP: q-
  10 { $values { "u" "a quaternion" } { "v" "a quaternion" } { "u-v" "a quaternion" } }
  11 { $description "Subtract quaternions." }
  12 { $examples { $example "USING: math.quaternions prettyprint ;" "{ C{ 0 1 } 0 } { 0 1 } q- ." "{ C{ 0 1 } -1 }" } } ;
  13
  14 HELP: q*
  15 { $values { "u" "a quaternion" } { "v" "a quaternion" } { "u*v" "a quaternion" } }
  16 { $description "Multiply quaternions." }
  17 { $examples { $example "USING: math.quaternions prettyprint ;" "{ C{ 0 1 } 0 } { 0 1 } q* ." "{ 0 C{ 0 1 } }" } } ;
  18
  19 HELP: qconjugate
  20 { $values { "u" "a quaternion" } { "u'" "a quaternion" } }
  21 { $description "Quaternion conjugate." } ;
  22
  23 HELP: qrecip
  24 { $values { "u" "a quaternion" } { "1/u" "a quaternion" } }
  25 { $description "Quaternion inverse." } ;
  26
  27 HELP: q/
  28 { $values { "u" "a quaternion" } { "v" "a quaternion" } { "u/v" "a quaternion" } }
  29 { $description "Divide quaternions." }
  30 { $examples { $example "USING: math.quaternions prettyprint ;" "{ 0 C{ 0 1 } } { 0 1 } q/ ." "{ C{ 0 1 } 0 }" } } ;
  31
  32 HELP: q*n
  33 { $values { "q" "a quaternion" } { "n" number } { "q" "a quaternion" } }
  34 { $description "Multiplies each element of " { $snippet "q" } " by " { $snippet "n" } "." }
  35 { $notes "You will get the wrong result if you try to multiply a quaternion by a complex number on the right using " { $link v*n } ". Use this word instead."
  36     $nl "Note that " { $link v*n } " with a quaternion and a real is okay." } ;
  37
  38 HELP: c>q
  39 { $values { "c" number } { "q" "a quaternion" } }
  40 { $description "Turn a complex number into a quaternion." }
  41 { $examples { $example "USING: math.quaternions prettyprint ;" "C{ 0 1 } c>q ." "{ C{ 0 1 } 0 }" } } ;
  42
  43 HELP: v>q
  44 { $values { "v" vector } { "q" "a quaternion" } }
  45 { $description "Turn a 3-vector into a quaternion with real part 0." }
  46 { $examples { $example "USING: math.quaternions prettyprint ;" "{ 1 0 0 } v>q ." "{ C{ 0 1 } 0 }" } } ;
  47
  48 HELP: q>v
  49 { $values { "q" "a quaternion" } { "v" vector } }
  50 { $description "Get the vector part of a quaternion, discarding the real part." }
  51 { $examples { $example "USING: math.quaternions prettyprint ;" "{ C{ 0 1 } 0 } q>v ." "{ 1 0 0 }" } } ;
  52
  53 HELP: euler
  54 { $values { "phi" number } { "theta" number } { "psi" number } { "q" "a quaternion" } }
  55 { $description "Convert a rotation given by Euler angles (phi, theta, and psi) to a quaternion." } ;
  56