extra/adsoda/tools/tools-docs.factor

   1 ! Copyright (C) 2008 Jeff Bigot.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: arrays help.markup help.syntax kernel sequences ;
   4 IN: adsoda.tools
   5
   6 HELP: 3cube
   7 { $values
   8     { "array" "array" } { "name" "name" }
   9     { "solid" "solid" }
  10 }
  11 { $description "array : xmin xmax ymin ymax zmin zmax"
  12 "\n returns a 3D solid with given limits"
  13 } ;
  14
  15 HELP: 4cube
  16 { $values
  17     { "array" "array" } { "name" "name" }
  18     { "solid" "solid" }
  19 }
  20 { $description "array : xmin xmax ymin ymax zmin zmax wmin wmax"
  21 "\n returns a 4D solid with given limits"
  22 } ;
  23
  24
  25 HELP: coord-max
  26 { $values
  27      { "x" null } { "array" array }
  28      { "array" array }
  29 }
  30 { $description "" } ;
  31
  32 HELP: coord-min
  33 { $values
  34      { "x" null } { "array" array }
  35      { "array" array }
  36 }
  37 { $description "" } ;
  38
  39 HELP: equation-system-for-normal
  40 { $values
  41      { "points" "a list of n points" }
  42      { "matrix" "matrix" }
  43 }
  44 { $description "From a list of points, return the matrix"
  45 "to solve in order to find the vector normal to the plan defined by the points" }
  46 ;
  47
  48 HELP: normal-vector
  49 { $values
  50      { "points" "a list of n points" }
  51      { "v" "a vector" }
  52 }
  53 { $description "From a list of points, returns the vector normal to the plan defined by the points"
  54 "\nWith n points, creates n-1 vectors and then find a vector orthogonal to every others"
  55 "\n returns { f } if a normal vector can not be found" }
  56 ;
  57
  58 HELP: points-to-hyperplane
  59 { $values
  60      { "points" "a list of n points" }
  61      { "hyperplane" "an hyperplane equation" }
  62 }
  63 { $description "From a list of points, returns the equation of the hyperplan"
  64 "\n Finds a normal vector and then translate it so that it includes one of the points"
  65
  66 }
  67 ;
  68
  69 ARTICLE: "adsoda.tools" "adsoda.tools"
  70 { $vocab-link "adsoda.tools" }
  71 "\nTools to help in building an " { $vocab-link "adsoda" } "-space"
  72 ;
  73
  74 ABOUT: "adsoda.tools"
  75
  76