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

Enhanced RDoc for Float (#5144)

Browse Source 
Treats:

    #to_s
    #coerce
    #+
    #-
    #*
    #/
This commit is contained in:
Burdette Lamar 2021-11-19 12:16:16 -06:00 committed by GitHub
parent aa591af296
commit e0c38742a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
Notes: git 2021-11-20 03:16:45 +09:00 
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 57 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
numeric.c
View File

@ -967,11 +967,24 @@ rb_float_new_in_heap(double d)
/*
* call-seq:
* float.to_s -> string
* to_s -> string
*
* Returns a string containing a representation of +self+;
* depending of the value of +self+, the string representation
* may contain:
*
* - A fixed-point number.
* - A number in "scientific notation" (containing an exponent).
* - 'Infinity'.
* - '-Infinity'.
* - 'NaN' (indicating not-a-number).
*
* 3.14.to_s # => "3.14"
* (10.1**50).to_s # => "1.644631821843879e+50"
* (10.1**500).to_s # => "Infinity"
* (-10.1**500).to_s # => "-Infinity"
* (0.0/0.0).to_s # => "NaN"
*
* Returns a string containing a representation of +self+.
* As well as a fixed or exponential form of the +float+,
* the call may return +NaN+, +Infinity+, and +-Infinity+.
*/
static VALUE
@ -1059,9 +1072,7 @@ flo_to_s(VALUE flt)
* f.coerce(2) # => [2.0, 3.14]
* f.coerce(2.0) # => [2.0, 3.14]
* f.coerce(Rational(1, 2)) # => [0.5, 3.14]
* f.coerce(Complex(3, 4)) # Raises RangeError.
*
* Related: Numeric#coerce (for other numeric types).
* f.coerce(Complex(1, 0)) # => [1.0, 3.14]
*
* Raises an exception if a type conversion fails.
*
@ -1081,9 +1092,16 @@ rb_float_uminus(VALUE flt)
/*
* call-seq:
* float + other -> float
* self + other -> float
*
* Returns a new \Float which is the sum of +self+ and +other+:
*
* f = 3.14
* f + 1 # => 4.140000000000001
* f + 1.0 # => 4.140000000000001
* f + Rational(1, 1) # => 4.140000000000001
* f + Complex(1, 0) # => (4.140000000000001+0i)
*
* Returns a new Float which is the sum of +float+ and +other+.
*/
VALUE
@ -1105,9 +1123,16 @@ rb_float_plus(VALUE x, VALUE y)
/*
* call-seq:
* float - other -> float
* self - other -> float
*
* Returns a new \Float which is the difference of +self+ and +other+:
*
* f = 3.14
* f - 1 # => 2.14
* f - 1.0 # => 2.14
* f - Rational(1, 1) # => 2.14
* f - Complex(1, 0) # => (2.14+0i)
*
* Returns a new Float which is the difference of +float+ and +other+.
*/
VALUE
@ -1129,9 +1154,15 @@ rb_float_minus(VALUE x, VALUE y)
/*
* call-seq:
* float * other -> float
* self * other -> float
*
* Returns a new Float which is the product of +float+ and +other+.
* Returns a new \Float which is the product of +self+ and +other+:
*
* f = 3.14
* f * 2 # => 6.28
* f * 2.0 # => 6.28
* f * Rational(1, 2) # => 1.57
* f * Complex(2, 0) # => (6.28+0.0i)
*/
VALUE
@ -1177,9 +1208,16 @@ rb_flo_div_flo(VALUE x, VALUE y)
/*
* call-seq:
* float / other -> float
* self / other -> float
*
* Returns a new \Float which is the result of dividing +self+ by +other+:
*
* f = 3.14
* f / 2 # => 1.57
* f / 2.0 # => 1.57
* f / Rational(2, 1) # => 1.57
* f / Complex(2, 0) # => (1.57+0.0i)
*
* Returns a new Float which is the result of dividing +float+ by +other+.
*/
VALUE