use crate::budget::BudgetError;
use crate::diff::{diff, DiffError};
use crate::flint::FlintPoly;
use crate::kernel::{subs, Domain, ExprData, ExprId, ExprPool};
use crate::poly::{together_parts, RationalFunction, UniPoly};
use crate::simplify::simplify;
use std::cell::Cell;
use std::collections::HashMap;
use std::fmt;
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct Series(pub ExprId);
impl Series {
pub fn expr(self) -> ExprId {
self.0
}
}
#[derive(Debug)]
pub enum SeriesError {
Diff(DiffError),
InvalidOrder,
}
impl fmt::Display for SeriesError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
SeriesError::Diff(e) => write!(f, "{e}"),
SeriesError::InvalidOrder => write!(
f,
"series order must be >= 1 and reachable: the expansion is not \
available at the order requested"
),
}
}
}
impl std::error::Error for SeriesError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
SeriesError::Diff(e) => Some(e),
SeriesError::InvalidOrder => None,
}
}
}
impl crate::errors::AlkahestError for SeriesError {
fn code(&self) -> &'static str {
match self {
SeriesError::Diff(_) => "E-SERIES-001",
SeriesError::InvalidOrder => "E-SERIES-002",
}
}
fn remediation(&self) -> Option<&'static str> {
match self {
SeriesError::Diff(_) => {
Some("ensure all functions are registered primitives with differentiation rules")
}
SeriesError::InvalidOrder => Some(
"pass order >= 1 (exclusive truncation degree in x); if the order was \
already positive the expansion exceeded the work ceiling — ask for a \
lower order, or simplify the expression so its derivatives close",
),
}
}
}
impl From<DiffError> for SeriesError {
fn from(e: DiffError) -> Self {
SeriesError::Diff(e)
}
}
pub fn series(
expr: ExprId,
var: ExprId,
point: ExprId,
order: u32,
pool: &ExprPool,
) -> Result<Series, SeriesError> {
let frame = enter_series_frame();
let _ceiling = enter_coeff_ceiling(pool.len().saturating_add(MAX_SERIES_POOL_GROWTH));
let LocalExpansion {
valuation,
coeffs,
h_expr,
} = local_expansion(expr, var, point, order, pool)?;
if frame.refusal_pending() {
return Err(SeriesError::InvalidOrder);
}
if let Some(idx) = first_indeterminate(&coeffs, pool) {
LAST_REFUSAL.with(|c| {
c.set(Some(SeriesRefusal {
requested: coeffs.len() as u32,
computed: idx as u32,
budget: None,
cause: SeriesRefusalCause::IndeterminateCoefficient,
}))
});
return Err(SeriesError::InvalidOrder);
}
Ok(assemble_series(&coeffs, valuation, h_expr, order, pool))
}
#[derive(Clone, Debug)]
pub(crate) struct LocalExpansion {
pub valuation: i32,
pub coeffs: Vec<ExprId>,
pub h_expr: ExprId,
}
pub(crate) fn local_expansion(
expr: ExprId,
var: ExprId,
point: ExprId,
order: u32,
pool: &ExprPool,
) -> Result<LocalExpansion, SeriesError> {
if order == 0 {
return Err(SeriesError::InvalidOrder);
}
let xi = pool.symbol("__sxp", Domain::Real);
let mut map = HashMap::new();
map.insert(var, pool.add(vec![point, xi]));
let shifted = subs(expr, &map, pool);
let h_expr = expansion_increment(pool, var, point);
let direct = expansion_matched_laurent(shifted, xi, h_expr, order, pool)?;
if first_indeterminate(&direct.coeffs, pool).is_none() {
return Ok(direct);
}
let saved = LAST_REFUSAL.with(|c| c.get());
if let Some(repaired) = quotient_expansion(shifted, xi, h_expr, order, pool)? {
if first_indeterminate(&repaired.coeffs, pool).is_none() {
LAST_REFUSAL.with(|c| c.set(saved));
return Ok(repaired);
}
}
Ok(direct)
}
fn quotient_expansion(
shifted: ExprId,
xi: ExprId,
h_expr: ExprId,
order: u32,
pool: &ExprPool,
) -> Result<Option<LocalExpansion>, SeriesError> {
let Ok((num, den)) = together_parts(shifted, vec![xi], pool) else {
return Ok(None);
};
if num == shifted {
return Ok(None);
}
if matches!(pool.get(den), ExprData::Integer(n) if n.0 == 1) {
let coeffs = taylor_coefficients(num, xi, order, pool)?;
if coeffs.len() < order as usize {
return Ok(None);
}
return Ok(Some(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
}));
}
let probe = (order as usize).saturating_add(VALUATION_PROBE_SLACK);
let probe_u32 = probe.min(u32::MAX as usize) as u32;
let d_probe = taylor_coefficients(den, xi, probe_u32, pool)?;
let Some(vd) = leading_index(&d_probe, pool) else {
return Ok(None);
};
if vd == 0 {
return Ok(None);
}
let n_probe = taylor_coefficients(num, xi, probe_u32, pool)?;
let Some(vn) = leading_index(&n_probe, pool) else {
return Ok(None);
};
let valuation = vn as i32 - vd as i32;
let num_taylor: u32 = if valuation < 0 {
order
} else {
(order as i32 - valuation).max(0) as u32
};
if num_taylor == 0 {
return Ok(Some(LocalExpansion {
valuation,
coeffs: Vec::new(),
h_expr,
}));
}
let a = unit_part(&n_probe, num, xi, vn, num_taylor, pool)?;
let b = unit_part(&d_probe, den, xi, vd, num_taylor, pool)?;
let (Some(a), Some(b)) = (a, b) else {
return Ok(None);
};
if a.iter()
.chain(b.iter())
.any(|&c| coefficient_is_indeterminate(c, pool))
{
return Ok(None);
}
let inv_b0 = reciprocal(b[0], pool);
let mut coeffs: Vec<ExprId> = Vec::with_capacity(num_taylor as usize);
for k in 0..num_taylor as usize {
let mut terms = vec![a[k]];
for (j, &bj) in b.iter().enumerate().take(k + 1).skip(1) {
terms.push(pool.mul(vec![pool.integer(-1_i32), bj, coeffs[k - j]]));
}
let numer = if terms.len() == 1 {
terms[0]
} else {
pool.add(terms)
};
coeffs.push(simplify(pool.mul(vec![numer, inv_b0]), pool).value);
if coeff_loop_should_stop(pool) {
return Ok(None);
}
}
Ok(Some(LocalExpansion {
valuation,
coeffs,
h_expr,
}))
}
const VALUATION_PROBE_SLACK: usize = 4;
fn reciprocal(expr: ExprId, pool: &ExprPool) -> ExprId {
match pool.get(expr) {
ExprData::Integer(n) if n.0 != 0 => pool.rational(rug::Integer::from(1), n.0.clone()),
ExprData::Rational(r) if r.0 != 0 => {
let inv = r.0.clone().recip();
let (num, den) = inv.into_numer_denom();
pool.rational(num, den)
}
_ => simplify(pool.pow(expr, pool.integer(-1_i32)), pool).value,
}
}
fn leading_index(coeffs: &[ExprId], pool: &ExprPool) -> Option<usize> {
coeffs.iter().position(|&c| !is_structural_zero(c, pool))
}
fn unit_part(
probed: &[ExprId],
expr: ExprId,
xi: ExprId,
v: usize,
wanted: u32,
pool: &ExprPool,
) -> Result<Option<Vec<ExprId>>, SeriesError> {
let need = v.saturating_add(wanted as usize);
if probed.len() >= need {
return Ok(Some(probed[v..need].to_vec()));
}
let Ok(need_u32) = u32::try_from(need) else {
return Ok(None);
};
let full = taylor_coefficients(expr, xi, need_u32, pool)?;
if full.len() < need {
return Ok(None);
}
Ok(Some(full[v..need].to_vec()))
}
fn factorial_u32(n: u32) -> rug::Integer {
let mut r = rug::Integer::from(1);
for i in 2..=n {
r *= i;
}
r
}
pub(crate) fn expansion_increment(pool: &ExprPool, var: ExprId, point: ExprId) -> ExprId {
match pool.get(point) {
ExprData::Integer(n) if n.0 == 0 => var,
_ => pool.add(vec![var, pool.mul(vec![pool.integer(-1_i32), point])]),
}
}
fn laurent_big_o_pow(valuation: i32, order: u32) -> i64 {
if valuation < 0 {
1
} else {
order as i64
}
}
pub(crate) fn is_structural_zero(id: ExprId, pool: &ExprPool) -> bool {
matches!(pool.get(id), ExprData::Integer(n) if n.0 == 0)
}
fn contains_zero_to_negative_power(expr: ExprId, pool: &ExprPool) -> bool {
match pool.get(expr) {
ExprData::Pow { base, exp } => {
let zero_base = matches!(pool.get(base), ExprData::Integer(n) if n.0 == 0);
let negative_exp = match pool.get(exp) {
ExprData::Integer(n) => n.0 < 0,
ExprData::Rational(r) => r.0 < 0,
ExprData::Float(f) => f.inner.to_f64() < 0.0,
_ => false,
};
(zero_base && negative_exp)
|| contains_zero_to_negative_power(base, pool)
|| contains_zero_to_negative_power(exp, pool)
}
ExprData::Add(xs) | ExprData::Mul(xs) => {
xs.iter().any(|&x| contains_zero_to_negative_power(x, pool))
}
ExprData::Func { args, .. } => args
.iter()
.any(|&a| contains_zero_to_negative_power(a, pool)),
_ => false,
}
}
fn coefficient_is_indeterminate(expr: ExprId, pool: &ExprPool) -> bool {
contains_zero_to_negative_power(expr, pool) || has_non_finite_constant(expr, pool)
}
fn has_non_finite_constant(expr: ExprId, pool: &ExprPool) -> bool {
let env = HashMap::new();
if let Some(v) = crate::jit::eval_interp(expr, &env, pool) {
return !v.is_finite();
}
match pool.get(expr) {
ExprData::Add(xs) | ExprData::Mul(xs) | ExprData::Func { args: xs, .. } => {
xs.iter().any(|&c| has_non_finite_constant(c, pool))
}
ExprData::Pow { base, exp } => {
has_non_finite_constant(base, pool) || has_non_finite_constant(exp, pool)
}
_ => false,
}
}
pub(crate) fn first_indeterminate(coeffs: &[ExprId], pool: &ExprPool) -> Option<usize> {
coeffs
.iter()
.position(|&c| coefficient_is_indeterminate(c, pool))
}
fn collect_atom_factors(expr: ExprId, pool: &ExprPool) -> Option<(Vec<ExprId>, Vec<ExprId>)> {
match pool.get(expr) {
ExprData::Pow { base, exp } => {
let n = pool.with(exp, |d| match d {
ExprData::Integer(i) => Some(i.0.clone()),
_ => None,
})?;
if n > 0 {
Some((vec![expr], vec![]))
} else if n < 0 {
let mag = (-n).to_u32()?;
let pos_exp = pool.integer(mag as i64);
Some((vec![], vec![pool.pow(base, pos_exp)]))
} else {
Some((vec![pool.integer(1_i32)], vec![]))
}
}
ExprData::Integer(_)
| ExprData::Rational(_)
| ExprData::Float(_)
| ExprData::Symbol { .. }
| ExprData::Func { .. } => Some((vec![expr], vec![])),
ExprData::Add(_)
| ExprData::Mul(_)
| ExprData::Piecewise { .. }
| ExprData::Predicate { .. }
| ExprData::Forall { .. }
| ExprData::Exists { .. }
| ExprData::RootSum { .. }
| ExprData::BigO(_) => None,
}
}
fn collect_term_factors(expr: ExprId, pool: &ExprPool) -> Option<(Vec<ExprId>, Vec<ExprId>)> {
match pool.get(expr) {
ExprData::Mul(args) => {
let mut nums = Vec::new();
let mut dens = Vec::new();
for &a in &args {
let (n, d) = collect_atom_factors(a, pool)?;
nums.extend(n);
dens.extend(d);
}
Some((nums, dens))
}
_ => collect_atom_factors(expr, pool),
}
}
fn product_sorted(pool: &ExprPool, factors: Vec<ExprId>) -> ExprId {
match factors.len() {
0 => pool.integer(1_i32),
1 => factors[0],
_ => pool.mul(factors),
}
}
fn unipoly_valuation(p: &UniPoly) -> Option<u32> {
for (i, c) in p.coefficients().into_iter().enumerate() {
if c != 0 {
return Some(i as u32);
}
}
None
}
fn unipoly_strip_low(p: &UniPoly, k: u32) -> UniPoly {
let coeffs: Vec<rug::Integer> = p.coefficients().into_iter().skip(k as usize).collect();
UniPoly {
var: p.var,
coeffs: FlintPoly::from_rug_coefficients(&coeffs),
}
}
pub const MAX_SERIES_POOL_GROWTH: usize = 50_000;
thread_local! {
static COEFF_POOL_CEILING: Cell<Option<usize>> = const { Cell::new(None) };
static IN_SERIES: Cell<bool> = const { Cell::new(false) };
static LAST_REFUSAL: Cell<Option<SeriesRefusal>> = const { Cell::new(None) };
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SeriesRefusal {
requested: u32,
computed: u32,
budget: Option<BudgetError>,
cause: SeriesRefusalCause,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum SeriesRefusalCause {
Exhausted,
IndeterminateCoefficient,
}
impl SeriesRefusal {
pub fn cause(&self) -> SeriesRefusalCause {
self.cause
}
}
impl SeriesRefusal {
pub fn requested_coefficients(&self) -> u32 {
self.requested
}
pub fn computed_coefficients(&self) -> u32 {
self.computed
}
pub fn budget(&self) -> Option<BudgetError> {
self.budget
}
}
impl fmt::Display for SeriesRefusal {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.cause {
SeriesRefusalCause::Exhausted => write!(
f,
"series expansion stopped after {} of {} Taylor coefficients ({}); \
refusing to return a shorter series labelled with the requested \
order, which would understate the O(.) remainder",
self.computed,
self.requested,
match self.budget {
Some(b) => format!("budget: {b}"),
None => "internal work ceiling".to_string(),
}
),
SeriesRefusalCause::IndeterminateCoefficient => write!(
f,
"coefficient {} of {} is an indeterminate form (0/0, 1/0, log(0) or \
similar), not a number: the expansion point is a singularity this \
expansion cannot resolve. Refusing to return a series whose \
coefficients evaluate to NaN or infinity",
self.computed, self.requested,
),
}
}
}
impl std::error::Error for SeriesRefusal {}
impl crate::errors::AlkahestError for SeriesRefusal {
fn code(&self) -> &'static str {
match self.cause {
SeriesRefusalCause::Exhausted => "E-SERIES-003",
SeriesRefusalCause::IndeterminateCoefficient => "E-SERIES-004",
}
}
fn remediation(&self) -> Option<&'static str> {
match self.cause {
SeriesRefusalCause::Exhausted => Some(
"ask for a lower order, raise the budget, or rewrite the expression so its \
repeated derivatives close (nested radicals grow by a constant factor per \
coefficient)",
),
SeriesRefusalCause::IndeterminateCoefficient => Some(
"the expansion point is a branch point, an essential singularity, or a \
removable one this engine cannot cancel: cancel the singular factor by \
hand (`cancel`/`together`), expand about a nearby regular point, or use \
`limit` for the single value you need",
),
}
}
}
pub(crate) struct SeriesFrame {
outermost: bool,
}
impl SeriesFrame {
fn refusal_pending(&self) -> bool {
LAST_REFUSAL.with(|c| c.get().is_some())
}
}
impl Drop for SeriesFrame {
fn drop(&mut self) {
if self.outermost {
IN_SERIES.with(|c| c.set(false));
}
}
}
fn enter_series_frame() -> SeriesFrame {
LAST_REFUSAL.with(|c| c.set(None));
IN_SERIES.with(|c| {
let already = c.get();
c.set(true);
SeriesFrame {
outermost: !already,
}
})
}
pub fn take_series_refusal() -> Option<SeriesRefusal> {
LAST_REFUSAL.with(|c| c.take())
}
pub(crate) struct CoeffCeiling(Option<usize>);
impl Drop for CoeffCeiling {
fn drop(&mut self) {
COEFF_POOL_CEILING.with(|c| c.set(self.0));
}
}
pub(crate) fn enter_coeff_ceiling(ceiling: usize) -> CoeffCeiling {
COEFF_POOL_CEILING.with(|c| {
let prev = c.get();
c.set(Some(ceiling));
CoeffCeiling(prev)
})
}
fn coeff_loop_should_stop(pool: &ExprPool) -> bool {
match COEFF_POOL_CEILING.with(|c| c.get()) {
Some(ceiling) => pool.len() > ceiling || crate::budget::check().is_err(),
None => false,
}
}
fn taylor_coefficients(
mut cur: ExprId,
xi: ExprId,
num: u32,
pool: &ExprPool,
) -> Result<Vec<ExprId>, SeriesError> {
let mut mapping = HashMap::new();
mapping.insert(xi, pool.integer(0_i32));
let mut out = Vec::with_capacity(num as usize);
for k in 0..num {
if k > 0 && coeff_loop_should_stop(pool) {
if IN_SERIES.with(|c| c.get()) {
let refusal = SeriesRefusal {
requested: num,
computed: k,
budget: crate::budget::check().err(),
cause: SeriesRefusalCause::Exhausted,
};
LAST_REFUSAL.with(|c| c.set(Some(refusal)));
}
break;
}
let ev = subs(cur, &mapping, pool);
let simp = simplify(ev, pool).value;
let fc = factorial_u32(k);
let inv_fact = pool.rational(rug::Integer::from(1), fc);
let coeff = simplify(pool.mul(vec![simp, inv_fact]), pool).value;
out.push(coeff);
if k + 1 < num {
cur = diff(cur, xi, pool)?.value;
}
}
Ok(out)
}
fn assemble_series(
coeffs: &[ExprId],
valuation: i32,
h_expr: ExprId,
order: u32,
pool: &ExprPool,
) -> Series {
let mut terms = Vec::new();
for (k, coeff) in coeffs.iter().enumerate() {
if is_structural_zero(*coeff, pool) {
continue;
}
let exp = valuation + k as i32;
let pow_term = if exp == 0 {
pool.integer(1_i32)
} else if exp == 1 {
h_expr
} else {
pool.pow(h_expr, pool.integer(exp as i64))
};
terms.push(pool.mul(vec![*coeff, pow_term]));
}
let big_o_pow = laurent_big_o_pow(valuation, order);
let o_term = pool.big_o(pool.pow(h_expr, pool.integer(big_o_pow)));
terms.push(o_term);
Series(pool.add(terms))
}
fn expansion_matched_laurent(
shifted: ExprId,
xi: ExprId,
h_expr: ExprId,
order: u32,
pool: &ExprPool,
) -> Result<LocalExpansion, SeriesError> {
let (nums, dens) = match collect_term_factors(shifted, pool) {
Some(p) => p,
None => {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
};
let n_expr = product_sorted(pool, nums);
let d_expr = product_sorted(pool, dens);
let rf = match RationalFunction::from_symbolic(n_expr, d_expr, vec![xi], pool) {
Ok(r) => r,
Err(_) => {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
};
if rf.numer.is_zero() {
return Ok(LocalExpansion {
valuation: 0,
coeffs: vec![pool.integer(0_i32)],
h_expr,
});
}
let n_uni = match UniPoly::from_symbolic(rf.numer.to_expr(pool), xi, pool) {
Ok(u) => u,
Err(_) => {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
};
let d_uni = match UniPoly::from_symbolic(rf.denom.to_expr(pool), xi, pool) {
Ok(u) => u,
Err(_) => {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
};
let vn = match unipoly_valuation(&n_uni) {
Some(v) => v,
None => {
return Ok(LocalExpansion {
valuation: 0,
coeffs: vec![pool.integer(0_i32)],
h_expr,
});
}
};
let vd = match unipoly_valuation(&d_uni) {
Some(v) => v,
None => {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
};
let valuation = vn as i32 - vd as i32;
let n0 = unipoly_strip_low(&n_uni, vn);
let d0 = unipoly_strip_low(&d_uni, vd);
let d0c = d0.coefficients();
if d0c.is_empty() || d0c[0] == 0 {
let coeffs = taylor_coefficients(shifted, xi, order, pool)?;
return Ok(LocalExpansion {
valuation: 0,
coeffs,
h_expr,
});
}
let n0_e = n0.to_symbolic_expr(pool);
let d0_e = d0.to_symbolic_expr(pool);
let inv_d = pool.pow(d0_e, pool.integer(-1_i32));
let g = simplify(pool.mul(vec![n0_e, inv_d]), pool).value;
let num_taylor: u32 = if valuation < 0 {
order
} else {
(order as i32 - valuation).max(0) as u32
};
if num_taylor == 0 {
return Ok(LocalExpansion {
valuation,
coeffs: Vec::new(),
h_expr,
});
}
let coeffs = taylor_coefficients(g, xi, num_taylor, pool)?;
Ok(LocalExpansion {
valuation,
coeffs,
h_expr,
})
}
#[cfg(test)]
mod tests {
use super::*;
use crate::kernel::{Domain, ExprData};
fn contains_big_o(id: ExprId, pool: &ExprPool) -> bool {
match pool.get(id) {
ExprData::BigO(_) => true,
ExprData::Add(xs) | ExprData::Mul(xs) => xs.iter().any(|e| contains_big_o(*e, pool)),
ExprData::Pow { base, exp } => contains_big_o(base, pool) || contains_big_o(exp, pool),
ExprData::Func { args, .. } => args.iter().any(|e| contains_big_o(*e, pool)),
_ => false,
}
}
#[test]
fn series_cos_about_zero_has_big_o() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let z = p.integer(0);
let cx = p.func("cos", vec![x]);
let s = series(cx, x, z, 6, &p).unwrap();
assert!(contains_big_o(s.expr(), &p));
}
#[test]
fn series_inv_x_laurent_has_big_o() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let z = p.integer(0);
let ix = p.pow(x, p.integer(-1));
let s = series(ix, x, z, 4, &p).unwrap();
assert!(contains_big_o(s.expr(), &p));
}
#[test]
fn series_refuses_rather_than_truncating_a_runaway_radical() {
use crate::errors::AlkahestError;
let p = ExprPool::new();
let t = p.symbol("t", Domain::Real);
let inner = p.add(vec![p.pow(t, p.integer(-2)), p.pow(t, p.integer(-1))]);
let ex = p.func("sqrt", vec![inner]);
match series(ex, t, p.integer(0), 32, &p) {
Ok(_) => {
assert_eq!(take_series_refusal(), None);
}
Err(e) => {
assert!(matches!(e, SeriesError::InvalidOrder), "{e:?}");
let refusal = take_series_refusal().expect("work-ceiling refusal recorded");
assert_eq!(refusal.code(), "E-SERIES-003");
assert_eq!(refusal.budget(), None, "no budget was active");
assert!(
refusal.computed_coefficients() < refusal.requested_coefficients(),
"{refusal}"
);
}
}
}
#[test]
fn order_zero_is_a_user_error_not_a_refusal() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let cx = p.func("cos", vec![x]);
let err = series(cx, x, p.integer(0), 0, &p).unwrap_err();
assert!(matches!(err, SeriesError::InvalidOrder), "{err:?}");
assert_eq!(take_series_refusal(), None);
}
#[test]
fn budget_stops_a_series_and_is_attributed() {
use crate::budget::{self, Budget, BudgetError};
let p = ExprPool::new();
let t = p.symbol("t", Domain::Real);
let inner = p.add(vec![p.pow(t, p.integer(-2)), p.pow(t, p.integer(-1))]);
let ex = p.func("sqrt", vec![inner]);
let _guard = budget::enter(Budget::new().with_max_steps(3));
let err = series(ex, t, p.integer(0), 32, &p).unwrap_err();
assert!(matches!(err, SeriesError::InvalidOrder), "{err:?}");
let refusal = take_series_refusal().expect("budget refusal recorded");
assert!(
matches!(refusal.budget(), Some(BudgetError::Steps { .. })),
"{refusal}"
);
}
#[test]
fn ordinary_high_order_expansion_is_unaffected() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let sx = p.func("sin", vec![x]);
let s = series(sx, x, p.integer(0), 24, &p).unwrap();
assert!(contains_big_o(s.expr(), &p));
assert_eq!(take_series_refusal(), None);
}
fn coeff_values(
expr: ExprId,
var: ExprId,
point: ExprId,
order: u32,
p: &ExprPool,
) -> Vec<f64> {
let exp = local_expansion(expr, var, point, order, p).expect("expansion");
let env = HashMap::new();
exp.coeffs
.iter()
.map(|&c| crate::jit::eval_interp(c, &env, p).unwrap_or(f64::NAN))
.collect()
}
fn assert_close(got: &[f64], want: &[f64]) {
assert_eq!(got.len(), want.len(), "got {got:?} want {want:?}");
for (g, w) in got.iter().zip(want) {
assert!((g - w).abs() < 1e-12, "got {got:?} want {want:?}");
}
}
fn sin_over_x(p: &ExprPool) -> ExprId {
let x = p.symbol("x", Domain::Real);
let s = p.func("sin", vec![x]);
p.mul(vec![s, p.pow(x, p.integer(-1))])
}
#[test]
fn sin_over_x_expands_through_its_removable_singularity() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let e = sin_over_x(&p);
assert_close(
&coeff_values(e, x, p.integer(0), 6, &p),
&[1.0, 0.0, -1.0 / 6.0, 0.0, 1.0 / 120.0, 0.0],
);
assert!(series(e, x, p.integer(0), 6, &p).is_ok());
assert_eq!(take_series_refusal(), None);
}
#[test]
fn tan_over_x_expands_through_its_removable_singularity() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let t = p.func("tan", vec![x]);
let e = p.mul(vec![t, p.pow(x, p.integer(-1))]);
assert_close(
&coeff_values(e, x, p.integer(0), 5, &p),
&[1.0, 0.0, 1.0 / 3.0, 0.0, 2.0 / 15.0],
);
}
#[test]
fn matched_double_zeros_cancel() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let c = p.func("cos", vec![x]);
let n = p.add(vec![p.integer(1), p.mul(vec![p.integer(-1), c])]);
let e = p.mul(vec![n, p.pow(x, p.integer(-2))]);
assert_close(
&coeff_values(e, x, p.integer(0), 5, &p),
&[0.5, 0.0, -1.0 / 24.0, 0.0, 1.0 / 720.0],
);
}
#[test]
fn a_sum_of_cancelling_poles_expands() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let s = p.func("sin", vec![x]);
let e = p.add(vec![
p.pow(x, p.integer(-1)),
p.mul(vec![p.integer(-1), p.pow(s, p.integer(-1))]),
]);
let exp = local_expansion(e, x, p.integer(0), 5, &p).unwrap();
assert_eq!(exp.valuation, 1);
assert_close(
&coeff_values(e, x, p.integer(0), 5, &p),
&[-1.0 / 6.0, 0.0, -7.0 / 360.0, 0.0],
);
}
#[test]
fn a_singularity_that_cancels_outright_expands() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let n = p.add(vec![p.pow(x, p.integer(2)), p.integer(-1)]);
let d = p.add(vec![x, p.integer(-1)]);
let e = p.mul(vec![n, p.pow(d, p.integer(-1))]);
assert_close(
&coeff_values(e, x, p.integer(1), 4, &p),
&[2.0, 1.0, 0.0, 0.0],
);
}
#[test]
fn a_real_pole_keeps_its_principal_part() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let s = p.func("sin", vec![x]);
let e = p.pow(s, p.integer(-1));
let exp = local_expansion(e, x, p.integer(0), 5, &p).unwrap();
assert_eq!(exp.valuation, -1);
let env = HashMap::new();
let vals: Vec<f64> = exp
.coeffs
.iter()
.map(|&c| crate::jit::eval_interp(c, &env, &p).unwrap_or(f64::NAN))
.collect();
assert_close(&vals, &[1.0, 0.0, 1.0 / 6.0, 0.0, 7.0 / 360.0]);
}
#[test]
fn a_symbolic_parameter_survives_the_repair() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let k = p.symbol("k", Domain::Real);
let s = p.func("sin", vec![p.mul(vec![k, x])]);
let e = p.mul(vec![s, p.pow(x, p.integer(-1))]);
let exp = local_expansion(e, x, p.integer(0), 3, &p).unwrap();
assert_eq!(exp.valuation, 0);
let mut env = HashMap::new();
env.insert(k, 2.0);
let vals: Vec<f64> = exp
.coeffs
.iter()
.map(|&c| crate::jit::eval_interp(c, &env, &p).unwrap_or(f64::NAN))
.collect();
assert_close(&vals, &[2.0, 0.0, -8.0 / 6.0]);
assert!(series(e, x, p.integer(0), 3, &p).is_ok());
assert_eq!(take_series_refusal(), None);
}
fn assert_refuses_as_indeterminate(expr: ExprId, var: ExprId, order: u32, p: &ExprPool) {
use crate::errors::AlkahestError;
let err = series(expr, var, p.integer(0), order, p)
.err()
.unwrap_or_else(|| panic!("expected a refusal, got a Series"));
assert!(matches!(err, SeriesError::InvalidOrder), "{err:?}");
let refusal = take_series_refusal().expect("indeterminate-coefficient refusal recorded");
assert_eq!(refusal.code(), "E-SERIES-004");
assert_eq!(
refusal.cause(),
SeriesRefusalCause::IndeterminateCoefficient
);
}
#[test]
fn a_singularity_with_no_laurent_expansion_is_refused() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let inv_x = p.pow(x, p.integer(-1));
let log_x = p.func("log", vec![x]);
assert_refuses_as_indeterminate(p.func("sqrt", vec![x]), x, 4, &p);
assert_refuses_as_indeterminate(log_x, x, 4, &p);
assert_refuses_as_indeterminate(p.mul(vec![x, log_x]), x, 4, &p);
assert_refuses_as_indeterminate(p.mul(vec![log_x, inv_x]), x, 4, &p);
assert_refuses_as_indeterminate(p.func("exp", vec![inv_x]), x, 4, &p);
assert_refuses_as_indeterminate(p.func("sin", vec![inv_x]), x, 4, &p);
let x_sin_inv = p.mul(vec![x, p.func("sin", vec![inv_x])]);
assert_refuses_as_indeterminate(x_sin_inv, x, 4, &p);
let x_to_x = p.func("exp", vec![p.mul(vec![x, log_x])]);
assert_refuses_as_indeterminate(x_to_x, x, 3, &p);
let sqrt_sin = p.func("sqrt", vec![p.func("sin", vec![x])]);
assert_refuses_as_indeterminate(sqrt_sin, x, 4, &p);
}
#[test]
fn a_free_parameter_does_not_hide_an_indeterminate_coefficient() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let k = p.symbol("k", Domain::Real);
let sqrt_x = p.func("sqrt", vec![x]);
assert_refuses_as_indeterminate(p.mul(vec![k, sqrt_x]), x, 3, &p);
assert_refuses_as_indeterminate(p.mul(vec![k, p.func("log", vec![x])]), x, 3, &p);
let k_sqrt_sin = p.mul(vec![k, sqrt_x, p.func("sin", vec![x])]);
assert_refuses_as_indeterminate(k_sqrt_sin, x, 4, &p);
let k_over_x = p.mul(vec![k, p.pow(x, p.integer(-1))]);
assert!(series(k_over_x, x, p.integer(0), 3, &p).is_ok());
assert_eq!(take_series_refusal(), None);
}
#[test]
fn no_successful_series_ever_carries_an_indeterminate_coefficient() {
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let zero = p.integer(0);
let one = p.integer(1);
let inv_x = p.pow(x, p.integer(-1));
let sin_x = p.func("sin", vec![x]);
let cos_x = p.func("cos", vec![x]);
let exp_x = p.func("exp", vec![x]);
let log_x = p.func("log", vec![x]);
let x_minus_1 = p.add(vec![x, p.integer(-1)]);
let one_minus_cos = p.add(vec![one, p.mul(vec![p.integer(-1), cos_x])]);
let cases: Vec<(ExprId, ExprId, u32)> = vec![
(p.mul(vec![sin_x, inv_x]), zero, 6),
(p.mul(vec![p.func("tan", vec![x]), inv_x]), zero, 5),
(p.mul(vec![p.func("sinh", vec![x]), inv_x]), zero, 5),
(p.mul(vec![p.func("atan", vec![x]), inv_x]), zero, 5),
(p.mul(vec![one_minus_cos, p.pow(x, p.integer(-2))]), zero, 5),
(
p.mul(vec![p.add(vec![exp_x, p.integer(-1)]), inv_x]),
zero,
5,
),
(p.mul(vec![x, p.pow(sin_x, p.integer(-1))]), zero, 5),
(
p.mul(vec![p.pow(sin_x, p.integer(2)), p.pow(x, p.integer(-2))]),
zero,
5,
),
(
p.add(vec![
inv_x,
p.mul(vec![p.integer(-1), p.pow(sin_x, p.integer(-1))]),
]),
zero,
5,
),
(inv_x, zero, 4),
(p.pow(x, p.integer(-2)), zero, 4),
(p.pow(sin_x, p.integer(-1)), zero, 5),
(p.mul(vec![cos_x, p.pow(sin_x, p.integer(-1))]), zero, 5),
(p.mul(vec![sin_x, p.pow(x, p.integer(-3))]), zero, 5),
(p.pow(one_minus_cos, p.integer(-1)), zero, 4),
(p.pow(p.func("tan", vec![x]), p.integer(-1)), zero, 4),
(exp_x, one, 5),
(log_x, one, 5),
(p.func("sqrt", vec![x]), one, 4),
(p.pow(log_x, p.integer(-1)), one, 4),
(
p.mul(vec![
p.func("sqrt", vec![x]),
p.pow(x_minus_1, p.integer(-1)),
]),
one,
4,
),
(
p.pow(
p.add(vec![p.pow(x, p.integer(2)), p.integer(-1)]),
p.integer(-1),
),
one,
4,
),
(
p.mul(vec![
p.add(vec![p.pow(x, p.integer(2)), p.integer(-1)]),
p.pow(x_minus_1, p.integer(-1)),
]),
one,
4,
),
(p.func("sqrt", vec![x]), zero, 4),
(log_x, zero, 4),
(p.func("exp", vec![inv_x]), zero, 4),
(p.func("sin", vec![inv_x]), zero, 4),
(p.func("gamma", vec![x]), zero, 3),
(exp_x, zero, 6),
(
p.pow(
p.add(vec![one, p.mul(vec![p.integer(-1), x])]),
p.integer(-1),
),
zero,
6,
),
(p.func("sqrt", vec![p.add(vec![one, x])]), zero, 5),
(p.func("tan", vec![x]), zero, 8),
];
let env = HashMap::new();
for (i, &(e, point, order)) in cases.iter().enumerate() {
let Ok(s) = series(e, x, point, order, &p) else {
let _ = take_series_refusal();
continue;
};
assert_eq!(take_series_refusal(), None, "case {i}: refusal left behind");
let mut stack = match p.get(s.expr()) {
ExprData::Add(xs) => xs,
_ => vec![s.expr()],
};
while let Some(t) = stack.pop() {
if matches!(p.get(t), ExprData::BigO(_)) {
continue;
}
assert!(
!contains_zero_to_negative_power(t, &p),
"case {i}: {} contains 0^-n",
p.display(s.expr())
);
if let Some(v) = crate::jit::eval_interp(t, &env, &p) {
assert!(
v.is_finite(),
"case {i}: term {} of {} evaluates to {v}",
p.display(t),
p.display(s.expr())
);
}
match p.get(t) {
ExprData::Add(xs) | ExprData::Mul(xs) => stack.extend(xs),
ExprData::Pow { base, exp } => {
stack.push(base);
stack.push(exp);
}
ExprData::Func { args, .. } => stack.extend(args),
_ => {}
}
}
}
}
#[test]
fn the_repair_agrees_with_the_limit_engine() {
use crate::calculus::limits::{limit, LimitDirection};
let p = ExprPool::new();
let x = p.symbol("x", Domain::Real);
let e = sin_over_x(&p);
let l = limit(e, x, p.integer(0), LimitDirection::Bidirectional, &p).unwrap();
assert_eq!(crate::jit::eval_interp(l, &HashMap::new(), &p), Some(1.0));
}
}