basis/math/vectors/vectors-docs.factor

   1 USING: help.markup help.syntax math math.functions sequences ;
   2 IN: math.vectors
   3
   4 ARTICLE: "math-vectors" "Vector arithmetic"
   5 "Any Factor sequence can be used to represent a mathematical vector, however for best performance, the sequences defined by the " { $vocab-link "specialized-arrays" } " and " { $vocab-link "math.vectors.simd" } " vocabularies should be used."
   6 $nl
   7 "Acting on vectors by a scalar:"
   8 { $subsection vneg }
   9 { $subsection v*n }
  10 { $subsection n*v }
  11 { $subsection v/n }
  12 { $subsection n/v }
  13 { $subsection v+n }
  14 { $subsection n+v }
  15 { $subsection v-n }
  16 { $subsection n-v }
  17 "Vector unary operations:"
  18 { $subsection vneg }
  19 { $subsection vabs }
  20 { $subsection vsqrt }
  21 { $subsection vfloor }
  22 { $subsection vceiling }
  23 { $subsection vtruncate }
  24 "Vector/vector binary operations:"
  25 { $subsection v+ }
  26 { $subsection v- }
  27 { $subsection v+- }
  28 { $subsection v* }
  29 { $subsection v/ }
  30 "Saturated arithmetic (only on " { $link "specialized-arrays" } "):"
  31 { $subsection vs+ }
  32 { $subsection vs- }
  33 { $subsection vs* }
  34 "Comparisons:"
  35 { $subsection vmax }
  36 { $subsection vmin }
  37 "Bitwise operations:"
  38 { $subsection vbitand }
  39 { $subsection vbitandn }
  40 { $subsection vbitor }
  41 { $subsection vbitxor }
  42 { $subsection vlshift }
  43 { $subsection vrshift }
  44 "Inner product and norm:"
  45 { $subsection v. }
  46 { $subsection norm }
  47 { $subsection norm-sq }
  48 { $subsection normalize }
  49 "Comparing vectors:"
  50 { $subsection distance }
  51 { $subsection v~ }
  52 "Other functions:"
  53 { $subsection vsupremum }
  54 { $subsection vinfimum }
  55 { $subsection trilerp }
  56 { $subsection bilerp }
  57 { $subsection vlerp }
  58 { $subsection vnlerp }
  59 { $subsection vbilerp } ;
  60
  61 ABOUT: "math-vectors"
  62
  63 HELP: vneg
  64 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } }
  65 { $description "Negates each element of " { $snippet "u" } "." } ;
  66
  67 HELP: vabs
  68 { $values { "u" "a sequence of numbers" } { "v" "a sequence of non-negative real numbers" } }
  69 { $description "Takes the absolute value of each element of " { $snippet "u" } "." } ;
  70
  71 HELP: vsqrt
  72 { $values { "u" "a sequence of non-negative real numbers" } { "v" "a sequence of non-negative real numbers" } }
  73 { $description "Takes the square root of each element of " { $snippet "u" } "." }
  74 { $warning "For performance reasons, this does not work with negative inputs, unlike " { $link sqrt } "." } ;
  75
  76 HELP: vfloor
  77 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } }
  78 { $description "Takes the " { $link floor } " of each element of " { $snippet "u" } "." } ;
  79
  80 HELP: vceiling
  81 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } }
  82 { $description "Takes the " { $link ceiling } " of each element of " { $snippet "u" } "." } ;
  83
  84 HELP: vtruncate
  85 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } }
  86 { $description "Truncates each element of " { $snippet "u" } "." } ;
  87
  88 HELP: n+v
  89 { $values { "n" "a number" } { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } }
  90 { $description "Adds " { $snippet "n" } " to each element of " { $snippet "u" } "." } ;
  91
  92 HELP: v+n
  93 { $values { "u" "a sequence of numbers" } { "n" "a number" } { "v" "a sequence of numbers" } }
  94 { $description "Adds " { $snippet "n" } " to each element of " { $snippet "u" } "." } ;
  95
  96 HELP: n-v
  97 { $values { "n" "a number" } { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } }
  98 { $description "Subtracts each element of " { $snippet "u" } " from " { $snippet "n" } "." } ;
  99
 100 HELP: v-n
 101 { $values { "u" "a sequence of numbers" } { "n" "a number" } { "v" "a sequence of numbers" } }
 102 { $description "Subtracts " { $snippet "n" } " from each element of " { $snippet "u" } "." } ;
 103
 104 HELP: n*v
 105 { $values { "n" "a number" } { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } }
 106 { $description "Multiplies each element of " { $snippet "u" } " by " { $snippet "n" } "." } ;
 107
 108 HELP: v*n
 109 { $values { "u" "a sequence of numbers" } { "n" "a number" } { "v" "a sequence of numbers" } }
 110 { $description "Multiplies each element of " { $snippet "u" } " by " { $snippet "n" } "." } ;
 111
 112 HELP: n/v
 113 { $values { "n" "a number" } { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } }
 114 { $description "Divides " { $snippet "n" } " by each element of " { $snippet "u" } "." }
 115 { $errors "May throw an error if a division by zero occurs; see " { $link "division-by-zero" } "." } ;
 116
 117 HELP: v/n
 118 { $values { "u" "a sequence of numbers" } { "n" "a number" } { "v" "a sequence of numbers" } }
 119 { $description "Divides each element of " { $snippet "u" } " by " { $snippet "n" } "." }
 120 { $errors "May throw an error if a division by zero occurs; see " { $link "division-by-zero" } "." } ;
 121
 122 HELP: v+
 123 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 124 { $description "Adds " { $snippet "u" } " and " { $snippet "v" } " component-wise." } ;
 125
 126 HELP: v-
 127 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 128 { $description "Subtracts " { $snippet "v" } " from " { $snippet "u" } " component-wise." } ;
 129
 130 HELP: v+-
 131 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 132 { $description "Adds and subtracts alternate elements of " { $snippet "v" } " and " { $snippet "u" } " component-wise." }
 133 { $examples
 134     { $example
 135         "USING: math.vectors prettyprint ;"
 136         "{ 1 2 3 } { 2 3 2 } v+- ."
 137         "{ -1 5 1 }"
 138     }
 139 } ;
 140
 141 HELP: [v-]
 142 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 143 { $description "Subtracts " { $snippet "v" } " from " { $snippet "u" } " component-wise; any components which become negative are set to zero." } ;
 144
 145 HELP: v*
 146 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 147 { $description "Multiplies " { $snippet "u" } " and " { $snippet "v" } " component-wise." } ;
 148
 149 HELP: v/
 150 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 151 { $description "Divides " { $snippet "u" } " by " { $snippet "v" } " component-wise." }
 152 { $errors "May throw an error if a division by zero occurs; see " { $link "division-by-zero" } "." } ;
 153
 154 HELP: vmax
 155 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 156 { $description "Creates a sequence where each element is the maximum of the corresponding elements from " { $snippet "u" } " andd " { $snippet "v" } "." }
 157 { $examples { $example "USING: math.vectors prettyprint ;" "{ 1 2 5 } { -7 6 3 } vmax ." "{ 1 6 5 }" } } ;
 158
 159 HELP: vmin
 160 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 161 { $description "Creates a sequence where each element is the minimum of the corresponding elements from " { $snippet "u" } " andd " { $snippet "v" } "." }
 162 { $examples { $example "USING: math.vectors prettyprint ;" "{ 1 2 5 } { -7 6 3 } vmin ." "{ -7 2 3 }" } } ;
 163
 164 HELP: v.
 165 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "x" "a real number" } }
 166 { $description "Computes the dot product of two vectors." } ;
 167
 168 HELP: vs+
 169 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 170 { $description "Adds " { $snippet "u" } " and " { $snippet "v" } " component-wise with saturation." }
 171 { $examples
 172     "With saturation:"
 173     { $example
 174         "USING: math.vectors prettyprint specialized-arrays ;"
 175         "SPECIALIZED-ARRAY: uchar"
 176         "uchar-array{ 100 200 150 } uchar-array{ 70 70 70 } vs+ ."
 177         "uchar-array{ 170 255 220 }"
 178     }
 179     "Without saturation:"
 180     { $example
 181         "USING: math.vectors prettyprint specialized-arrays ;"
 182         "SPECIALIZED-ARRAY: uchar"
 183         "uchar-array{ 100 200 150 } uchar-array{ 70 70 70 } v+ ."
 184         "uchar-array{ 170 14 220 }"
 185     }
 186 } ;
 187
 188 HELP: vs-
 189 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 190 { $description "Subtracts " { $snippet "v" } " from " { $snippet "u" } " component-wise with saturation." } ;
 191
 192 HELP: vs*
 193 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "w" "a sequence of numbers" } }
 194 { $description "Multiplies " { $snippet "u" } " and " { $snippet "v" } " component-wise with saturation." } ;
 195
 196 HELP: vbitand
 197 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 198 { $description "Takes the bitwise and of " { $snippet "u" } " and " { $snippet "v" } " component-wise." }
 199 { $notes "Unlike " { $link bitand } ", this word may be used on a specialized array of floats or doubles, in which case the bitwise representation of the floating point numbers is operated upon." } ;
 200
 201 HELP: vbitandn
 202 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 203 { $description "Takes the bitwise and-not of " { $snippet "u" } " and " { $snippet "v" } " component-wise, where " { $snippet "x and-not y" } " is defined as " { $snippet "not(x) and y" } "." }
 204 { $notes "This word may be used on a specialized array of floats or doubles, in which case the bitwise representation of the floating point numbers is operated upon." } ;
 205
 206 HELP: vbitor
 207 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 208 { $description "Takes the bitwise or of " { $snippet "u" } " and " { $snippet "v" } " component-wise." }
 209 { $notes "Unlike " { $link bitor } ", this word may be used on a specialized array of floats or doubles, in which case the bitwise representation of the floating point numbers is operated upon." } ;
 210
 211 HELP: vbitxor
 212 { $values { "u" "a sequence of real numbers" } { "v" "a sequence of real numbers" } { "w" "a sequence of real numbers" } }
 213 { $description "Takes the bitwise exclusive or of " { $snippet "u" } " and " { $snippet "v" } " component-wise." }
 214 { $notes "Unlike " { $link bitxor } ", this word may be used on a specialized array of floats or doubles, in which case the bitwise representation of the floating point numbers is operated upon." } ;
 215
 216 HELP: vlshift
 217 { $values { "u" "a sequence of integers" } { "n" "a non-negative integer" } { "w" "a sequence of integers" } }
 218 { $description "Shifts each element of " { $snippet "u" } " to the left by " { $snippet "n" } " bits." }
 219 { $notes "Undefined behavior will result if " { $snippet "n" } " is negative." } ;
 220
 221 HELP: vrshift
 222 { $values { "u" "a sequence of integers" } { "n" "a non-negative integer" } { "w" "a sequence of integers" } }
 223 { $description "Shifts each element of " { $snippet "u" } " to the right by " { $snippet "n" } " bits." }
 224 { $notes "Undefined behavior will result if " { $snippet "n" } " is negative." } ;
 225
 226 HELP: hlshift
 227 { $values { "u" "a SIMD array" } { "n" "a non-negative integer" } { "w" "a SIMD array" } }
 228 { $description "Shifts the entire SIMD array to the left by " { $snippet "n" } " bytes. This word may only be used in a context where the compiler can statically infer that the input is a SIMD array." } ;
 229
 230 HELP: hrshift
 231 { $values { "u" "a SIMD array" } { "n" "a non-negative integer" } { "w" "a SIMD array" } }
 232 { $description "Shifts the entire SIMD array to the right by " { $snippet "n" } " bytes. This word may only be used in a context where the compiler can statically infer that the input is a SIMD array." } ;
 233
 234 HELP: norm-sq
 235 { $values { "v" "a sequence of numbers" } { "x" "a non-negative real number" } }
 236 { $description "Computes the squared length of a mathematical vector." } ;
 237
 238 HELP: norm
 239 { $values { "v" "a sequence of numbers" } { "x" "a non-negative real number" } }
 240 { $description "Computes the length of a mathematical vector." } ;
 241
 242 HELP: normalize
 243 { $values { "u" "a sequence of numbers, not all zero" } { "v" "a sequence of numbers" } }
 244 { $description "Outputs a vector with the same direction as " { $snippet "u" } " but length 1." } ;
 245
 246 HELP: distance
 247 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "x" "a non-negative real number" } }
 248 { $description "Outputs the Euclidean distance between two vectors." } ;
 249
 250 HELP: set-axis
 251 { $values { "u" "a sequence of numbers" } { "v" "a sequence of numbers" } { "axis" "a sequence of 0/1" } { "w" "a sequence of numbers" } }
 252 { $description "Using " { $snippet "w" } " as a template, creates a new sequence containing corresponding elements from " { $snippet "u" } " in place of 0, and corresponding elements from " { $snippet "v" } " in place of 1." }
 253 { $examples { $example "USING: math.vectors prettyprint ;" "{ 1 2 3 } { 4 5 6 } { 0 1 0 } set-axis ." "{ 1 5 3 }" } } ;
 254
 255 { 2map v+ v- v* v/ } related-words
 256
 257 { 2reduce v. } related-words
 258
 259 { vs+ vs- vs* } related-words