41 lines
1.9 KiB
Factor
Executable File
41 lines
1.9 KiB
Factor
Executable File
USING: help.markup help.syntax math math.private math.functions
|
|
math.complex.private ;
|
|
IN: math.complex
|
|
|
|
ARTICLE: "complex-numbers" "Complex numbers"
|
|
{ $subsection complex }
|
|
"Complex numbers arise as solutions to quadratic equations whose graph does not intersect the " { $emphasis "x" } " axis. Their literal syntax is covered in " { $link "syntax-complex-numbers" } "."
|
|
$nl
|
|
"Unlike math, where all real numbers are also complex numbers, Factor only considers a number to be a complex number if its imaginary part is non-zero. However, complex number operations are fully supported for real numbers; they are treated as having an imaginary part of zero."
|
|
$nl
|
|
"Complex numbers can be taken apart:"
|
|
{ $subsection real-part }
|
|
{ $subsection imaginary-part }
|
|
{ $subsection >rect }
|
|
"Complex numbers can be constructed from real numbers:"
|
|
{ $subsection rect> }
|
|
{ $see-also "syntax-complex-numbers" } ;
|
|
HELP: complex
|
|
{ $class-description "The class of complex numbers with non-zero imaginary part." } ;
|
|
|
|
ABOUT: "math.complex"
|
|
|
|
HELP: 2>rect
|
|
{ $values { "x" "a complex number" } { "y" "a complex number" } { "xr" "real part of " { $snippet "x" } } { "xi" "imaginary part of " { $snippet "x" } } { "yr" "real part of " { $snippet "y" } } { "yi" "imaginary part of " { $snippet "y" } } }
|
|
{ $description "Extracts real and imaginary components of two numbers at once." } ;
|
|
|
|
HELP: complex/
|
|
{ $values { "x" "a complex number" } { "y" "a complex number" } { "r" "a real number" } { "i" "a real number" } { "m" "a real number" } }
|
|
{ $description
|
|
"Complex division kernel. If we use the notation from " { $link 2>rect } ", this word computes:"
|
|
{ $code
|
|
"r = xr*yr+xi*yi"
|
|
"i = xi*yr-xr*yi"
|
|
"m = yr*yr+yi*yi"
|
|
}
|
|
} ;
|
|
|
|
HELP: <complex> ( x y -- z )
|
|
{ $values { "x" "a real number" } { "y" "a real number" } { "z" "a complex number" } }
|
|
{ $description "Low-level complex number constructor. User code should call " { $link rect> } " instead." } ;
|