basis/sequences/complex-components/complex-components-docs.factor

   1 USING: help.markup help.syntax math
   2 sequences sequences.complex-components ;
   3 IN: sequences.complex-components
   4
   5 ARTICLE: "sequences.complex-components" "Complex component virtual sequences"
   6 "The " { $link complex-components } " class wraps a sequence of " { $link complex } " number values, presenting a sequence of " { $link real } " values made by interleaving the real and imaginary parts of the complex values in the original sequence."
   7 { $subsections
   8     complex-components
   9     <complex-components>
  10 } ;
  11
  12 ABOUT: "sequences.complex-components"
  13
  14 HELP: complex-components
  15 { $class-description "Sequence wrapper class that transforms a sequence of " { $link complex } " number values into a sequence of " { $link real } " values, interleaving the real and imaginary parts of the complex values in the original sequence." }
  16 { $examples { $example "USING: prettyprint sequences arrays sequences.complex-components ;
  17 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> >array ."
  18 "{ 1.0 -1.0 -2.0 0 3.0 1.0 }" } } ;
  19
  20 HELP: <complex-components>
  21 { $values { "sequence" sequence } { "complex-components" complex-components } }
  22 { $description "Wraps " { $snippet "sequence" } " in a " { $link complex-components } " wrapper." }
  23 { $examples
  24 { $example "USING: prettyprint sequences arrays
  25 sequences.complex-components ;
  26 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> third ."
  27 "-2.0" }
  28 { $example "USING: prettyprint sequences arrays
  29 sequences.complex-components ;
  30 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> fourth ."
  31 "0" }
  32 } ;
  33
  34 { complex-components <complex-components> } related-words