steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

break math.vectors docs into subsections

db4
Joe Groff 2009-09-30 13:21:25 -05:00
parent a2771aa166
commit e0f3b72c65
1 changed files with 40 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
basis/math/vectors/vectors-docs.factor
View File

@ -1,10 +1,21 @@
USING: help.markup help.syntax math math.functions sequences ;
IN: math.vectors
ARTICLE: "math-vectors" "Vector arithmetic"
"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."
$nl
"Acting on vectors by a scalar:"
ARTICLE: "math-vectors-arithmetic" "Vector arithmetic"
"Vector/vector binary operations:"
{ $subsection v+ }
{ $subsection v- }
{ $subsection v+- }
{ $subsection v* }
{ $subsection v/ }
"Vector unary operations:"
{ $subsection vneg }
{ $subsection vabs }
{ $subsection vsqrt }
{ $subsection vfloor }
{ $subsection vceiling }
{ $subsection vtruncate }
"Vector/scalar and scalar/vector binary operations:"
{ $subsection vneg }
{ $subsection v*n }
{ $subsection n*v }
@ -14,24 +25,21 @@ $nl
{ $subsection n+v }
{ $subsection v-n }
{ $subsection n-v }
"Vector unary operations:"
{ $subsection vneg }
{ $subsection vabs }
{ $subsection vsqrt }
{ $subsection vfloor }
{ $subsection vceiling }
{ $subsection vtruncate }
"Vector/vector binary operations:"
{ $subsection v+ }
{ $subsection v- }
{ $subsection v+- }
{ $subsection v* }
{ $subsection v/ }
"Saturated arithmetic (only on " { $link "specialized-arrays" } "):"
{ $subsection vs+ }
{ $subsection vs- }
{ $subsection vs* }
"Componentwise vector operations:"
"Inner product and norm:"
{ $subsection v. }
{ $subsection norm }
{ $subsection norm-sq }
{ $subsection normalize }
"Comparing entire vectors:"
{ $subsection distance }
{ $subsection v~ } ;
ARTICLE: "math-vectors-logic" "Vector componentwise logic"
"Element comparisons:"
{ $subsection v< }
{ $subsection v<= }
{ $subsection v= }
@ -40,6 +48,8 @@ $nl
{ $subsection vunordered? }
{ $subsection vmax }
{ $subsection vmin }
{ $subsection vsupremum }
{ $subsection vinfimum }
"Bitwise operations:"
{ $subsection vbitand }
{ $subsection vbitandn }
@ -47,31 +57,29 @@ $nl
{ $subsection vbitxor }
{ $subsection vlshift }
{ $subsection vrshift }
"Componentwise logical operations:"
"Element logical operations:"
{ $subsection vand }
{ $subsection vor }
{ $subsection vxor }
{ $subsection vmask }
{ $subsection v? }
"Shuffling:"
{ $subsection vshuffle }
"Inner product and norm:"
{ $subsection v. }
{ $subsection norm }
{ $subsection norm-sq }
{ $subsection normalize }
"Comparing entire vectors:"
{ $subsection distance }
{ $subsection v~ }
"Other functions:"
{ $subsection vsupremum }
{ $subsection vinfimum }
"Element shuffling:"
{ $subsection vshuffle } ;
ARTICLE: "math-vectors-misc" "Miscellaneous vector functions"
{ $subsection trilerp }
{ $subsection bilerp }
{ $subsection vlerp }
{ $subsection vnlerp }
{ $subsection vbilerp } ;
ARTICLE: "math-vectors" "Vector operations"
"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."
{ $subsection "math-vectors-arithmetic" }
{ $subsection "math-vectors-logic" }
{ $subsection "math-vectors-misc" } ;
ABOUT: "math-vectors"
HELP: vneg