azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: mod/rem: clarify who is dividend and divisor

Browse Source
This commit is contained in:
Paŭlo Ebermann
2022-09-30 14:41:55 +02:00
committed by GitHub
parent 5772230357
commit 418c530820
8 changed files with 92 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/util/FloorDivMod.kt
+20 -20
View File
@@ -19,7 +19,7 @@ public inline fun Byte.floorDiv(other: Byte): Int =
this.toInt().floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -37,7 +37,7 @@ public inline fun Byte.floorDiv(other: Short): Int =
this.toInt().floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -55,7 +55,7 @@ public inline fun Byte.floorDiv(other: Int): Int =
this.toInt().floorDiv(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -73,7 +73,7 @@ public inline fun Byte.floorDiv(other: Long): Long =
this.toLong().floorDiv(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -91,7 +91,7 @@ public inline fun Short.floorDiv(other: Byte): Int =
this.toInt().floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -109,7 +109,7 @@ public inline fun Short.floorDiv(other: Short): Int =
this.toInt().floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -127,7 +127,7 @@ public inline fun Short.floorDiv(other: Int): Int =
this.toInt().floorDiv(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -145,7 +145,7 @@ public inline fun Short.floorDiv(other: Long): Long =
this.toLong().floorDiv(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -163,7 +163,7 @@ public inline fun Int.floorDiv(other: Byte): Int =
this.floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -181,7 +181,7 @@ public inline fun Int.floorDiv(other: Short): Int =
this.floorDiv(other.toInt())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -202,7 +202,7 @@ public inline fun Int.floorDiv(other: Int): Int {
}
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -222,7 +222,7 @@ public inline fun Int.floorDiv(other: Long): Long =
this.toLong().floorDiv(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -240,7 +240,7 @@ public inline fun Long.floorDiv(other: Byte): Long =
this.floorDiv(other.toLong())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -258,7 +258,7 @@ public inline fun Long.floorDiv(other: Short): Long =
this.floorDiv(other.toLong())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -276,7 +276,7 @@ public inline fun Long.floorDiv(other: Int): Long =
this.floorDiv(other.toLong())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -297,7 +297,7 @@ public inline fun Long.floorDiv(other: Long): Long {
}
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*/
@@ -310,7 +310,7 @@ public inline fun Long.mod(other: Long): Long {
}
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*
@@ -325,7 +325,7 @@ public inline fun Float.mod(other: Float): Float {
}
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*
@@ -338,7 +338,7 @@ public inline fun Float.mod(other: Double): Double =
this.toDouble().mod(other)
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*
@@ -351,7 +351,7 @@ public inline fun Double.mod(other: Float): Double =
this.mod(other.toDouble())
/**
* Calculates the remainder of flooring division of this value by the other value.
* Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
*
* The result is either zero or has the same sign as the _divisor_ and has the absolute value less than the absolute value of the divisor.
*