stdlib/decimalView source ↗
decimal
24 items · generated by scribe fromstdlib/decimal.fd· synced 2026-11-15
Contents
- DEC_HALF_EVEN: (const)
- Decimal (struct)
- dec_zero (function)
- dec_from_i64 (function)
- dec_from_units (function)
- dec_parse (function)
- dec_to_str (function)
- dec_add (function)
- dec_sub (function)
- dec_mul (function)
- dec_neg (function)
- dec_abs (function)
- dec_sign (function)
- dec_cmp (function)
- dec_eq (function)
- dec_lt (function)
- dec_gt (function)
- dec_round (function)
- dec_div (function)
- dec_normalize (function)
- dec_to_i64 (function)
DEC_HALF_EVEN:
pub const DEC_HALF_EVEN: i64 = 0; pub const DEC_HALF_UP: i64 = 1; pub const DEC_DOWN: i64 = 2; pub const DEC_UP: i64 = 3; pub const DEC_FLOOR: i64 = 4; pub const DEC_CEILING: i64 = 5;Defined at line 22
Decimal
mantissa / 10^scale
Example: var price = dec_parse(“19.99”); var total = dec_mul(price, dec_from_i64(3)); println(dec_to_str(total)); assert_eq(dec_to_str(total), “59.97”); assert_eq(dec_to_str(dec_add(dec_parse(“0.1”), dec_parse(“0.2”))), “0.3”);
pub struct Decimal {Fields:
| Name | Type |
|---|---|
m | BigInt |
scale | i64 |
Defined at line 31
dec_zero
The decimal 0.
Example: assert_eq(dec_sign(dec_zero()), 0);
pub fn dec_zero() -> Decimal {Returns: Decimal
Defined at line 47
dec_from_i64
The integer n as a decimal (scale 0).
Example: assert_eq(dec_to_str(dec_from_i64(-7)), “-7”);
pub fn dec_from_i64(n: i64) -> Decimal {Parameters:
n:i64
Returns: Decimal
Defined at line 57
dec_from_units
units / 10^scale: dec_from_units(1250, 2) is 12.50.
Example: assert_eq(dec_to_str(dec_from_units(1250, 2)), “12.50”);
pub fn dec_from_units(units: i64, scale: i64) -> Decimal {Parameters:
units:i64scale:i64
Returns: Decimal
Defined at line 67
dec_parse
Parse ”[-+]digits[.digits][e[-+]digits]”; anything else is 0.
Example: assert_eq(dec_to_str(dec_parse(“-3.140”)), “-3.140”); assert_eq(dec_to_str(dec_parse(“1.5e2”)), “150”);
pub fn dec_parse(text: str) -> Decimal {Parameters:
text:str
Returns: Decimal
Defined at line 82
dec_to_str
The decimal as text, with exactly scale digits after the point.
Example: assert_eq(dec_to_str(dec_from_units(5, 3)), “0.005”);
pub fn dec_to_str(d: Decimal) -> str {Parameters:
d:Decimal
Returns: str
Defined at line 149
dec_add
a + b, exact (the scale of the result is the larger scale).
Example: assert_eq(dec_to_str(dec_add(dec_parse(“1.25”), dec_parse(“0.5”))), “1.75”);
pub fn dec_add(a: Decimal, b: Decimal) -> Decimal {Parameters:
a:Decimalb:Decimal
Returns: Decimal
Defined at line 182
dec_sub
a - b, exact.
Example: assert_eq(dec_to_str(dec_sub(dec_parse(“1”), dec_parse(“0.01”))), “0.99”);
pub fn dec_sub(a: Decimal, b: Decimal) -> Decimal {Parameters:
a:Decimalb:Decimal
Returns: Decimal
Defined at line 198
dec_mul
a * b, exact (the scales add up).
Example: assert_eq(dec_to_str(dec_mul(dec_parse(“1.5”), dec_parse(“1.5”))), “2.25”);
pub fn dec_mul(a: Decimal, b: Decimal) -> Decimal {Parameters:
a:Decimalb:Decimal
Returns: Decimal
Defined at line 206
dec_neg
The value with its sign flipped.
Example: assert_eq(dec_to_str(dec_neg(dec_parse(“2.5”))), “-2.5”);
pub fn dec_neg(a: Decimal) -> Decimal {Parameters:
a:Decimal
Returns: Decimal
Defined at line 216
dec_abs
The value without its sign.
Example: assert_eq(dec_to_str(dec_abs(dec_parse(“-2.5”))), “2.5”);
pub fn dec_abs(a: Decimal) -> Decimal {Parameters:
a:Decimal
Returns: Decimal
Defined at line 226
dec_sign
-1, 0 or 1
Example: assert_eq(dec_sign(dec_parse(“-0.1”)), -1);
pub fn dec_sign(a: Decimal) -> i64 {Parameters:
a:Decimal
Returns: i64
Defined at line 236
dec_cmp
-1, 0 or 1 by value (2.50 equals 2.5)
Example: assert_eq(dec_cmp(dec_parse(“2.50”), dec_parse(“2.5”)), 0); assert_eq(dec_cmp(dec_parse(“1”), dec_parse(“1.01”)), -1);
pub fn dec_cmp(a: Decimal, b: Decimal) -> i64 {Parameters:
a:Decimalb:Decimal
Returns: i64
Defined at line 251
dec_eq
Whether a == b in value (2.50 equals 2.5).
Example: assert(dec_eq(dec_parse(“2.50”), dec_parse(“2.5”)));
pub fn dec_eq(a: Decimal, b: Decimal) -> bool {Parameters:
a:Decimalb:Decimal
Returns: bool
Defined at line 259
dec_lt
Whether a < b.
Example: assert(dec_lt(dec_parse(“0.09”), dec_parse(“0.1”)));
pub fn dec_lt(a: Decimal, b: Decimal) -> bool {Parameters:
a:Decimalb:Decimal
Returns: bool
Defined at line 266
dec_gt
Whether a > b.
Example: assert(dec_gt(dec_parse(“0”), dec_parse(“-0.5”)));
pub fn dec_gt(a: Decimal, b: Decimal) -> bool {Parameters:
a:Decimalb:Decimal
Returns: bool
Defined at line 273
dec_round
a rounded to scale digits after the point.
Example: assert_eq(dec_to_str(dec_round(dec_parse(“2.345”), 2, DEC_HALF_UP)), “2.35”); assert_eq(dec_to_str(dec_round(dec_parse(“2.345”), 2, DEC_HALF_EVEN)), “2.34”); assert_eq(dec_to_str(dec_round(dec_parse(“2.349”), 2, DEC_DOWN)), “2.34”);
pub fn dec_round(a: Decimal, scale: i64, mode: i64) -> Decimal {Parameters:
a:Decimalscale:i64mode:i64
Returns: Decimal
Defined at line 318
dec_div
a / b with scale digits after the point, rounded by mode. Division by zero panics.
Example: var third = dec_div(dec_from_i64(1), dec_from_i64(3), 4, DEC_HALF_EVEN); assert_eq(dec_to_str(third), “0.3333”);
pub fn dec_div(a: Decimal, b: Decimal, scale: i64, mode: i64) -> Decimal {Parameters:
a:Decimalb:Decimalscale:i64mode:i64
Returns: Decimal
Defined at line 338
dec_normalize
The same value with no trailing zeros after the point (2.500 -> 2.5).
Example: assert_eq(dec_to_str(dec_normalize(dec_parse(“2.500”))), “2.5”);
pub fn dec_normalize(a: Decimal) -> Decimal {Parameters:
a:Decimal
Returns: Decimal
Defined at line 365
dec_to_i64
The integer part, rounded toward zero, if it fits in an i64.
Example: assert_eq(dec_to_i64(dec_parse(“-12.9”)), -12);
pub fn dec_to_i64(a: Decimal) -> i64 {Parameters:
a:Decimal
Returns: i64
Defined at line 390
Generated by scribe, the Fides documentation generator