ganit-core 0.4.1

Spreadsheet formula engine — parser and evaluator for Excel-compatible formulas
Documentation
use crate::eval::coercion::to_number;
use crate::eval::functions::check_arity;
use crate::types::{ErrorKind, Value};

fn opt_number(args: &[Value], idx: usize, default: f64) -> Result<f64, Value> {
    if idx < args.len() {
        to_number(args[idx].clone())
    } else {
        Ok(default)
    }
}

/// `NPER(rate, pmt, pv, [fv], [type])` — number of periods.
pub fn nper_fn(args: &[Value]) -> Value {
    if let Some(err) = check_arity(args, 3, 5) {
        return err;
    }
    let rate = match to_number(args[0].clone()) { Ok(n) => n, Err(e) => return e };
    let pmt  = match to_number(args[1].clone()) { Ok(n) => n, Err(e) => return e };
    let pv   = match to_number(args[2].clone()) { Ok(n) => n, Err(e) => return e };
    let fv   = match opt_number(args, 3, 0.0)   { Ok(n) => n, Err(e) => return e };
    let typ  = match opt_number(args, 4, 0.0)   { Ok(n) => n, Err(e) => return e };

    let result = if rate == 0.0 {
        if pmt == 0.0 {
            return Value::Error(ErrorKind::DivByZero);
        }
        -(pv + fv) / pmt
    } else {
        let adjusted_pmt = pmt * (1.0 + rate * typ);
        let numerator   = adjusted_pmt - fv * rate;
        let denominator = pv * rate + adjusted_pmt;
        if denominator == 0.0 {
            return Value::Error(ErrorKind::Num);
        }
        let ratio = numerator / denominator;
        if ratio <= 0.0 {
            return Value::Error(ErrorKind::Num);
        }
        ratio.ln() / (1.0 + rate).ln()
    };

    if !result.is_finite() {
        return Value::Error(ErrorKind::Num);
    }
    Value::Number(result)
}

#[cfg(test)]
mod tests;