sirtimbly/IronCalc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update: adds MOD and QUOTIENT doc pages

Browse Source
This commit is contained in:
Elsa Minsut
2025-11-06 22:45:33 +01:00
committed by Nicolás Hatcher Andrés
parent e0306cb161
commit ba139d1b6c
2 changed files with 80 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/src/functions/math_and_trigonometry/mod.md
View File

@@ -4,9 +4,44 @@ outline: deep
lang: en-US
---
# MOD
# MOD function
::: warning
🚧 This function is not yet available in IronCalc.
[Follow development here](https://github.com/ironcalc/IronCalc/labels/Functions)
:::
## Overview
MOD is a function of the Math and Trigonometry category that returns the remainder after one number (the dividend) is divided by another number (the divisor). The result has the same sign as the divisor.
## Usage
### Syntax
**MOD(<span title="Number" style="color:#1E88E5">dividend</span>, <span title="Number" style="color:#1E88E5">divisor</span>) => <span title="Number" style="color:#1E88E5">remainder</span>**
### Argument descriptions
* *dividend* ([number](/features/value-types#numbers), required). The number whose remainder is to be calculated.
* *divisor* ([number](/features/value-types#numbers), required). The number by which the dividend is divided.
### Additional guidance
None.
### Returned value
MOD returns a [number](/features/value-types#numbers) that is the remainder after division, with the same sign as the divisor.
### Error conditions
* In common with many other IronCalc functions, MOD propagates errors that are found in its arguments.
* If no argument, or more than two arguments, are supplied, then MOD returns the [`#ERROR!`](/features/error-types.md#error) error.
* If either argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then MOD returns the [`#VALUE!`](/features/error-types.md#value) error.
* If the value of the *divisor* argument is 0, then MOD returns the [`#DIV/0!`](/features/error-types.md#div-0) error.
<!--@include: ../markdown-snippets/error-type-details.txt-->
## Details
* MOD follows the formula:
$$
\operatorname{MOD}(n, d) = n - d \times \operatorname{INT}\!\left(\dfrac{n}{d}\right)
$$
Since `INT` returns the greatest integer less than or equal to its argument (it rounds down), the remainder's sign matches the divisor, even though this might appear counterintuitive when the dividend and divisor have different signs.
<!--
## Examples
[See some examples in IronCalc](https://app.ironcalc.com/?example=mod).
-->
## Links
* For more information about the modulo operation, visit Wikipedia's [Modulo](https://en.wikipedia.org/wiki/Modulo) page.
* See also IronCalc's [QUOTIENT](/functions/math_and_trigonometry/quotient) function.
* Visit Microsoft Excel's [MOD function](https://support.microsoft.com/en-us/office/mod-function-9b6cd169-b6ee-406a-a97b-edf2a9dc24f3) page.
* Both [Google Sheets](https://support.google.com/docs/answer/3093497) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/MOD) provide versions of the MOD function.

45
docs/src/functions/math_and_trigonometry/quotient.md
View File

@@ -4,9 +4,44 @@ outline: deep
lang: en-US
---
# QUOTIENT
# QUOTIENT function
::: warning
🚧 This function is not yet available in IronCalc.
[Follow development here](https://github.com/ironcalc/IronCalc/labels/Functions)
:::
## Overview
QUOTIENT is a function of the Math and Trigonometry category that returns the integer portion of a division. It divides one number (dividend) by another (divisor) and discards the remainder by truncating toward zero.
## Usage
### Syntax
**QUOTIENT(<span title="Number" style="color:#1E88E5">dividend</span>, <span title="Number" style="color:#1E88E5">divisor</span>) => <span title="Number" style="color:#1E88E5">quotient</span>**
### Argument descriptions
* *dividend* ([number](/features/value-types#numbers), required). The number to be divided.
* *divisor* ([number](/features/value-types#numbers), required). The number by which to divide the dividend.
### Additional guidance
* QUOTIENT returns the integer part of the division and ignores any remainder. For negative results, it truncates toward zero.
### Returned value
QUOTIENT returns a [number](/features/value-types#numbers) that is the integer portion of the division of the dividend by the divisor.
### Error conditions
* In common with many other IronCalc functions, QUOTIENT propagates errors that are found in its arguments.
* If no argument, or more than two arguments, are supplied, then QUOTIENT returns the [`#ERROR!`](/features/error-types.md#error) error.
* If either argument is not (or cannot be converted to) a [number](/features/value-types#numbers), then QUOTIENT returns the [`#VALUE!`](/features/error-types.md#value) error.
* If the value of the *divisor* argument is 0, then QUOTIENT returns the [`#DIV/0!`](/features/error-types.md#div-0) error.
<!--@include: ../markdown-snippets/error-type-details.txt-->
## Details
* QUOTIENT corresponds to truncating the exact quotient toward zero:
$$
\operatorname{QUOTIENT}(n, d) = \operatorname{TRUNC}\!\left(\dfrac{n}{d}\right),\quad d \ne 0
$$
This differs from using `INT(n/d)` when the quotient is negative, because `INT` rounds down toward −∞, whereas `TRUNC` and QUOTIENT truncate toward zero.
<!--
## Examples
[See some examples in IronCalc](https://app.ironcalc.com/?example=quotient).
-->
## Links
* For more information about the quotient, visit Wikipedia's [Quotient](https://en.wikipedia.org/wiki/Quotient) page.
* See also IronCalc's [MOD](/functions/math_and_trigonometry/mod) function.
* Visit Microsoft Excel's [QUOTIENT function](https://support.microsoft.com/en-gb/office/quotient-function-9f7bf099-2a18-4282-8fa4-65290cc99dee) page.
* Both [Google Sheets](https://support.google.com/docs/answer/3093436) and [LibreOffice Calc](https://wiki.documentfoundation.org/Documentation/Calc_Functions/QUOTIENT) provide versions of the QUOTIENT function.