5d25f4a0e5
* Parse an unparse type decls (and refactor impl attributes slightly) Signed-off-by: Nick Cameron <nrc@ncameron.org> * Remove special treatment of geometric types from parser and executor Signed-off-by: Nick Cameron <nrc@ncameron.org> * Generate docs for std types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Hover tool-tips for types and fixup the frontend Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fixes Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
49 lines
27 KiB
Markdown
49 lines
27 KiB
Markdown
---
|
|
title: "rem"
|
|
excerpt: "Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too."
|
|
layout: manual
|
|
---
|
|
|
|
Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too.
|
|
|
|
|
|
|
|
```js
|
|
rem(
|
|
num: number,
|
|
divisor: number,
|
|
): number
|
|
```
|
|
|
|
### Tags
|
|
|
|
* `math`
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `num` | [`number`](/docs/kcl/types/number) | The number which will be divided by `divisor`. | Yes |
|
|
| `divisor` | [`number`](/docs/kcl/types/number) | The number which will divide `num`. | Yes |
|
|
|
|
### Returns
|
|
|
|
[`number`](/docs/kcl/types/number)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
assertEqual(rem(7, divisor = 4), 3, 0.01, "remainder is 3")
|
|
assertEqual(rem(-7, divisor = 4), -3, 0.01, "remainder is -3")
|
|
assertEqual(rem(7, divisor = -4), 3, 0.01, "remainder is 3")
|
|
assertEqual(rem(6, divisor = 2.5), 1, 0.01, "remainder is 1")
|
|
assertEqual(rem(6.5, divisor = 2.5), 1.5, 0.01, "remainder is 1.5")
|
|
assertEqual(rem(6.5, divisor = 2), 0.5, 0.01, "remainder is 0.5")
|
|
```
|
|
|
|
|
|
|
|
|