diff --git a/docs/src/functions/math_and_trigonometry/mod.md b/docs/src/functions/math_and_trigonometry/mod.md index 9f4eecc..37374e4 100644 --- a/docs/src/functions/math_and_trigonometry/mod.md +++ b/docs/src/functions/math_and_trigonometry/mod.md @@ -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) -::: \ No newline at end of file +## 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(dividend, divisor) => remainder** + +### 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. + + +## 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. + +## 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. \ No newline at end of file diff --git a/docs/src/functions/math_and_trigonometry/quotient.md b/docs/src/functions/math_and_trigonometry/quotient.md index d0baef9..5b2575b 100644 --- a/docs/src/functions/math_and_trigonometry/quotient.md +++ b/docs/src/functions/math_and_trigonometry/quotient.md @@ -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) -::: \ No newline at end of file +## 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(dividend, divisor) => quotient** + +### 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. + + +## 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. + +## 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. \ No newline at end of file