reifydb_value/value/number/

arithmetic.rs

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 ReifyDB

use crate::value::{
	Value,
	decimal::Decimal,
	is::IsNumber,
	number::{
		promote::Promote,
		safe::{add::SafeAdd, div::SafeDiv, mul::SafeMul, remainder::SafeRemainder, sub::SafeSub},
	},
	to_value::ToValue,
	value_type::ValueType,
};

fn arith_type(v: &Value) -> ValueType {
	match v {
		Value::None {
			inner,
		} => inner.clone(),
		other => other.get_type(),
	}
}

fn none_inner(l: &Value, r: &Value) -> Option<ValueType> {
	let l_none = matches!(l, Value::None { .. });
	let r_none = matches!(r, Value::None { .. });
	if !l_none && !r_none {
		return None;
	}
	Some(ValueType::promote(arith_type(l), arith_type(r)))
}

fn value_is_zero(v: &Value) -> bool {
	match v {
		Value::Int1(x) => SafeDiv::is_zero(x),
		Value::Int2(x) => SafeDiv::is_zero(x),
		Value::Int4(x) => SafeDiv::is_zero(x),
		Value::Int8(x) => SafeDiv::is_zero(x),
		Value::Int16(x) => SafeDiv::is_zero(x),
		Value::Uint1(x) => SafeDiv::is_zero(x),
		Value::Uint2(x) => SafeDiv::is_zero(x),
		Value::Uint4(x) => SafeDiv::is_zero(x),
		Value::Uint8(x) => SafeDiv::is_zero(x),
		Value::Uint16(x) => SafeDiv::is_zero(x),
		Value::Float4(x) => SafeDiv::is_zero(&x.value()),
		Value::Float8(x) => SafeDiv::is_zero(&x.value()),
		Value::Decimal(x) => SafeDiv::is_zero(x),
		_ => false,
	}
}

macro_rules! gen_helpers {
	($checked:ident, $sat:ident, $wrap:ident, $trait:ident, $cm:ident, $sm:ident, $wm:ident) => {
		fn $checked<L, R>(l: &L, r: &R) -> Option<Value>
		where
			L: Promote<R>,
			R: IsNumber,
			<L as Promote<R>>::Output: $trait,
		{
			let (a, b) = l.checked_promote(r)?;
			a.$cm(&b).map(|o| o.to_value())
		}

		fn $sat<L, R>(l: &L, r: &R) -> Value
		where
			L: Promote<R>,
			R: IsNumber,
			<L as Promote<R>>::Output: $trait,
		{
			let (a, b) = l.saturating_promote(r);
			a.$sm(&b).to_value()
		}

		fn $wrap<L, R>(l: &L, r: &R) -> Value
		where
			L: Promote<R>,
			R: IsNumber,
			<L as Promote<R>>::Output: $trait,
		{
			let (a, b) = l.wrapping_promote(r);
			a.$wm(&b).to_value()
		}
	};
}

gen_helpers!(v_checked_add, v_sat_add, v_wrap_add, SafeAdd, checked_add, saturating_add, wrapping_add);
gen_helpers!(v_checked_sub, v_sat_sub, v_wrap_sub, SafeSub, checked_sub, saturating_sub, wrapping_sub);
gen_helpers!(v_checked_mul, v_sat_mul, v_wrap_mul, SafeMul, checked_mul, saturating_mul, wrapping_mul);
gen_helpers!(v_checked_rem, v_sat_rem, v_wrap_rem, SafeRemainder, checked_rem, saturating_rem, wrapping_rem);

trait DivToValue: Sized {
	fn checked_div_to_value(&self, r: &Self) -> Option<Value>;
	fn saturating_div_to_value(&self, r: &Self) -> Value;
	fn wrapping_div_to_value(&self, r: &Self) -> Value;
}

macro_rules! impl_div_to_value_via_decimal {
	($($t:ty),*) => {
		$(
			impl DivToValue for $t {
				fn checked_div_to_value(&self, r: &Self) -> Option<Value> {
					Decimal::from(self.clone()).checked_div(&Decimal::from(r.clone())).map(Value::Decimal)
				}
				fn saturating_div_to_value(&self, r: &Self) -> Value {
					Value::Decimal(Decimal::from(self.clone()).saturating_div(&Decimal::from(r.clone())))
				}
				fn wrapping_div_to_value(&self, r: &Self) -> Value {
					Value::Decimal(Decimal::from(self.clone()).wrapping_div(&Decimal::from(r.clone())))
				}
			}
		)*
	};
}

impl_div_to_value_via_decimal!(i128, u128);

impl DivToValue for f64 {
	fn checked_div_to_value(&self, r: &Self) -> Option<Value> {
		self.checked_div(r).map(|o| o.to_value())
	}
	fn saturating_div_to_value(&self, r: &Self) -> Value {
		self.saturating_div(r).to_value()
	}
	fn wrapping_div_to_value(&self, r: &Self) -> Value {
		self.wrapping_div(r).to_value()
	}
}

impl DivToValue for Decimal {
	fn checked_div_to_value(&self, r: &Self) -> Option<Value> {
		self.checked_div(r).map(Value::Decimal)
	}
	fn saturating_div_to_value(&self, r: &Self) -> Value {
		Value::Decimal(self.saturating_div(r))
	}
	fn wrapping_div_to_value(&self, r: &Self) -> Value {
		Value::Decimal(self.wrapping_div(r))
	}
}

fn v_checked_div<L, R>(l: &L, r: &R) -> Option<Value>
where
	L: Promote<R>,
	R: IsNumber,
	<L as Promote<R>>::Output: DivToValue,
{
	let (a, b) = l.checked_promote(r)?;
	a.checked_div_to_value(&b)
}

fn v_sat_div<L, R>(l: &L, r: &R) -> Value
where
	L: Promote<R>,
	R: IsNumber,
	<L as Promote<R>>::Output: DivToValue,
{
	let (a, b) = l.saturating_promote(r);
	a.saturating_div_to_value(&b)
}

fn v_wrap_div<L, R>(l: &L, r: &R) -> Value
where
	L: Promote<R>,
	R: IsNumber,
	<L as Promote<R>>::Output: DivToValue,
{
	let (a, b) = l.wrapping_promote(r);
	a.wrapping_div_to_value(&b)
}

macro_rules! right_arms {
	($r:expr, $la:expr, $op:ident, $fallback:expr) => {
		match $r {
			Value::Int1(b) => $op($la, b),
			Value::Int2(b) => $op($la, b),
			Value::Int4(b) => $op($la, b),
			Value::Int8(b) => $op($la, b),
			Value::Int16(b) => $op($la, b),
			Value::Uint1(b) => $op($la, b),
			Value::Uint2(b) => $op($la, b),
			Value::Uint4(b) => $op($la, b),
			Value::Uint8(b) => $op($la, b),
			Value::Uint16(b) => $op($la, b),
			Value::Decimal(b) => $op($la, b),
			Value::Float4(b) => $op($la, &b.value()),
			Value::Float8(b) => $op($la, &b.value()),
			_ => $fallback,
		}
	};
}

macro_rules! value_arith_dispatch {
	($l:expr, $r:expr, $op:ident, $fallback:expr) => {
		match $l {
			Value::Int1(a) => right_arms!($r, a, $op, $fallback),
			Value::Int2(a) => right_arms!($r, a, $op, $fallback),
			Value::Int4(a) => right_arms!($r, a, $op, $fallback),
			Value::Int8(a) => right_arms!($r, a, $op, $fallback),
			Value::Int16(a) => right_arms!($r, a, $op, $fallback),
			Value::Uint1(a) => right_arms!($r, a, $op, $fallback),
			Value::Uint2(a) => right_arms!($r, a, $op, $fallback),
			Value::Uint4(a) => right_arms!($r, a, $op, $fallback),
			Value::Uint8(a) => right_arms!($r, a, $op, $fallback),
			Value::Uint16(a) => right_arms!($r, a, $op, $fallback),
			Value::Decimal(a) => right_arms!($r, a, $op, $fallback),
			Value::Float4(a) => right_arms!($r, &a.value(), $op, $fallback),
			Value::Float8(a) => right_arms!($r, &a.value(), $op, $fallback),
			_ => $fallback,
		}
	};
}

macro_rules! impl_value_safe {
	($trait:ident, $checked:ident, $sat:ident, $wrap:ident, $hc:ident, $hs:ident, $hw:ident) => {
		impl $trait for Value {
			fn $checked(&self, r: &Self) -> Option<Self> {
				if let Some(inner) = none_inner(self, r) {
					return Some(Value::None {
						inner,
					});
				}
				value_arith_dispatch!(self, r, $hc, None)
			}

			fn $sat(&self, r: &Self) -> Self {
				if let Some(inner) = none_inner(self, r) {
					return Value::None {
						inner,
					};
				}
				value_arith_dispatch!(
					self,
					r,
					$hs,
					Value::None {
						inner: ValueType::Any
					}
				)
			}

			fn $wrap(&self, r: &Self) -> Self {
				if let Some(inner) = none_inner(self, r) {
					return Value::None {
						inner,
					};
				}
				value_arith_dispatch!(
					self,
					r,
					$hw,
					Value::None {
						inner: ValueType::Any
					}
				)
			}
		}
	};
}

impl_value_safe!(SafeAdd, checked_add, saturating_add, wrapping_add, v_checked_add, v_sat_add, v_wrap_add);
impl_value_safe!(SafeSub, checked_sub, saturating_sub, wrapping_sub, v_checked_sub, v_sat_sub, v_wrap_sub);
impl_value_safe!(SafeMul, checked_mul, saturating_mul, wrapping_mul, v_checked_mul, v_sat_mul, v_wrap_mul);

impl SafeDiv for Value {
	fn checked_div(&self, r: &Self) -> Option<Self> {
		if let Some(inner) = none_inner(self, r) {
			return Some(Value::None {
				inner,
			});
		}
		value_arith_dispatch!(self, r, v_checked_div, None)
	}

	fn saturating_div(&self, r: &Self) -> Self {
		if let Some(inner) = none_inner(self, r) {
			return Value::None {
				inner,
			};
		}
		value_arith_dispatch!(
			self,
			r,
			v_sat_div,
			Value::None {
				inner: ValueType::Any
			}
		)
	}

	fn wrapping_div(&self, r: &Self) -> Self {
		if let Some(inner) = none_inner(self, r) {
			return Value::None {
				inner,
			};
		}
		value_arith_dispatch!(
			self,
			r,
			v_wrap_div,
			Value::None {
				inner: ValueType::Any
			}
		)
	}

	fn is_zero(&self) -> bool {
		value_is_zero(self)
	}
}

impl SafeRemainder for Value {
	fn checked_rem(&self, r: &Self) -> Option<Self> {
		if let Some(inner) = none_inner(self, r) {
			return Some(Value::None {
				inner,
			});
		}
		value_arith_dispatch!(self, r, v_checked_rem, None)
	}

	fn saturating_rem(&self, r: &Self) -> Self {
		if let Some(inner) = none_inner(self, r) {
			return Value::None {
				inner,
			};
		}
		value_arith_dispatch!(
			self,
			r,
			v_sat_rem,
			Value::None {
				inner: ValueType::Any
			}
		)
	}

	fn wrapping_rem(&self, r: &Self) -> Self {
		if let Some(inner) = none_inner(self, r) {
			return Value::None {
				inner,
			};
		}
		value_arith_dispatch!(
			self,
			r,
			v_wrap_rem,
			Value::None {
				inner: ValueType::Any
			}
		)
	}

	fn is_zero(&self) -> bool {
		value_is_zero(self)
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::value::{ordered_f32::OrderedF32, ordered_f64::OrderedF64};

	fn int4(v: i32) -> Value {
		Value::Int4(v)
	}
	fn int2(v: i16) -> Value {
		Value::Int2(v)
	}
	fn uint4(v: u32) -> Value {
		Value::Uint4(v)
	}
	fn dec(v: i64) -> Value {
		Value::Decimal(Decimal::from(v))
	}

	#[test]
	fn add_int_pair_promotes_to_int16() {
		// Integer add/sub/mul promote to the widest fixed type so the operation cannot overflow
		// the operand width, whatever the declared widths were.
		assert_eq!(int2(3).checked_add(&int4(4)), Some(Value::Int16(7)));
		assert_eq!(int4(3).checked_add(&int4(4)), Some(Value::Int16(7)));
	}

	#[test]
	fn add_uint_pair_promotes_to_uint16() {
		assert_eq!(uint4(3).checked_add(&uint4(4)), Some(Value::Uint16(7)));
	}

	#[test]
	fn add_float_pair_is_float8() {
		let out = Value::Float8(OrderedF64::try_from(1.5).unwrap())
			.checked_add(&Value::Float4(OrderedF32::try_from(2.5f32).unwrap()));
		assert_eq!(out, Some(Value::Float8(OrderedF64::try_from(4.0).unwrap())));
	}

	#[test]
	fn add_decimal_pair_is_decimal() {
		assert_eq!(dec(3).checked_add(&dec(4)), Some(Value::Decimal(Decimal::from(7i64))));
	}

	#[test]
	fn mixed_int_decimal_is_decimal() {
		assert_eq!(int4(3).checked_add(&dec(4)), Some(Value::Decimal(Decimal::from(7i64))));
	}

	#[test]
	fn int_div_is_decimal_exact() {
		// Integer division promotes to Decimal so 3/2 is 1.5, not a truncated 1.
		let got = int4(3).checked_div(&int4(2)).unwrap();
		assert_eq!(got, Value::Decimal(Decimal::from(3i64).checked_div(&Decimal::from(2i64)).unwrap()));
		assert_ne!(got, Value::Decimal(Decimal::from(1i64)));
	}

	#[test]
	fn float_div_stays_float8() {
		let three = Value::Float8(OrderedF64::try_from(3.0).unwrap());
		let two = Value::Float8(OrderedF64::try_from(2.0).unwrap());
		assert_eq!(three.checked_div(&two), Some(Value::Float8(OrderedF64::try_from(1.5).unwrap())));
	}

	#[test]
	fn none_propagates_with_promoted_inner() {
		// A none operand yields Some(Value::None), which is a defined result distinct from the
		// Option::None used for overflow, and it carries the promoted type.
		let got = Value::none_of(ValueType::Int4).checked_add(&int4(5));
		assert_eq!(
			got,
			Some(Value::None {
				inner: ValueType::promote(ValueType::Int4, ValueType::Int4)
			})
		);
		assert!(matches!(got, Some(Value::None { .. })));
		assert!(matches!(int4(5).checked_add(&Value::none_of(ValueType::Int4)), Some(Value::None { .. })));
		assert!(matches!(
			Value::none_of(ValueType::Int4).checked_add(&Value::none_of(ValueType::Int8)),
			Some(Value::None { .. })
		));
	}

	#[test]
	fn overflow_checked_saturating_wrapping() {
		// Promotion moves the overflow point out to the i128 limit; past it the three
		// strategies must differ, or a caller cannot choose its failure mode.
		let max = Value::Int16(i128::MAX);
		let one = Value::Int16(1);
		assert_eq!(max.checked_add(&one), None);
		assert_eq!(max.saturating_add(&one), Value::Int16(i128::MAX));
		assert_eq!(max.wrapping_add(&one), Value::Int16(i128::MIN));
	}

	#[test]
	fn div_by_zero_is_none() {
		assert_eq!(int4(3).checked_div(&int4(0)), None);
		assert_eq!(dec(3).checked_div(&dec(0)), None);
		let one = Value::Float8(OrderedF64::try_from(1.0).unwrap());
		let zero = Value::Float8(OrderedF64::try_from(0.0).unwrap());
		assert_eq!(one.checked_div(&zero), None);
	}

	#[test]
	fn is_zero_per_variant() {
		assert!(SafeDiv::is_zero(&int4(0)));
		assert!(!SafeDiv::is_zero(&int4(1)));
		assert!(SafeDiv::is_zero(&dec(0)));
		assert!(!SafeDiv::is_zero(&dec(5)));
		assert!(!SafeDiv::is_zero(&Value::none_of(ValueType::Int4)));
		assert!(!SafeDiv::is_zero(&Value::Boolean(true)));
	}

	#[test]
	fn non_numeric_operand_is_none() {
		assert_eq!(int4(3).checked_add(&Value::Boolean(true)), None);
		assert_eq!(Value::Utf8("x".into()).checked_add(&int4(3)), None);
	}

	#[test]
	fn retraction_invariant_exact_for_integers() {
		// Window and aggregate accumulators retract by subtracting what they added, so for
		// non-float operands checked_sub must invert checked_add exactly.
		let cases = [(int4(100), int4(7)), (int2(30), int4(9)), (uint4(50), uint4(8)), (dec(1000), dec(123))];
		for (r, x) in cases {
			let added = r.checked_add(&x).unwrap();
			let restored = added.checked_sub(&x).unwrap();
			// Promotion changes the declared width, so the comparison is made after a
			// second add rather than against the original value.
			let twice = restored.checked_add(&x).unwrap();
			assert_eq!(added, twice, "add/sub must invert for {r:?} - {x:?}");
		}
	}

	#[test]
	fn retraction_float_within_tolerance() {
		// IEEE addition is not exactly invertible, so float retraction is bounded by a
		// tolerance instead of the exact equality the integer case gets.
		let r = Value::Float8(OrderedF64::try_from(0.1).unwrap());
		let x = Value::Float8(OrderedF64::try_from(0.2).unwrap());
		let restored = r.checked_add(&x).unwrap().checked_sub(&x).unwrap();
		if let Value::Float8(v) = restored {
			assert!((v.value() - 0.1).abs() < 1e-9, "float retraction drift too large: {}", v.value());
		} else {
			panic!("expected Float8, got {restored:?}");
		}
	}

	#[test]
	fn nan_result_is_none_float8() {
		// f64::MAX squared overflows to infinity, which checked_mul reports as None rather
		// than storing a non-finite float.
		let inf = Value::Float8(OrderedF64::try_from(f64::MAX).unwrap());
		assert_eq!(inf.checked_mul(&inf), None);
	}
}