c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
27 KiB
27 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| std::math::rem | manual |
Compute the remainder after dividing num by div.
If num is negative, the result will be too.
rem(
@num: [number](/docs/kcl/types/number),
divisor: [number](/docs/kcl/types/number),
): [number](/docs/kcl/types/number)
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
num |
number |
The number which will be divided by divisor. |
Yes |
divisor |
number |
The number which will divide num. |
Yes |
Returns
Examples
import rem from "std::math"
assert(rem( 7, divisor = 4), isEqualTo = 3, error = "remainder is 3")
assert(rem(-7, divisor = 4), isEqualTo = -3, error = "remainder is -3")
assert(rem( 7, divisor = -4), isEqualTo = 3, error = "remainder is 3")
assert(rem( 6, divisor = 2.5), isEqualTo = 1, error = "remainder is 1")
assert(rem( 6.5, divisor = 2.5), isEqualTo = 1.5, error = "remainder is 1.5")
assert(rem( 6.5, divisor = 2), isEqualTo = 0.5, error = "remainder is 0.5")