ruby-changes:69869
From: Burdette <ko1@a...>
Date: Tue, 23 Nov 2021 05:57:46 +0900 (JST)
Subject: [ruby-changes:69869] e42f994f6b (master): Enhanced RDoc for Float (#5153)
https://git.ruby-lang.org/ruby.git/commit/?id=e42f994f6b From e42f994f6b20416853af0252029af94ff7c9b9a9 Mon Sep 17 00:00:00 2001 From: Burdette Lamar <BurdetteLamar@Y...> Date: Mon, 22 Nov 2021 14:57:17 -0600 Subject: Enhanced RDoc for Float (#5153) Treats: #> #>= #< #<= #eql? #nan? #infinite? #finite? --- numeric.c | 132 ++++++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 90 insertions(+), 42 deletions(-) diff --git a/numeric.c b/numeric.c index d2d21601f0f..a894d5179c3 100644 --- a/numeric.c +++ b/numeric.c @@ -1671,13 +1671,18 @@ rb_float_cmp(VALUE x, VALUE y) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1671 } /* - * call-seq: - * float > real -> true or false + * call-seq: + * self > other -> true or false + * + * Returns +true+ if +self+ is numerically greater than +other+: * - * Returns +true+ if +float+ is greater than +real+. + * 2.0 > 1 # => true + * 2.0 > 1.0 # => true + * 2.0 > Rational(1, 2) # => true + * 2.0 > 2.0 # => false + * + * <tt>Float::NAN > Float::NAN</tt> returns an implementation-dependent value. * - * The result of <code>NaN > NaN</code> is undefined, - * so an implementation-dependent value is returned. */ VALUE @@ -1708,13 +1713,19 @@ rb_float_gt(VALUE x, VALUE y) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1713 } /* - * call-seq: - * float >= real -> true or false + * call-seq: + * self >= other -> true or false * - * Returns +true+ if +float+ is greater than or equal to +real+. + * Returns +true+ if +self+ is numerically greater than or equal to +other+: + * + * 2.0 >= 1 # => true + * 2.0 >= 1.0 # => true + * 2.0 >= Rational(1, 2) # => true + * 2.0 >= 2.0 # => true + * 2.0 >= 2.1 # => false + * + * <tt>Float::NAN >= Float::NAN</tt> returns an implementation-dependent value. * - * The result of <code>NaN >= NaN</code> is undefined, - * so an implementation-dependent value is returned. */ static VALUE @@ -1745,13 +1756,18 @@ flo_ge(VALUE x, VALUE y) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1756 } /* - * call-seq: - * float < real -> true or false + * call-seq: + * self < other -> true or false + * + * Returns +true+ if +self+ is numerically less than +other+: + * + * 2.0 < 3 # => true + * 2.0 < 3.0 # => true + * 2.0 < Rational(3, 1) # => true + * 2.0 < 2.0 # => false * - * Returns +true+ if +float+ is less than +real+. + * <tt>Float::NAN < Float::NAN</tt> returns an implementation-dependent value. * - * The result of <code>NaN < NaN</code> is undefined, - * so an implementation-dependent value is returned. */ static VALUE @@ -1782,13 +1798,19 @@ flo_lt(VALUE x, VALUE y) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1798 } /* - * call-seq: - * float <= real -> true or false + * call-seq: + * self <= other -> true or false + * + * Returns +true+ if +self+ is numerically less than or equal to +other+: + * + * 2.0 <= 3 # => true + * 2.0 <= 3.0 # => true + * 2.0 <= Rational(3, 1) # => true + * 2.0 <= 2.0 # => true + * 2.0 <= 1.0 # => false * - * Returns +true+ if +float+ is less than or equal to +real+. + * <tt>Float::NAN <= Float::NAN</tt> returns an implementation-dependent value. * - * The result of <code>NaN <= NaN</code> is undefined, - * so an implementation-dependent value is returned. */ static VALUE @@ -1820,15 +1842,20 @@ flo_le(VALUE x, VALUE y) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1842 /* * call-seq: - * float.eql?(obj) -> true or false + * eql?(other) -> true or false + * + * Returns +true+ if +other+ is a \Float with the same value as +self+, + * +false+ otherwise: * - * Returns +true+ only if +obj+ is a Float with the same value as +float+. - * Contrast this with Float#==, which performs type conversions. + * 2.0.eql?(2.0) # => true + * 2.0.eql?(1.0) # => false + * 2.0.eql?(1) # => false + * 2.0.eql?(Rational(2, 1)) # => false + * 2.0.eql?(Complex(2, 0)) # => false * - * 1.0.eql?(1) #=> false + * <tt>Float::NAN.eql?(Float::NAN)</tt> returns an implementation-dependent value. * - * The result of <code>NaN.eql?(NaN)</code> is undefined, - * so an implementation-dependent value is returned. + * Related: Float#== (performs type conversions). */ MJIT_FUNC_EXPORTED VALUE @@ -1856,14 +1883,14 @@ rb_float_abs(VALUE flt) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1883 /* * call-seq: - * float.nan? -> true or false + * nan? -> true or false * - * Returns +true+ if +float+ is an invalid IEEE floating point number. + * Returns +true+ if +self+ is a NaN, +false+ otherwise. * - * a = -1.0 #=> -1.0 - * a.nan? #=> false - * a = 0.0/0.0 #=> NaN - * a.nan? #=> true + * f = -1.0 #=> -1.0 + * f.nan? #=> false + * f = 0.0/0.0 #=> NaN + * f.nan? #=> true */ static VALUE @@ -1876,14 +1903,25 @@ flo_is_nan_p(VALUE num) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1903 /* * call-seq: - * float.infinite? -> -1, 1, or nil + * infinite? -> -1, 1, or nil * - * Returns +nil+, -1, or 1 depending on whether the value is - * finite, <code>-Infinity</code>, or <code>+Infinity</code>. + * Returns: + * + * - 1, if +self+ is <tt>Infinity</tt>. + * - -1 if +self+ is <tt>-Infinity</tt>. + * - +nil+, otherwise. + * + * Examples: + * + * f = 1.0/0.0 # => Infinity + * f.infinite? # => 1 + * f = -1.0/0.0 # => -Infinity + * f.infinite? # => -1 + * f = 1.0 # => 1.0 + * f.infinite? # => nil + * f = 0.0/0.0 # => NaN + * f.infinite? # => nil * - * (0.0).infinite? #=> nil - * (-1.0/0.0).infinite? #=> -1 - * (+1.0/0.0).infinite? #=> 1 */ VALUE @@ -1900,10 +1938,20 @@ rb_flo_is_infinite_p(VALUE num) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1938 /* * call-seq: - * float.finite? -> true or false + * finite? -> true or false + * + * Returns +true+ if +self+ is not +Infinity+, +-Infinity+, or +Nan+, + * +false+ otherwise: + * + * f = 2.0 # => 2.0 + * f.finite? # => true + * f = 1.0/0.0 # => Infinity + * f.finite? # => false + * f = -1.0/0.0 # => -Infinity + * f.finite? # => false + * f = 0.0/0.0 # => NaN + * f.finite? # => false * - * Returns +true+ if +float+ is a valid IEEE floating point number, - * i.e. it is not infinite and Float#nan? is +false+. */ VALUE @@ -1925,7 +1973,7 @@ flo_nextafter(VALUE flo, double value) https://github.com/ruby/ruby/blob/trunk/numeric.c#L1973 /* * call-seq: - * float.next_float -> float + * next_float -> float * * Returns the next representable floating point number. * -- cgit v1.2.1 -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/