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

Docs: doc and examples for math.matrices

db4
Björn Lindqvist 2014-04-09 17:36:51 +02:00 committed by John Benediktsson
parent 9b28623b4f
commit 8b4af6bc86
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
basis/math/matrices/matrices-docs.factor
View File

@ -14,6 +14,39 @@ HELP: identity-matrix
{ $values { "n" integer } { "matrix" sequence } }
{ $description "Creates an identity matrix of size " { $snippet "n x n" } ", where the diagonal values are all ones." } ;
HELP: m.v
{ $values { "m" sequence } { "v" sequence } { "v" sequence } }
{ $description "Computes the dot product between a matrix and a vector." }
{ $examples
{ $example
"USING: math.matrices prettyprint ;"
"{ { 1 -1 2 } { 0 -3 1 } } { 2 1 0 } m.v ."
"{ 1 -3 }"
}
} ;
HELP: m.
{ $values { "m" sequence } { "m" sequence } { "m" sequence } }
{ $description "Computes the dot product between two matrices, i.e multiplies them." }
{ $examples
{ $example
"USING: math.matrices prettyprint ;"
"{ { 1 -1 2 } { 0 -3 1 } } { { 3 7 } { 9 12 } } m. ."
"{ { -6 -5 } { -27 -36 } }"
}
} ;
HELP: m+
{ $values { "m" sequence } { "m" sequence } { "m" sequence } }
{ $description "Adds the matrices component-wise." }
{ $examples
{ $example
"USING: math.matrices prettyprint ;"
"{ { 1 2 } { 3 4 } } { { 5 6 } { 7 8 } } m+ ."
"{ { 6 8 } { 10 12 } }"
}
} ;
HELP: kron
{ $values { "m1" sequence } { "m2" sequence } { "m" sequence } }
{ $description "Calculates the Kronecker product of two matrices." }