1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] RDoc for Complex (#9254)

Browse Source
This commit is contained in:
Burdette Lamar 2023-12-15 12:32:32 -06:00 committed by GitHub
parent 92b10f5be7
commit 655c02790e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
complex.c
View File

@ -1399,12 +1399,22 @@ rb_complex_arg(VALUE self)
/*
* call-seq:
* cmp.rect -> array
* cmp.rectangular -> array
* rect -> array
*
* Returns an array; [cmp.real, cmp.imag].
* Returns the array <tt>[self.real, self.imag]</tt>:
*
* Complex(1, 2).rectangular #=> [1, 2]
* Complex.rect(1, 2).rect # => [1, 2]
*
* See {Rectangular Coordinates}[rdoc-ref:Complex@Rectangular+Coordinates].
*
* If +self+ was created with
* {polar coordinates}[rdoc-ref:Complex@Polar+Coordinates], the returned value
* is computed, and may be inexact:
*
* Complex.polar(1.0, 1.0).rect # => [0.5403023058681398, 0.8414709848078965]
*
*
* Complex#rectangular is an alias for Complex#rect.
*/
static VALUE
nucomp_rect(VALUE self)
@ -1415,11 +1425,20 @@ nucomp_rect(VALUE self)
/*
* call-seq:
* cmp.polar -> array
* polar -> array
*
* Returns an array; [cmp.abs, cmp.arg].
* Returns the array <tt>[self.abs, self.arg]</tt>:
*
* Complex.polar(1, 2).polar # => [1.0, 2.0]
*
* See {Polar Coordinates}[rdoc-ref:Complex@Polar+Coordinates].
*
* If +self+ was created with
* {rectangular coordinates}[rdoc-ref:Complex@Rectangular+Coordinates], the returned value
* is computed, and may be inexact:
*
* Complex.rect(1, 1).polar # => [1.4142135623730951, 0.7853981633974483]
*
* Complex(1, 2).polar #=> [2.23606797749979, 1.1071487177940904]
*/
static VALUE
nucomp_polar(VALUE self)
@ -1429,12 +1448,13 @@ nucomp_polar(VALUE self)
/*
* call-seq:
* cmp.conj -> complex
* cmp.conjugate -> complex
* conj -> complex
*
* Returns the complex conjugate.
* Returns the conjugate of +self+, <tt>Complex.rect(self.imag, self.real)</tt>:
*
* Complex(1, 2).conjugate #=> (1-2i)
* Complex.rect(1, 2).conj # => (1-2i)
*
* Complex#conjugate is an alias for Complex#conj.
*/
VALUE
rb_complex_conjugate(VALUE self)
@ -1445,10 +1465,9 @@ rb_complex_conjugate(VALUE self)
/*
* call-seq:
* Complex(1).real? -> false
* Complex(1, 2).real? -> false
* real? -> false
*
* Returns false, even if the complex number has no imaginary part.
* Returns +false+; for compatibility with Numeric#real?.
*/
static VALUE
nucomp_real_p_m(VALUE self)