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 { $subsection complex-components }
   8 { $subsection <complex-components> } ;
   9
  10 ABOUT: "sequences.complex-components"
  11
  12 HELP: complex-components
  13 { $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." }
  14 { $examples { $example """USING: prettyprint sequences arrays sequences.complex-components ;
  15 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> >array ."""
  16 "{ 1.0 -1.0 -2.0 0 3.0 1.0 }" } } ;
  17
  18 HELP: <complex-components>
  19 { $values { "sequence" sequence } { "complex-components" complex-components } }
  20 { $description "Wraps " { $snippet "sequence" } " in a " { $link complex-components } " wrapper." }
  21 { $examples
  22 { $example """USING: prettyprint sequences arrays
  23 sequences.complex-components ;
  24 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> third ."""
  25 "-2.0" }
  26 { $example """USING: prettyprint sequences arrays
  27 sequences.complex-components ;
  28 { C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> fourth ."""
  29 "0" }
  30 } ;
  31
  32 { complex-components <complex-components> } related-words