basis/math/quaternions/quaternions-docs.factor

   1 USING: help.markup help.syntax math ;
   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 ;" "{ 0 1 0 0 } { 0 0 1 0 } q+ ." "{ 0 1 1 0 }" } } ;
   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 ;" "{ 0 1 0 0 } { 0 0 1 0 } q- ." "{ 0 1 -1 0 }" } } ;
  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 ;" "{ 0 1 0 0 } { 0 0 1 0 } q* ." "{ 0 0 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 0 0 1 } { 0 0 1 0 } q/ ." "{ 0 1 0 0 }" } } ;
  31
  32 HELP: q*n
  33 { $values { "q" "a quaternion" } { "n" real } { "r" "a quaternion" } }
  34 { $description "Multiplies each element of " { $snippet "q" } " by real value " { $snippet "n" } "." }
  35 { $notes "To multiply a quaternion with a complex value, use " { $link c>q } " " { $link q* } "." } ;
  36
  37 HELP: c>q
  38 { $values { "c" number } { "q" "a quaternion" } }
  39 { $description "Turn a complex number into a quaternion." }
  40 { $examples { $example "USING: math.quaternions prettyprint ;" "C{ 0 1 } c>q ." "{ 0 1 0 0 }" } } ;
  41
  42 HELP: euler
  43 { $values { "phi" number } { "theta" number } { "psi" number } { "q" "a quaternion" } }
  44 { $description "Convert a rotation given by Euler angles (phi, theta, and psi) to a quaternion." } ;