math.matrices: adding docs for a few words.

db4
John Benediktsson 2012-05-25 12:19:23 -07:00
parent aad94d711b
commit f090967d77
2 changed files with 24 additions and 1 deletions

View File

@ -0,0 +1,24 @@
USING: help.markup help.syntax math sequences ;
IN: math.matrices
HELP: zero-matrix
{ $values { "m" integer } { "n" integer } { "matrix" sequence } }
{ $description "Creates a matrix of size " { $snippet "m x n" } ", filled with zeroes." } ;
HELP: diagonal-matrix
{ $values { "diagonal-seq" sequence } { "matrix" sequence } }
{ $description "Creates a matrix with the specified diagonal values." } ;
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: kron
{ $values { "m1" sequence } { "m2" sequence } { "m" sequence } }
{ $description "Calculates the Kronecker product of two matrices." }
{ $examples
{ $example "USING: math.matrices prettyprint ;"
"{ { 1 2 } { 3 4 } } { { 0 5 } { 6 7 } } kron ."
"{ { 0 5 0 10 } { 6 7 12 14 } { 0 15 0 20 } { 18 21 24 28 } }" }
} ;

View File

@ -157,7 +157,6 @@ IN: math.matrices
make-bits over first length identity-matrix
[ [ dupd m. ] when [ dup m. ] dip ] reduce nip ;
: stitch ( m -- m' )
[ ] [ [ append ] 2map ] map-reduce ;