steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

i fail at documentation

db4
Joe Groff 2008-12-04 18:47:18 -08:00
parent 1443e66897
commit c3ca5a8191
3 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
extra/sequences/complex-components/complex-components-docs.factor
View File

@ -12,8 +12,8 @@ ABOUT: "sequences.complex-components"
HELP: complex-components
{ $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." }
{ $examples { $example <"
USING: sequences arrays sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> >array
USING: prettyprint sequences arrays sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> >array .
"> "{ 1.0 -1.0 -2.0 0 3.0 1.0 }" } } ;
HELP: <complex-components>
@ -21,12 +21,14 @@ HELP: <complex-components>
{ $description "Wraps " { $snippet "sequence" } " in a " { $link complex-components } " wrapper." }
{ $examples
{ $example <"
USING: sequences arrays sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> third
USING: prettyprint sequences arrays
sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> third .
"> "-2.0" }
{ $example <"
USING: sequences arrays sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> fourth
USING: prettyprint sequences arrays
sequences.complex-components ;
{ C{ 1.0 -1.0 } -2.0 C{ 3.0 1.0 } } <complex-components> fourth .
"> "0" }
} ;

2
extra/sequences/complex-components/complex-components.factor
View File

@ -5,7 +5,7 @@ IN: sequences.complex-components
TUPLE: complex-components seq ;
INSTANCE: complex-components sequence
: <complex-components> ( sequence -- complex-sequence )
: <complex-components> ( sequence -- complex-components )
complex-components boa ; inline
<PRIVATE

10
extra/sequences/complex/complex-docs.factor
View File

@ -12,18 +12,20 @@ ABOUT: "sequences.complex"
HELP: complex-sequence
{ $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." }
{ $examples { $example <"
USING: specialized-arrays.double sequences.complex
USING: prettyprint
specialized-arrays.double sequences.complex
sequences arrays ;
double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> >array
double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> >array .
"> "{ C{ 1.0 -1.0 } C{ -2.0 2.0 } C{ 3.0 0.0 } }" } } ;
HELP: <complex-sequence>
{ $values { "sequence" sequence } { "complex-sequence" complex-sequence } }
{ $description "Wraps " { $snippet "sequence" } " in a " { $link complex-sequence } "." }
{ $examples { $example <"
USING: specialized-arrays.double sequences.complex
USING: prettyprint
specialized-arrays.double sequences.complex
sequences arrays ;
double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> second
double-array{ 1.0 -1.0 -2.0 2.0 3.0 0.0 } <complex-sequence> second .
"> "C{ -2.0 2.0 }" } } ;
{ complex-sequence <complex-sequence> } related-words