spreadsheet_ods_formula/generated/

round.rs

use crate::*;
#[allow(unused_imports)]
use crate::round::*;

/// Round a number N up to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->CEILING](https://wiki.documentfoundation.org/Documentation/Calc_Functions/CEILING)
///
/// __Syntax__: 
/// ```ods
///     CEILING( N: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign if not 0.
///
/// __Semantics__:
/// Rounds a number up to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical ceiling function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded away from zero to a multiple of the absolute value of Significance 
/// and then the sign applied . If Mode is omitted or zero, rounding is toward 
/// positive infinity; the number is rounded to the smallest multiple of 
/// significance that is equal-to or greater than N. If any of the two 
/// parameters N or Significance is zero, the result is zero.
///
/// __Note__:
/// Many application user interfaces have a CEILING function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These CEILING functions are 
/// inconsistent with the standard mathematical definition of CEILING.
///
/// __See also__: [crate::of::floor()], [crate::of::int()], [crate::of::ceiling_()], [crate::of::ceiling__()], 
#[inline]
pub fn ceiling<A: Number>(n: A) -> FnNumber1<A> {
    FnNumber1("CEILING", n)
}

/// Round a number N up to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->CEILING](https://wiki.documentfoundation.org/Documentation/Calc_Functions/CEILING)
///
/// __Syntax__: 
/// ```ods
///     CEILING( N: Number; Significance: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign if not 0.
///
/// __Semantics__:
/// Rounds a number up to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical ceiling function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded away from zero to a multiple of the absolute value of Significance 
/// and then the sign applied . If Mode is omitted or zero, rounding is toward 
/// positive infinity; the number is rounded to the smallest multiple of 
/// significance that is equal-to or greater than N. If any of the two 
/// parameters N or Significance is zero, the result is zero.
///
/// __Note__:
/// Many application user interfaces have a CEILING function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These CEILING functions are 
/// inconsistent with the standard mathematical definition of CEILING.
///
/// __See also__: [crate::of::floor()], [crate::of::int()], [crate::of::ceiling()], [crate::of::ceiling__()], 
#[inline]
pub fn ceiling_<A: Number, B: Number>(n: A, significance: B) -> FnNumber2<A, B> {
    FnNumber2("CEILING", n, significance)
}

/// Round a number N up to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->CEILING](https://wiki.documentfoundation.org/Documentation/Calc_Functions/CEILING)
///
/// __Syntax__: 
/// ```ods
///     CEILING( N: Number; Significance: Number; Mode: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign if not 0.
///
/// __Semantics__:
/// Rounds a number up to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical ceiling function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded away from zero to a multiple of the absolute value of Significance 
/// and then the sign applied . If Mode is omitted or zero, rounding is toward 
/// positive infinity; the number is rounded to the smallest multiple of 
/// significance that is equal-to or greater than N. If any of the two 
/// parameters N or Significance is zero, the result is zero.
///
/// __Note__:
/// Many application user interfaces have a CEILING function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These CEILING functions are 
/// inconsistent with the standard mathematical definition of CEILING.
///
/// __See also__: [crate::of::floor()], [crate::of::int()], [crate::of::ceiling()], [crate::of::ceiling_()], 
#[inline]
pub fn ceiling__<A: Number, B: Number>(n: A, significance: B, mode: RoundingMode) -> FnNumber3<A, B, RoundingMode> {
    FnNumber3("CEILING", n, significance, mode)
}

/// Rounds a number down to the nearest integer.
///
/// [documentfoundation->INT](https://wiki.documentfoundation.org/Documentation/Calc_Functions/INT)
///
/// __Syntax__: 
/// ```ods
///     INT( N: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Returns the nearest integer whose value is less than or equal to N. 
/// Rounding is towards negative infinity.
///
/// __See also__: [crate::of::round()], [crate::of::trunc()], 
#[inline]
pub fn int<A: Number>(n: A) -> FnNumber1<A> {
    FnNumber1("INT", n)
}

/// Round a number N down to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->FLOOR](https://wiki.documentfoundation.org/Documentation/Calc_Functions/FLOOR)
///
/// __Syntax__: 
/// ```ods
///     FLOOR( N: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign.
///
/// __Semantics__:
/// Rounds a number down to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical floor function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded toward zero to a multiple of the absolute value of Significance and 
/// then the sign applied . Otherwise, it rounds toward negative infinity, and 
/// the result is the largest multiple of Significance that is less than or 
/// equal to N. If any of the two parameters N or Significance is zero, the 
/// result is zero.
///
/// __Note__:
/// Many application user interfaces have a FLOOR function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These FLOOR functions are 
/// inconsistent with the standard mathematical definition of FLOOR.
///
/// __See also__: [crate::of::ceiling()], [crate::of::int()], [crate::of::floor_()], [crate::of::floor__()], 
#[inline]
pub fn floor<A: Number>(n: A) -> FnNumber1<A> {
    FnNumber1("FLOOR", n)
}

/// Round a number N down to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->FLOOR](https://wiki.documentfoundation.org/Documentation/Calc_Functions/FLOOR)
///
/// __Syntax__: 
/// ```ods
///     FLOOR( N: Number; Significance: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign.
///
/// __Semantics__:
/// Rounds a number down to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical floor function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded toward zero to a multiple of the absolute value of Significance and 
/// then the sign applied . Otherwise, it rounds toward negative infinity, and 
/// the result is the largest multiple of Significance that is less than or 
/// equal to N. If any of the two parameters N or Significance is zero, the 
/// result is zero.
///
/// __Note__:
/// Many application user interfaces have a FLOOR function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These FLOOR functions are 
/// inconsistent with the standard mathematical definition of FLOOR.
///
/// __See also__: [crate::of::ceiling()], [crate::of::int()], [crate::of::floor()], [crate::of::floor__()], 
#[inline]
pub fn floor_<A: Number, B: Number>(n: A, significance: B) -> FnNumber2<A, B> {
    FnNumber2("FLOOR", n, significance)
}

/// Round a number N down to the nearest multiple of the second parameter, 
/// significance.
///
/// [documentfoundation->FLOOR](https://wiki.documentfoundation.org/Documentation/Calc_Functions/FLOOR)
///
/// __Syntax__: 
/// ```ods
///     FLOOR( N: Number; Significance: Number; Mode: Number )
/// ```
///
/// __Constraints__:
/// Both N and Significance shall be numeric and have the same sign.
///
/// __Semantics__:
/// Rounds a number down to a multiple of the second number. If Significance is 
/// omitted or an empty parameter (two consecutive ;; semicolons) it is assumed 
/// to be -1 if N is negative and +1 if N is non-negative, making the function 
/// act like the normal mathematical floor function if Mode is not given or 
/// zero. If Mode is given and not equal to zero, the absolute value of N is 
/// rounded toward zero to a multiple of the absolute value of Significance and 
/// then the sign applied . Otherwise, it rounds toward negative infinity, and 
/// the result is the largest multiple of Significance that is less than or 
/// equal to N. If any of the two parameters N or Significance is zero, the 
/// result is zero.
///
/// __Note__:
/// Many application user interfaces have a FLOOR function with only two 
/// parameters, and somewhat different semantics than given here (e.g., they 
/// operate as if there was a non-zero Mode value). These FLOOR functions are 
/// inconsistent with the standard mathematical definition of FLOOR.
///
/// __See also__: [crate::of::ceiling()], [crate::of::int()], [crate::of::floor()], [crate::of::floor_()], 
#[inline]
pub fn floor__<A: Number, B: Number>(n: A, significance: B, mode: RoundingMode) -> FnNumber3<A, B, RoundingMode> {
    FnNumber3("FLOOR", n, significance, mode)
}

/// Rounds the number to given multiple.
///
/// [documentfoundation->MROUND](https://wiki.documentfoundation.org/Documentation/Calc_Functions/MROUND)
///
/// __Syntax__: 
/// ```ods
///     MROUND( A: Number; B: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Returns the number X, for which the following holds: X/B = INT(X / B) (B 
/// divides X), and for any other Y with the same property, ABS(Y – A) ≥ 
/// ABS(X - A). In case that two such X exist, the greater one is the result. 
/// In less formal language, this function rounds the number A to multiples of 
/// B.
///
/// __See also__: [crate::of::abs()], [crate::of::int()], [crate::of::round()], 
#[inline]
pub fn mround<A: Number, B: Number>(a: A, b: B) -> FnNumber2<A, B> {
    FnNumber2("MROUND", a, b)
}

/// Rounds the value X to the nearest multiple of the power of 10 specified by 
/// Digits.
///
/// [documentfoundation->ROUND](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUND)
///
/// __Syntax__: 
/// ```ods
///     ROUND( X: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round number X to the precision specified by Digits. The number X is 
/// rounded to the nearest power of 10 given by 10 −Digits. If Digits is 
/// zero, or absent, round to the nearest decimal integer. If Digits is 
/// non-negative, round to the specified number of decimal places. If Digits is 
/// negative, round to the left of the decimal point by -Digits places. If X is 
/// halfway between the two nearest values, the result shall round away from 
/// zero. Note that if X is a Number, and Digits ≤ 0, the results will always 
/// be an integer (without a fractional component).
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round_()], 
#[inline]
pub fn round<A: Number>(x: A) -> FnNumber1<A> {
    FnNumber1("ROUND", x)
}

/// Rounds the value X to the nearest multiple of the power of 10 specified by 
/// Digits.
///
/// [documentfoundation->ROUND](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUND)
///
/// __Syntax__: 
/// ```ods
///     ROUND( X: Number; Digits: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round number X to the precision specified by Digits. The number X is 
/// rounded to the nearest power of 10 given by 10 −Digits. If Digits is 
/// zero, or absent, round to the nearest decimal integer. If Digits is 
/// non-negative, round to the specified number of decimal places. If Digits is 
/// negative, round to the left of the decimal point by -Digits places. If X is 
/// halfway between the two nearest values, the result shall round away from 
/// zero. Note that if X is a Number, and Digits ≤ 0, the results will always 
/// be an integer (without a fractional component).
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round()], 
#[inline]
pub fn round_<A: Number, B: Number>(x: A, digits: B) -> FnNumber2<A, B> {
    FnNumber2("ROUND", x, digits)
}

/// Rounds the value X towards zero to the number of digits specified by 
/// Digits.
///
/// [documentfoundation->ROUNDDOWN](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUNDDOWN)
///
/// __Syntax__: 
/// ```ods
///     ROUNDDOWN( X: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round X towards zero, to the precision specified by Digits. The number 
/// returned is a multiple of 10−Digits. If Digits is zero, or absent, round 
/// to the largest decimal integer whose absolute value is smaller or equal to 
/// the absolute value of X. If Digits is positive, round towards zero to the 
/// specified number of decimal places. If Digits is negative, round towards 
/// zero to the left of the decimal point by -Digits places.
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round()], [crate::of::roundup()], [crate::of::rounddown_()], 
#[inline]
pub fn rounddown<A: Number>(x: A) -> FnNumber1<A> {
    FnNumber1("ROUNDDOWN", x)
}

/// Rounds the value X towards zero to the number of digits specified by 
/// Digits.
///
/// [documentfoundation->ROUNDDOWN](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUNDDOWN)
///
/// __Syntax__: 
/// ```ods
///     ROUNDDOWN( X: Number; Digits: Integer )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round X towards zero, to the precision specified by Digits. The number 
/// returned is a multiple of 10−Digits. If Digits is zero, or absent, round 
/// to the largest decimal integer whose absolute value is smaller or equal to 
/// the absolute value of X. If Digits is positive, round towards zero to the 
/// specified number of decimal places. If Digits is negative, round towards 
/// zero to the left of the decimal point by -Digits places.
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round()], [crate::of::roundup()], [crate::of::rounddown()], 
#[inline]
pub fn rounddown_<A: Number, B: Number>(x: A, digits: B) -> FnNumber2<A, B> {
    FnNumber2("ROUNDDOWN", x, digits)
}

/// Rounds the value X away from zero to the number of digits specified by 
/// Digits
///
/// [documentfoundation->ROUNDUP](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUNDUP)
///
/// __Syntax__: 
/// ```ods
///     ROUNDUP( X: Number )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round X away from zero, to the precision specified by Digits. The number 
/// returned is a multiple of 10−Digits. If Digits is zero, or absent, round 
/// to the smallest decimal integer whose absolute value is larger or equal to 
/// the absolute value of X. If Digits is positive, round away from zero to the 
/// specified number of decimal places. If Digits is negative, round away from 
/// zero to the left of the decimal point by -Digits places.
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round()], [crate::of::rounddown()], [crate::of::roundup_()], 
#[inline]
pub fn roundup<A: Number>(x: A) -> FnNumber1<A> {
    FnNumber1("ROUNDUP", x)
}

/// Rounds the value X away from zero to the number of digits specified by 
/// Digits
///
/// [documentfoundation->ROUNDUP](https://wiki.documentfoundation.org/Documentation/Calc_Functions/ROUNDUP)
///
/// __Syntax__: 
/// ```ods
///     ROUNDUP( X: Number; Digits: Integer )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Round X away from zero, to the precision specified by Digits. The number 
/// returned is a multiple of 10−Digits. If Digits is zero, or absent, round 
/// to the smallest decimal integer whose absolute value is larger or equal to 
/// the absolute value of X. If Digits is positive, round away from zero to the 
/// specified number of decimal places. If Digits is negative, round away from 
/// zero to the left of the decimal point by -Digits places.
///
/// __See also__: [crate::of::trunc()], [crate::of::int()], [crate::of::round()], [crate::of::rounddown()], [crate::of::roundup()], 
#[inline]
pub fn roundup_<A: Number, B: Number>(x: A, digits: B) -> FnNumber2<A, B> {
    FnNumber2("ROUNDUP", x, digits)
}

/// Truncate a number to a specified number of digits.
///
/// [documentfoundation->TRUNC](https://wiki.documentfoundation.org/Documentation/Calc_Functions/TRUNC)
///
/// __Syntax__: 
/// ```ods
///     TRUNC( A: Number; B: Integer )
/// ```
///
/// __Constraints__:
/// None
///
/// __Semantics__:
/// Truncate number A to the number of digits specified by B. If B is zero, or 
/// absent, truncate to an integer. If B is positive, truncate to the specified 
/// number of decimal places. If B is negative, truncate to the left of the 
/// decimal point.
///
/// __See also__: [crate::of::round()], [crate::of::int()], 
#[inline]
pub fn trunc<A: Number, B: Number>(a: A, b: B) -> FnNumber2<A, B> {
    FnNumber2("TRUNC", a, b)
}