Div, mod, and floor div overhaul (#14157)

# Description
Dividing two ints can currently return either an int or a float. Not
having a single return type for an operation between two types seems
problematic. Additionally, the type signature for division says that
dividing two ints returns only an int which does not match the current
implementation (it can also return a float). This PR changes division
between almost all types to return a float (except for `filesize /
number` or `duration / number`, since there are no float representations
for these types).

Currently, floor division between certain types is not implemented even
though the type signature allows it. Also, the current implementation of
floor division uses a combination of clamping and flooring rather than
simply performing floor division which this PR fixes. Additionally, the
signature was changed so that `int // float`, `float // int`, and `float
// float` now return float instead of int. This matches the automatic
float promotion in the rest of the operators (as well as how Python does
floor division which I think is the original inspiration).

Since regular division has always returned fractional values (and now
returns a float to reflect that), `mod` is now defined in terms of floor
division. That is, `D // d = q`, `D mod d = r`, and `D = d * q + r `.
This is just like the `%` operator in Python, which is also based off
floor division (at least for ints and floats). Additionally,
implementations missing from `mod`'s current type signature have been
added (`duration mod int` and `duration mod float`).

This PR also overhauls the overflow checking and errors for div, mod,
and floor div. If an operation overflows, it will now cause an error.

# User-Facing Changes
- Div now returns a float in most cases.
- Floor division now actually does floor division.
- Floor division now does automatic float promotion, returning a float
in more instances.
- Floor division now actually allows division with filesize and
durations as its type signature claimed.
- Mod is now defined and implemented in terms of floor division rather
than truncating division.
- Mod now actually allows filesize and durations as its type signature
claimed.
- Div, mod, and floor div now all have proper overflow checks.

## Examples

When the divisor and the dividend have the same sign, the quotient and
remainder will be the same as before. (Except that this PR will give
more accurate results, since it does not do an intermediate float
conversion). If the signs of the divisor and dividend are different,
then the results will be different, or rather actually correct.

Before:

```nu
let q = 8 // -3 # -3
let r = 8 mod -3 # 2
8 == $q * -3 + $r # false
```

After:

```nu
let q = 8 // -3 # -3
let r = 8 mod -3 # -1
8 == $q * -3 + $r # true
```


Before:

```nu
let q = -8 // 3 # -3
let r = -8 mod 3 # -2
-8 == $q * 3 + $r # false
```

After:

```nu
let q = -8 // 3 # -3
let r = -8 mod 3 # 1
-8 == $q * 3 + $r # true
```

# Tests + Formatting
Added a few tests.

# After Submitting
Probably update the docs.
This commit is contained in:
Ian Manske 2024-11-04 09:03:48 -08:00 committed by GitHub
parent 20c2de9eed
commit 9f09930834
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 375 additions and 183 deletions

View file

@ -268,6 +268,42 @@ fn modulo() {
assert_eq!(actual.out, "1"); assert_eq!(actual.out, "1");
} }
#[test]
fn floor_div_mod() {
let actual = nu!("let q = 8 // -3; let r = 8 mod -3; 8 == $q * -3 + $r");
assert_eq!(actual.out, "true");
let actual = nu!("let q = -8 // 3; let r = -8 mod 3; -8 == $q * 3 + $r");
assert_eq!(actual.out, "true");
}
#[test]
fn floor_div_mod_overflow() {
let actual = nu!(format!("{} // -1", i64::MIN));
assert!(actual.err.contains("overflow"));
let actual = nu!(format!("{} mod -1", i64::MIN));
assert!(actual.err.contains("overflow"));
}
#[test]
fn floor_div_mod_zero() {
let actual = nu!("1 // 0");
assert!(actual.err.contains("zero"));
let actual = nu!("1 mod 0");
assert!(actual.err.contains("zero"));
}
#[test]
fn floor_div_mod_large_num() {
let actual = nu!(format!("{} // {}", i64::MAX, i64::MAX / 2));
assert_eq!(actual.out, "2");
let actual = nu!(format!("{} mod {}", i64::MAX, i64::MAX / 2));
assert_eq!(actual.out, "1");
}
#[test] #[test]
fn unit_multiplication_math() { fn unit_multiplication_math() {
let actual = nu!(pipeline( let actual = nu!(pipeline(

View file

@ -280,15 +280,15 @@ pub fn math_result_type(
} }
}, },
Operator::Math(Math::Divide) => match (&lhs.ty, &rhs.ty) { Operator::Math(Math::Divide) => match (&lhs.ty, &rhs.ty) {
(Type::Int, Type::Int) => (Type::Int, None), (Type::Int, Type::Int) => (Type::Float, None),
(Type::Float, Type::Int) => (Type::Float, None), (Type::Float, Type::Int) => (Type::Float, None),
(Type::Int, Type::Float) => (Type::Float, None), (Type::Int, Type::Float) => (Type::Float, None),
(Type::Float, Type::Float) => (Type::Float, None), (Type::Float, Type::Float) => (Type::Float, None),
(Type::Number, Type::Number) => (Type::Number, None), (Type::Number, Type::Number) => (Type::Float, None),
(Type::Number, Type::Int) => (Type::Number, None), (Type::Number, Type::Int) => (Type::Float, None),
(Type::Int, Type::Number) => (Type::Number, None), (Type::Int, Type::Number) => (Type::Float, None),
(Type::Number, Type::Float) => (Type::Number, None), (Type::Number, Type::Float) => (Type::Float, None),
(Type::Float, Type::Number) => (Type::Number, None), (Type::Float, Type::Number) => (Type::Float, None),
(Type::Filesize, Type::Filesize) => (Type::Float, None), (Type::Filesize, Type::Filesize) => (Type::Float, None),
(Type::Filesize, Type::Int) => (Type::Filesize, None), (Type::Filesize, Type::Int) => (Type::Filesize, None),
(Type::Filesize, Type::Float) => (Type::Filesize, None), (Type::Filesize, Type::Float) => (Type::Filesize, None),
@ -379,9 +379,9 @@ pub fn math_result_type(
}, },
Operator::Math(Math::FloorDivision) => match (&lhs.ty, &rhs.ty) { Operator::Math(Math::FloorDivision) => match (&lhs.ty, &rhs.ty) {
(Type::Int, Type::Int) => (Type::Int, None), (Type::Int, Type::Int) => (Type::Int, None),
(Type::Float, Type::Int) => (Type::Int, None), (Type::Float, Type::Int) => (Type::Float, None),
(Type::Int, Type::Float) => (Type::Int, None), (Type::Int, Type::Float) => (Type::Float, None),
(Type::Float, Type::Float) => (Type::Int, None), (Type::Float, Type::Float) => (Type::Float, None),
(Type::Number, Type::Number) => (Type::Number, None), (Type::Number, Type::Number) => (Type::Number, None),
(Type::Number, Type::Int) => (Type::Number, None), (Type::Number, Type::Int) => (Type::Number, None),
(Type::Int, Type::Number) => (Type::Number, None), (Type::Int, Type::Number) => (Type::Number, None),

View file

@ -37,12 +37,13 @@ pub enum ShellError {
/// Check the inputs to the operation and add guards for their sizes. /// Check the inputs to the operation and add guards for their sizes.
/// Integers are generally of size i64, floats are generally f64. /// Integers are generally of size i64, floats are generally f64.
#[error("Operator overflow.")] #[error("Operator overflow.")]
#[diagnostic(code(nu::shell::operator_overflow), help("{help}"))] #[diagnostic(code(nu::shell::operator_overflow))]
OperatorOverflow { OperatorOverflow {
msg: String, msg: String,
#[label = "{msg}"] #[label = "{msg}"]
span: Span, span: Span,
help: String, #[help]
help: Option<String>,
}, },
/// The pipelined input into a command was not of the expected type. For example, it might /// The pipelined input into a command was not of the expected type. For example, it might

View file

@ -2425,7 +2425,11 @@ impl Value {
if let Some(val) = lhs.checked_add(*rhs) { if let Some(val) = lhs.checked_add(*rhs) {
Ok(Value::int(val, span)) Ok(Value::int(val, span))
} else { } else {
Err(ShellError::OperatorOverflow { msg: "add operation overflowed".into(), span, help: "Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into() }) Err(ShellError::OperatorOverflow {
msg: "add operation overflowed".into(),
span,
help: Some("Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into()),
})
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
@ -2448,7 +2452,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "addition operation overflowed".into(), msg: "addition operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2459,7 +2463,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "add operation overflowed".into(), msg: "add operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2470,7 +2474,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "add operation overflowed".into(), msg: "add operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2534,7 +2538,11 @@ impl Value {
if let Some(val) = lhs.checked_sub(*rhs) { if let Some(val) = lhs.checked_sub(*rhs) {
Ok(Value::int(val, span)) Ok(Value::int(val, span))
} else { } else {
Err(ShellError::OperatorOverflow { msg: "subtraction operation overflowed".into(), span, help: "Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into() }) Err(ShellError::OperatorOverflow {
msg: "subtraction operation overflowed".into(),
span,
help: Some("Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into()),
})
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
@ -2555,7 +2563,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "subtraction operation overflowed".into(), msg: "subtraction operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2565,7 +2573,7 @@ impl Value {
_ => Err(ShellError::OperatorOverflow { _ => Err(ShellError::OperatorOverflow {
msg: "subtraction operation overflowed".into(), msg: "subtraction operation overflowed".into(),
span, span,
help: "".into(), help: None,
}), }),
} }
} }
@ -2576,7 +2584,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "subtraction operation overflowed".into(), msg: "subtraction operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2587,7 +2595,7 @@ impl Value {
Err(ShellError::OperatorOverflow { Err(ShellError::OperatorOverflow {
msg: "add operation overflowed".into(), msg: "add operation overflowed".into(),
span, span,
help: "".into(), help: None,
}) })
} }
} }
@ -2612,7 +2620,11 @@ impl Value {
if let Some(val) = lhs.checked_mul(*rhs) { if let Some(val) = lhs.checked_mul(*rhs) {
Ok(Value::int(val, span)) Ok(Value::int(val, span))
} else { } else {
Err(ShellError::OperatorOverflow { msg: "multiply operation overflowed".into(), span, help: "Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into() }) Err(ShellError::OperatorOverflow {
msg: "multiply operation overflowed".into(),
span,
help: Some("Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into()),
})
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
@ -2664,14 +2676,10 @@ impl Value {
pub fn div(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> { pub fn div(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> {
match (self, rhs) { match (self, rhs) {
(Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if *rhs == 0 {
if lhs % rhs == 0 {
Ok(Value::int(lhs / rhs, span))
} else {
Ok(Value::float((*lhs as f64) / (*rhs as f64), span))
}
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Ok(Value::float(*lhs as f64 / *rhs as f64, span))
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
@ -2696,57 +2704,73 @@ impl Value {
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Filesize { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Filesize { val: rhs, .. }) => {
if *rhs != 0 { if *rhs == 0 {
if lhs % rhs == 0 {
Ok(Value::int(lhs / rhs, span))
} else {
Ok(Value::float((*lhs as f64) / (*rhs as f64), span))
}
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Ok(Value::float(*lhs as f64 / *rhs as f64, span))
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = lhs.checked_div(*rhs) {
Ok(Value::filesize( Ok(Value::filesize(val, span))
((*lhs as f64) / (*rhs as f64)) as i64, } else if *rhs == 0 {
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 { if *rhs != 0.0 {
Ok(Value::filesize((*lhs as f64 / rhs) as i64, span)) let val = *lhs as f64 / rhs;
if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
Ok(Value::filesize(val as i64, span))
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => { (Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => {
if *rhs != 0 { if *rhs == 0 {
if lhs % rhs == 0 {
Ok(Value::int(lhs / rhs, span))
} else {
Ok(Value::float((*lhs as f64) / (*rhs as f64), span))
}
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Ok(Value::float(*lhs as f64 / *rhs as f64, span))
} }
} }
(Value::Duration { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Duration { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = lhs.checked_div(*rhs) {
Ok(Value::duration( Ok(Value::duration(val, span))
((*lhs as f64) / (*rhs as f64)) as i64, } else if *rhs == 0 {
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Duration { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Duration { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 { if *rhs != 0.0 {
Ok(Value::duration(((*lhs as f64) / rhs) as i64, span)) let val = *lhs as f64 / rhs;
if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
Ok(Value::duration(val as i64, span))
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
@ -2765,122 +2789,301 @@ impl Value {
} }
} }
pub fn floor_div(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> { pub fn modulo(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> {
// Based off the unstable `div_floor` function in the std library.
fn checked_mod_i64(dividend: i64, divisor: i64) -> Option<i64> {
let remainder = dividend.checked_rem(divisor)?;
if (remainder > 0 && divisor < 0) || (remainder < 0 && divisor > 0) {
// Note that `remainder + divisor` cannot overflow, because `remainder` and
// `divisor` have opposite signs.
Some(remainder + divisor)
} else {
Some(remainder)
}
}
fn checked_mod_f64(dividend: f64, divisor: f64) -> Option<f64> {
if divisor == 0.0 {
None
} else {
let remainder = dividend % divisor;
if (remainder > 0.0 && divisor < 0.0) || (remainder < 0.0 && divisor > 0.0) {
Some(remainder + divisor)
} else {
Some(remainder)
}
}
}
match (self, rhs) { match (self, rhs) {
(Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_i64(*lhs, *rhs) {
Ok(Value::int( Ok(Value::int(val, span))
(*lhs as f64 / *rhs as f64) } else if *rhs == 0 {
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "modulo operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 { if let Some(val) = checked_mod_f64(*lhs as f64, *rhs) {
Ok(Value::int( Ok(Value::float(val, span))
(*lhs as f64 / *rhs)
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Float { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Float { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_f64(*lhs, *rhs as f64) {
Ok(Value::int( Ok(Value::float(val, span))
(*lhs / *rhs as f64)
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Float { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Float { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 { if let Some(val) = checked_mod_f64(*lhs, *rhs) {
Ok(Value::int( Ok(Value::float(val, span))
(lhs / rhs).clamp(i64::MIN as f64, i64::MAX as f64).floor() as i64,
span,
))
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Filesize { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Filesize { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_i64(*lhs, *rhs) {
Ok(Value::int( Ok(Value::filesize(val, span))
(*lhs as f64 / *rhs as f64) } else if *rhs == 0 {
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "modulo operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_i64(*lhs, *rhs) {
Ok(Value::filesize( Ok(Value::filesize(val, span))
((*lhs as f64) / (*rhs as f64)) } else if *rhs == 0 {
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "modulo operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Filesize { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Filesize { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 { if let Some(val) = checked_mod_f64(*lhs as f64, *rhs) {
Ok(Value::filesize( if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
(*lhs as f64 / *rhs) Ok(Value::filesize(val as i64, span))
.clamp(i64::MIN as f64, i64::MAX as f64) } else {
.floor() as i64, Err(ShellError::OperatorOverflow {
span, msg: "modulo operation overflowed".into(),
)) span,
help: None,
})
}
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => { (Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_i64(*lhs, *rhs) {
Ok(Value::int( Ok(Value::duration(val, span))
(*lhs as f64 / *rhs as f64) } else if *rhs == 0 {
.clamp(i64::MIN as f64, i64::MAX as f64)
.floor() as i64,
span,
))
} else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
} }
} }
(Value::Duration { val: lhs, .. }, Value::Int { val: rhs, .. }) => { (Value::Duration { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 { if let Some(val) = checked_mod_i64(*lhs, *rhs) {
Ok(Value::duration( Ok(Value::duration(val, span))
(*lhs as f64 / *rhs as f64) } else if *rhs == 0 {
.clamp(i64::MIN as f64, i64::MAX as f64) Err(ShellError::DivisionByZero { span: op })
.floor() as i64, } else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span, span,
)) help: None,
})
}
}
(Value::Duration { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if let Some(val) = checked_mod_f64(*lhs as f64, *rhs) {
if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
Ok(Value::duration(val as i64, span))
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
} }
(Value::Duration { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Custom { val: lhs, .. }, rhs) => {
if *rhs != 0.0 { lhs.operation(span, Operator::Math(Math::Modulo), op, rhs)
Ok(Value::duration( }
(*lhs as f64 / *rhs)
.clamp(i64::MIN as f64, i64::MAX as f64) _ => Err(ShellError::OperatorMismatch {
.floor() as i64, op_span: op,
lhs_ty: self.get_type().to_string(),
lhs_span: self.span(),
rhs_ty: rhs.get_type().to_string(),
rhs_span: rhs.span(),
}),
}
}
pub fn floor_div(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> {
// Taken from the unstable `div_floor` function in the std library.
fn checked_div_floor_i64(dividend: i64, divisor: i64) -> Option<i64> {
let quotient = dividend.checked_div(divisor)?;
let remainder = dividend.checked_rem(divisor)?;
if (remainder > 0 && divisor < 0) || (remainder < 0 && divisor > 0) {
// Note that `quotient - 1` cannot overflow, because:
// `quotient` would have to be `i64::MIN`
// => `divisor` would have to be `1`
// => `remainder` would have to be `0`
// But `remainder == 0` is excluded from the check above.
Some(quotient - 1)
} else {
Some(quotient)
}
}
fn checked_div_floor_f64(dividend: f64, divisor: f64) -> Option<f64> {
if divisor == 0.0 {
None
} else {
Some((dividend / divisor).floor())
}
}
match (self, rhs) {
(Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_i64(*lhs, *rhs) {
Ok(Value::int(val, span))
} else if *rhs == 0 {
Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span, span,
)) help: None,
})
}
}
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_f64(*lhs as f64, *rhs) {
Ok(Value::float(val, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Float { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_f64(*lhs, *rhs as f64) {
Ok(Value::float(val, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Float { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_f64(*lhs, *rhs) {
Ok(Value::float(val, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Filesize { val: lhs, .. }, Value::Filesize { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_i64(*lhs, *rhs) {
Ok(Value::int(val, span))
} else if *rhs == 0 {
Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
}
(Value::Filesize { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_i64(*lhs, *rhs) {
Ok(Value::filesize(val, span))
} else if *rhs == 0 {
Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
}
(Value::Filesize { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_f64(*lhs as f64, *rhs) {
if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
Ok(Value::filesize(val as i64, span))
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_i64(*lhs, *rhs) {
Ok(Value::int(val, span))
} else if *rhs == 0 {
Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
}
(Value::Duration { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_i64(*lhs, *rhs) {
Ok(Value::duration(val, span))
} else if *rhs == 0 {
Err(ShellError::DivisionByZero { span: op })
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
}
(Value::Duration { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if let Some(val) = checked_div_floor_f64(*lhs as f64, *rhs) {
if i64::MIN as f64 <= val && val <= i64::MAX as f64 {
Ok(Value::duration(val as i64, span))
} else {
Err(ShellError::OperatorOverflow {
msg: "division operation overflowed".into(),
span,
help: None,
})
}
} else { } else {
Err(ShellError::DivisionByZero { span: op }) Err(ShellError::DivisionByZero { span: op })
} }
@ -2888,7 +3091,6 @@ impl Value {
(Value::Custom { val: lhs, .. }, rhs) => { (Value::Custom { val: lhs, .. }, rhs) => {
lhs.operation(self.span(), Operator::Math(Math::Divide), op, rhs) lhs.operation(self.span(), Operator::Math(Math::Divide), op, rhs)
} }
_ => Err(ShellError::OperatorMismatch { _ => Err(ShellError::OperatorMismatch {
op_span: op, op_span: op,
lhs_ty: self.get_type().to_string(), lhs_ty: self.get_type().to_string(),
@ -3334,7 +3536,7 @@ impl Value {
msg: "right operand to bit-shl exceeds available bits in underlying data" msg: "right operand to bit-shl exceeds available bits in underlying data"
.into(), .into(),
span, span,
help: format!("Limit operand to 0 <= rhs < {}", i64::BITS), help: Some(format!("Limit operand to 0 <= rhs < {}", i64::BITS)),
}) })
} }
} }
@ -3363,7 +3565,7 @@ impl Value {
msg: "right operand to bit-shr exceeds available bits in underlying data" msg: "right operand to bit-shr exceeds available bits in underlying data"
.into(), .into(),
span, span,
help: format!("Limit operand to 0 <= rhs < {}", i64::BITS), help: Some(format!("Limit operand to 0 <= rhs < {}", i64::BITS)),
}) })
} }
} }
@ -3434,57 +3636,6 @@ impl Value {
} }
} }
pub fn modulo(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> {
match (self, rhs) {
(Value::Int { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 {
Ok(Value::int(lhs % rhs, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 {
Ok(Value::float(*lhs as f64 % *rhs, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Float { val: lhs, .. }, Value::Int { val: rhs, .. }) => {
if *rhs != 0 {
Ok(Value::float(*lhs % *rhs as f64, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Float { val: lhs, .. }, Value::Float { val: rhs, .. }) => {
if *rhs != 0.0 {
Ok(Value::float(lhs % rhs, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Duration { val: lhs, .. }, Value::Duration { val: rhs, .. }) => {
if *rhs != 0 {
Ok(Value::duration(lhs % rhs, span))
} else {
Err(ShellError::DivisionByZero { span: op })
}
}
(Value::Custom { val: lhs, .. }, rhs) => {
lhs.operation(span, Operator::Math(Math::Modulo), op, rhs)
}
_ => Err(ShellError::OperatorMismatch {
op_span: op,
lhs_ty: self.get_type().to_string(),
lhs_span: self.span(),
rhs_ty: rhs.get_type().to_string(),
rhs_span: rhs.span(),
}),
}
}
pub fn and(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> { pub fn and(&self, op: Span, rhs: &Value, span: Span) -> Result<Value, ShellError> {
match (self, rhs) { match (self, rhs) {
(Value::Bool { val: lhs, .. }, Value::Bool { val: rhs, .. }) => { (Value::Bool { val: lhs, .. }, Value::Bool { val: rhs, .. }) => {
@ -3545,7 +3696,11 @@ impl Value {
if let Some(val) = lhs.checked_pow(*rhs as u32) { if let Some(val) = lhs.checked_pow(*rhs as u32) {
Ok(Value::int(val, span)) Ok(Value::int(val, span))
} else { } else {
Err(ShellError::OperatorOverflow { msg: "pow operation overflowed".into(), span, help: "Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into() }) Err(ShellError::OperatorOverflow {
msg: "pow operation overflowed".into(),
span,
help: Some("Consider using floating point values for increased range by promoting operand with 'into float'. Note: float has reduced precision!".into()),
})
} }
} }
(Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => { (Value::Int { val: lhs, .. }, Value::Float { val: rhs, .. }) => {