basis/sequences/complex/complex-docs.factor

   1 USING: help.markup help.syntax math sequences
   2 sequences.complex ;
   3 IN: sequences.complex
   4
   5 ARTICLE: "sequences.complex" "Complex virtual sequences"
   6 "The " { $link complex-sequence } " class wraps a sequence of " { $link real } " number values, presenting a sequence of " { $link complex } " values made by treating the underlying sequence as pairs of alternating real and imaginary values."
   7 { $subsection complex-sequence }
   8 { $subsection <complex-sequence> } ;
   9
  10 ABOUT: "sequences.complex"
  11
  12 HELP: complex-sequence
  13 { $class-description "Sequence wrapper class that transforms a sequence of " { $link real } " number values into a sequence of " { $link complex } " values, treating the underlying sequence as pairs of alternating real and imaginary values."  }
  14 { $examples { $example """USING: prettyprint specialized-arrays
  15 sequences.complex sequences alien.c-types arrays ;
  16 SPECIALIZED-ARRAY: double
  17 double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> >array ."""
  18 "{ C{ 1.0 -1.0 } C{ -2.0 2.0 } C{ 3.0 0.0 } }" } } ;
  19
  20 HELP: <complex-sequence>
  21 { $values { "sequence" sequence } { "complex-sequence" complex-sequence } }
  22 { $description "Wraps " { $snippet "sequence" } " in a " { $link complex-sequence } "." }
  23 { $examples { $example """USING: prettyprint specialized-arrays
  24 sequences.complex sequences alien.c-types arrays ;
  25 SPECIALIZED-ARRAY: double
  26 double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> second ."""
  27 "C{ -2.0 2.0 }" } } ;
  28
  29 { complex-sequence <complex-sequence> } related-words