kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Enhanced RDoc for remainder (#4975)

Browse source 
Treats Numeric#remainder and Integer#remainder.
This commit is contained in:
Burdette Lamar 2021-10-15 16:20:52 -05:00 • committed by GitHub
parent 2a5c3a4d0f
commit 5d975684da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
Notes: git 2021-10-16 06:21:13 +09:00 
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
1 changed files with 40 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
numeric.c
View file

@ -664,11 +664,33 @@ num_modulo(VALUE x, VALUE y)
/*
* call-seq:
* num.remainder(numeric) -> real
* remainder(other) -> real_number
*
* <code>x.remainder(y)</code> means <code>x-y*(x/y).truncate</code>.
* Returns the remainder after dividing +self+ by +other+.
*
* Of the Core and Standard Library classes,
* only Float and Rational use this implementation.
*
* Examples:
*
* 11.0.remainder(4) # => 3.0
* 11.0.remainder(-4) # => 3.0
* -11.0.remainder(4) # => -3.0
* -11.0.remainder(-4) # => -3.0
*
* 12.0.remainder(4) # => 0.0
* 12.0.remainder(-4) # => 0.0
* -12.0.remainder(4) # => -0.0
* -12.0.remainder(-4) # => -0.0
*
* 13.0.remainder(4.0) # => 1.0
* 13.0.remainder(Rational(4, 1)) # => 1.0
*
* Rational(13, 1).remainder(4) # => (1/1)
* Rational(13, 1).remainder(-4) # => (1/1)
* Rational(-13, 1).remainder(4) # => (-1/1)
* Rational(-13, 1).remainder(-4) # => (-1/1)
*
* See Numeric#divmod.
*/
static VALUE
@ -3816,19 +3838,25 @@ rb_int_modulo(VALUE x, VALUE y)
/*
* call-seq:
* int.remainder(numeric) -> real
* remainder(other) -> real_number
*
* Returns the remainder after dividing +int+ by +numeric+.
* Returns the remainder after dividing +self+ by +other+.
*
* <code>x.remainder(y)</code> means <code>x-y*(x/y).truncate</code>.
* Examples:
*
* 5.remainder(3) #=> 2
* -5.remainder(3) #=> -2
* 5.remainder(-3) #=> 2
* -5.remainder(-3) #=> -2
* 5.remainder(1.5) #=> 0.5
* 11.remainder(4) # => 3
* 11.remainder(-4) # => 3
* -11.remainder(4) # => -3
* -11.remainder(-4) # => -3
*
* 12.remainder(4) # => 0
* 12.remainder(-4) # => 0
* -12.remainder(4) # => 0
* -12.remainder(-4) # => 0
*
* 13.remainder(4.0) # => 1.0
* 13.remainder(Rational(4, 1)) # => (1/1)
*
* See Numeric#divmod.
*/
static VALUE