extra/math/blas/syntax/syntax-docs.factor

   1 USING: help.markup help.syntax math.blas.matrices math.blas.vectors multiline ;
   2 IN: math.blas.syntax
   3
   4 ARTICLE: "math.blas.syntax" "BLAS interface literal syntax"
   5 "Vectors:"
   6 { $subsection POSTPONE: svector{ }
   7 { $subsection POSTPONE: dvector{ }
   8 { $subsection POSTPONE: cvector{ }
   9 { $subsection POSTPONE: zvector{ }
  10 "Matrices:"
  11 { $subsection POSTPONE: smatrix{ }
  12 { $subsection POSTPONE: dmatrix{ }
  13 { $subsection POSTPONE: cmatrix{ }
  14 { $subsection POSTPONE: zmatrix{ } ;
  15
  16 ABOUT: "math.blas.syntax"
  17
  18 HELP: svector{
  19 { $syntax "svector{ 1.0 -2.0 3.0 }" }
  20 { $description "Construct a literal " { $link float-blas-vector } "." } ;
  21
  22 HELP: dvector{
  23 { $syntax "dvector{ 1.0 -2.0 3.0 }" }
  24 { $description "Construct a literal " { $link double-blas-vector } "." } ;
  25
  26 HELP: cvector{
  27 { $syntax "cvector{ 1.0 -2.0 C{ 3.0 -1.0 } }" }
  28 { $description "Construct a literal " { $link float-complex-blas-vector } "." } ;
  29
  30 HELP: zvector{
  31 { $syntax "dvector{ 1.0 -2.0 C{ 3.0 -1.0 } }" }
  32 { $description "Construct a literal " { $link double-complex-blas-vector } "." } ;
  33
  34 {
  35     POSTPONE: svector{ POSTPONE: dvector{
  36     POSTPONE: cvector{ POSTPONE: zvector{
  37 } related-words
  38
  39 HELP: smatrix{
  40 { $syntax <" smatrix{
  41     { 1.0 0.0 0.0 1.0 }
  42     { 0.0 1.0 0.0 2.0 }
  43     { 0.0 0.0 1.0 3.0 }
  44     { 0.0 0.0 0.0 1.0 }
  45 } "> }
  46 { $description "Construct a literal " { $link float-blas-matrix } ". Note that although BLAS matrices are stored in column-major order, the literal is specified in row-major order." } ;
  47
  48 HELP: dmatrix{
  49 { $syntax <" dmatrix{
  50     { 1.0 0.0 0.0 1.0 }
  51     { 0.0 1.0 0.0 2.0 }
  52     { 0.0 0.0 1.0 3.0 }
  53     { 0.0 0.0 0.0 1.0 }
  54 } "> }
  55 { $description "Construct a literal " { $link double-blas-matrix } ". Note that although BLAS matrices are stored in column-major order, the literal is specified in row-major order." } ;
  56
  57 HELP: cmatrix{
  58 { $syntax <" cmatrix{
  59     { 1.0 0.0           0.0 1.0           }
  60     { 0.0 C{ 0.0 1.0 }  0.0 2.0           }
  61     { 0.0 0.0          -1.0 3.0           }
  62     { 0.0 0.0           0.0 C{ 0.0 -1.0 } }
  63 } "> }
  64 { $description "Construct a literal " { $link float-complex-blas-matrix } ". Note that although BLAS matrices are stored in column-major order, the literal is specified in row-major order." } ;
  65
  66 HELP: zmatrix{
  67 { $syntax <" zmatrix{
  68     { 1.0 0.0           0.0 1.0           }
  69     { 0.0 C{ 0.0 1.0 }  0.0 2.0           }
  70     { 0.0 0.0          -1.0 3.0           }
  71     { 0.0 0.0           0.0 C{ 0.0 -1.0 } }
  72 } "> }
  73 { $description "Construct a literal " { $link double-complex-blas-matrix } ". Note that although BLAS matrices are stored in column-major order, the literal is specified in row-major order." } ;
  74
  75 {
  76     POSTPONE: smatrix{ POSTPONE: dmatrix{
  77     POSTPONE: cmatrix{ POSTPONE: zmatrix{
  78 } related-words