yarer 0.2.0

Yarer (Yet Another Rust Expression Resolver) is a library for resolving mathematical expressions. Internally it uses the shunting yard algorithm.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
use crate::{
    parser::Parser,
    session::Session,
    token::{self, MathFunction, Number, Operator, Token},
};
use anyhow::anyhow;
use log::debug;
use num::{Integer, Signed};
use statrs::distribution::{Continuous, ContinuousCDF, Normal};
use std::{
    cell::RefCell,
    collections::{HashMap, VecDeque},
    fmt::Display,
    rc::Rc,
};

use num::{BigInt, BigUint, One, Zero};
use num_rational::BigRational;
use num_traits::ToPrimitive;

static MALFORMED_ERR: &str = "Runtime Error: The mathematical expression is malformed.";
static DIVISION_ZERO_ERR: &str = "Runtime error: Divide by zero.";
static NO_VARIABLE_ERR: &str = "Runtime error: No variable has been defined for assignment.";
static FACTORIAL_NATURAL_ERR: &str =
    "Runtime error: Factorial is only defined for non-negative integers.";
static BUILTIN_CONSTANT_ERR: &str = "Runtime error: Built-in constants are read-only.";
static INVALID_FUNCTION_RESULT_ERR: &str = "Runtime error: Function result is not a real number.";
static INVALID_POWER_ERR: &str = "Runtime error: Invalid power operation.";
static FLOAT_EVAL_TOO_LARGE_ERR: &str =
    "Runtime error: Operand is too large for floating-point evaluation.";
static POWER_TOO_LARGE_ERR: &str =
    "Runtime error: Power operands are too large for non-integer evaluation.";

/// The main [`RpnResolver`] contains the core logic of Yarer
/// for parsing and evaluating a math expression.
///
/// It holds the tokenised expression (by the [`Parser`]) and
/// a heap of local variables borrowed from a [`Session`]
///
pub struct RpnResolver<'a> {
    rpn_expr: VecDeque<Token<'a>>,
    local_heap: Rc<RefCell<HashMap<String, Number>>>,
    build_error: Option<String>,
}

impl RpnResolver<'_> {
    /// Generates a new [`RpnResolver`] instance with borrowed heap
    ///
    pub fn parse_with_borrowed_heap<'a>(
        exp: &'a str,
        borrowed_heap: Rc<RefCell<HashMap<String, Number>>>,
    ) -> RpnResolver<'a> {
        let heap_for_parse = Rc::clone(&borrowed_heap);
        match Parser::parse(exp).and_then(|tokenised_expr| {
            RpnResolver::reverse_polish_notation(&tokenised_expr, heap_for_parse)
        }) {
            Ok((rpn_expr, local_heap)) => RpnResolver {
                rpn_expr,
                local_heap,
                build_error: None,
            },
            Err(err) => RpnResolver {
                rpn_expr: VecDeque::new(),
                local_heap: borrowed_heap,
                build_error: Some(err.to_string()),
            },
        }
    }

    /// This method evaluates the rpn expression stack
    ///
    pub fn resolve(&mut self) -> anyhow::Result<Number> {
        if let Some(build_error) = &self.build_error {
            return Err(anyhow!(build_error.clone()));
        }

        let zero: Number = Number::NaturalNumber(Zero::zero());
        let minus_one: Number = Number::NaturalNumber(BigInt::from(-1));

        let mut result_stack: VecDeque<Number> = VecDeque::new();
        let mut var_stack: VecDeque<Option<String>> = VecDeque::new();
        let mut last_result: Option<Number> = None;

        for t in &self.rpn_expr {
            match t {
                Token::Operand(n) => {
                    result_stack.push_back(n.clone());
                    var_stack.push_back(None);
                }
                Token::Operator(op) => {
                    let right_value: Number = result_stack
                        .pop_back()
                        .ok_or_else(|| anyhow!("{} {}", MALFORMED_ERR, "Invalid Right Operand."))?;

                    var_stack.pop_back();

                    let left_value = if op != &Operator::Une && op != &Operator::Fac {
                        result_stack.pop_back().ok_or_else(|| {
                            anyhow!("{} {}", MALFORMED_ERR, "Invalid Left Operand.")
                        })?
                    } else {
                        zero.clone()
                    };
                    let left_var = if op != &Operator::Une && op != &Operator::Fac {
                        var_stack.pop_back().unwrap_or(None)
                    } else {
                        None
                    };

                    match op {
                        Operator::Add => {
                            result_stack.push_back(left_value + right_value);
                            var_stack.push_back(None);
                        }
                        Operator::Sub => {
                            result_stack.push_back(left_value - right_value);
                            var_stack.push_back(None);
                        }
                        Operator::Mul => {
                            result_stack.push_back(left_value * right_value);
                            var_stack.push_back(None);
                        }
                        Operator::Div => {
                            if right_value == zero {
                                return Err(anyhow!(DIVISION_ZERO_ERR));
                            }
                            result_stack.push_back(left_value / right_value);
                            var_stack.push_back(None);
                        }
                        Operator::Pow => {
                            result_stack.push_back(Self::power(left_value, right_value)?);
                            var_stack.push_back(None);
                        }
                        Operator::Eql => {
                            if let Some(var) = left_var {
                                if Session::is_constant_name(&var) {
                                    return Err(anyhow!(BUILTIN_CONSTANT_ERR));
                                }
                                self.local_heap
                                    .borrow_mut()
                                    .insert(var.clone(), right_value.clone());

                                result_stack.push_back(right_value);
                                var_stack.push_back(None);
                            } else {
                                return Err(anyhow!(NO_VARIABLE_ERR));
                            }
                        }
                        Operator::Fac => {
                            // factorial. Only for non-negative integers
                            match right_value {
                                Number::NaturalNumber(v) => {
                                    if v < Zero::zero() {
                                        return Err(anyhow!(FACTORIAL_NATURAL_ERR));
                                    }
                                    let n = v.to_u64().ok_or_else(|| {
                                        anyhow!("Runtime Error: Factorial operand is too large")
                                    })?;
                                    let res = Self::factorial_helper(n.into());
                                    result_stack.push_back(Number::NaturalNumber(res.into()));
                                    var_stack.push_back(None);
                                }
                                Number::DecimalNumber(_) => {
                                    return Err(anyhow!(FACTORIAL_NATURAL_ERR));
                                }
                            }
                        }
                        Operator::Une => {
                            //# unary neg
                            result_stack.push_back(right_value * minus_one.clone());
                            var_stack.push_back(None);
                        }
                    }
                }
                Token::Variable(v) => {
                    let var_name = v.to_lowercase();
                    debug!("Heap {:?}", self.local_heap);
                    let heap = self.local_heap.borrow();
                    let n = heap
                        .get(&var_name)
                        .cloned()
                        .unwrap_or_else(|| Number::NaturalNumber(BigInt::zero()));
                    result_stack.push_back(n);
                    var_stack.push_back(Some(var_name));
                }
                Token::Function(fun) => {
                    let value: Number = result_stack.pop_back().ok_or(anyhow!(
                        "{} {}",
                        MALFORMED_ERR,
                        "Wrong use of function"
                    ))?;
                    var_stack.pop_back();

                    let result = match fun {
                        MathFunction::Sin => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.sin(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Cos => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.cos(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Tan => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.tan(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::ASin => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.asin(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::ACos => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.acos(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::ATan => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.atan(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Ln => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.ln(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Log => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.log10(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Abs => Self::to_decimal_number(match value {
                            Number::NaturalNumber(v) => Number::NaturalNumber(v.abs()),
                            Number::DecimalNumber(v) => Number::DecimalNumber(v.abs()),
                        }),
                        MathFunction::Max => {
                            let value2: Number = result_stack.pop_back().ok_or(anyhow!(
                                "{} {}",
                                MALFORMED_ERR,
                                "Wrong number of parameters for function Max"
                            ))?;
                            var_stack.pop_back();
                            Self::to_decimal_number(if value >= value2 { value } else { value2 })
                        }
                        MathFunction::Min => {
                            let value2: Number = result_stack.pop_back().ok_or(anyhow!(
                                "{} {}",
                                MALFORMED_ERR,
                                "Wrong number of parameters for function Min"
                            ))?;
                            var_stack.pop_back();
                            Self::to_decimal_number(if value <= value2 { value } else { value2 })
                        }
                        MathFunction::Sqrt => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.sqrt(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::Floor => {
                            let value = Self::number_to_rational(value);
                            Self::to_decimal_number(Number::NaturalNumber(
                                value.numer().div_floor(value.denom()),
                            ))
                        }
                        MathFunction::Ceil => {
                            let value = Self::number_to_rational(value);
                            Self::to_decimal_number(Number::NaturalNumber(
                                value.numer().div_ceil(value.denom()),
                            ))
                        }
                        MathFunction::Round => {
                            let value = Self::number_to_rational(value);
                            let denom = value.denom().clone();
                            let doubled_numer = value.numer().clone() * BigInt::from(2_u8);
                            let doubled_denom = denom.clone() * BigInt::from(2_u8);
                            let rounded = if doubled_numer >= BigInt::zero() {
                                (doubled_numer + denom).div_floor(&doubled_denom)
                            } else {
                                (doubled_numer - denom).div_ceil(&doubled_denom)
                            };
                            Self::to_decimal_number(Number::NaturalNumber(rounded))
                        }
                        MathFunction::Pdf => {
                            let normal = Normal::new(0.0, 1.0).expect("valid normal dist");
                            Self::decimal_from_f64(
                                normal.pdf(Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?),
                                INVALID_FUNCTION_RESULT_ERR,
                            )?
                        }
                        MathFunction::Cdf => {
                            let normal = Normal::new(0.0, 1.0).expect("valid normal dist");
                            Self::decimal_from_f64(
                                normal.cdf(Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?),
                                INVALID_FUNCTION_RESULT_ERR,
                            )?
                        }
                        MathFunction::Exp => Self::decimal_from_f64(
                            Self::number_to_f64(&value, FLOAT_EVAL_TOO_LARGE_ERR)?.exp(),
                            INVALID_FUNCTION_RESULT_ERR,
                        )?,
                        MathFunction::None => return Err(anyhow!("This should never happen!")),
                    };
                    result_stack.push_back(result);
                    var_stack.push_back(None);
                }
                Token::SemiColon => {
                    // A chained segment just ended. A well-formed segment leaves exactly
                    // one value on the stack; capture it as the running result, then reset
                    // for the next segment. An empty segment (e.g. a leading ';') is a no-op.
                    if !result_stack.is_empty() {
                        if result_stack.len() != 1 {
                            return Err(anyhow!(MALFORMED_ERR));
                        }
                        last_result = result_stack.pop_back();
                    }
                    result_stack.clear();
                    var_stack.clear();
                }
                _ => {
                    return Err(anyhow!(
                        "{} Internal Error at line: {}.",
                        MALFORMED_ERR,
                        line!()
                    ))
                }
            }
        }

        // A trailing ';' leaves the working stack empty: fall back to the last
        // completed segment's value rather than reporting a spurious error.
        if result_stack.is_empty() {
            return last_result.ok_or_else(|| anyhow!(MALFORMED_ERR));
        }

        if result_stack.len() != 1 || var_stack.len() != 1 {
            return Err(anyhow!(MALFORMED_ERR));
        }

        result_stack.pop_back().ok_or(anyhow!("{}", MALFORMED_ERR))
    }

    /// Transforming an infix notation to Reverse Polish Notation (RPN)
    ///
    /// Example
    /// ``
    ///     "3 * 4 + 5 * 6" becomes "3 4 * 5 6 * +"
    /// ``
    fn reverse_polish_notation<'a>(
        infix_stack: &[Token<'a>],
        local_heap: Rc<RefCell<HashMap<String, Number>>>,
    ) -> anyhow::Result<(VecDeque<Token<'a>>, Rc<RefCell<HashMap<String, Number>>>)> {
        /*  Create an empty stack for keeping operators. Create an empty list for output. */
        let mut operators_stack: Vec<Token> = Vec::new();
        let mut postfix_stack: VecDeque<Token> = VecDeque::new();
        let mut seen_variables: Vec<String> = Vec::new();

        /* Scan the infix expression from left to right. */
        for t in infix_stack {
            match *t {
                /* If the token is an operand, add it to the output list. */
                Token::Operand(_) => postfix_stack.push_back(t.clone()),

                /* If the token is a left parenthesis, push it on the stack. */
                Token::Bracket(token::Bracket::Open) => operators_stack.push(t.clone()),

                /* If the token is a right parenthesis:
                Pop the stack and add operators to the output list until you encounter a left parenthesis.
                Pop the left parenthesis from the stack but do not add it to the output list.*/
                Token::Bracket(token::Bracket::Close) => {
                    let mut found_open = false;
                    while let Some(token) = operators_stack.pop() {
                        match token {
                            Token::Bracket(token::Bracket::Open) => {
                                found_open = true;
                                // If the token is a left parenthesis, pop it from the stack
                                if let Some(Token::Function(_)) = operators_stack.last() {
                                    postfix_stack.push_back(
                                        operators_stack.pop().expect("It should not happen."),
                                    );
                                }
                                break;
                            } // discards left parenthesis
                            _ => postfix_stack.push_back(token),
                        }
                    }
                    if !found_open {
                        return Err(anyhow!(MALFORMED_ERR));
                    }
                }

                Token::Comma => {
                    let mut found_open = false;
                    while let Some(token) = operators_stack.last() {
                        if matches!(token, Token::Bracket(token::Bracket::Open)) {
                            found_open = true;
                            break;
                        }
                        postfix_stack
                            .push_back(operators_stack.pop().expect("It should not happen."));
                    }
                    if !found_open {
                        return Err(anyhow!(MALFORMED_ERR));
                    }
                }

                Token::SemiColon => {
                    while let Some(token) = operators_stack.pop() {
                        postfix_stack.push_back(token);
                    }
                    postfix_stack.push_back(Token::SemiColon);
                }

                Token::Operator(_op) => {
                    let op1: Token<'_> = t.clone();

                    while !operators_stack.is_empty() {
                        let op2: &Token = operators_stack.last().unwrap();
                        match op2 {
                            Token::Operator(_) => {
                                if Token::compare_operator_priority(op1.clone(), op2.clone()) {
                                    postfix_stack.push_back(
                                        operators_stack.pop().expect("It should not happen."),
                                    );
                                } else {
                                    break;
                                }
                            }
                            Token::Function(_) => {
                                postfix_stack.push_back(
                                    operators_stack.pop().expect("It should not happen."),
                                );
                            }
                            _ => break,
                        }
                    }
                    operators_stack.push(op1.clone());
                }

                Token::Function(_) => {
                    operators_stack.push(t.clone());
                }

                /* If the token is a variable, add it to the output list and to the local_heap with a default value*/
                Token::Variable(s) => {
                    postfix_stack.push_back(t.clone());
                    seen_variables.push(s.to_lowercase());
                }
            }
            debug!(
                "Inspecting... {} - OUT {} - OP - {}",
                *t,
                DisplayThisDeque(&postfix_stack),
                DisplayThatVec(&operators_stack)
            );
        }

        /* After all tokens are read, pop remaining operators from the stack and add them to the list. */
        operators_stack.reverse();
        for t in &operators_stack {
            if matches!(t, Token::Bracket(_)) {
                return Err(anyhow!(MALFORMED_ERR));
            }
            postfix_stack.push_back(t.clone());
        }

        let mut heap = local_heap.borrow_mut();
        for variable in seen_variables {
            heap.entry(variable)
                .or_insert(Number::NaturalNumber(Zero::zero()));
        }
        drop(heap);

        debug!(
            "DEBUG: EOF - OUT {} - OP - {}",
            DisplayThisDeque(&postfix_stack),
            DisplayThatVec(&operators_stack)
        );

        Ok((postfix_stack, local_heap))
    }

    fn factorial_helper(n: BigUint) -> BigUint {
        let mut acc = BigUint::one();
        let mut current = BigUint::one();

        while current <= n {
            acc *= &current;
            current += BigUint::one();
        }

        acc
    }

    fn number_to_f64(value: &Number, error_message: &'static str) -> anyhow::Result<f64> {
        match value {
            Number::NaturalNumber(v) => v.to_f64().ok_or_else(|| anyhow!(error_message)),
            Number::DecimalNumber(v) => v.to_f64().ok_or_else(|| anyhow!(error_message)),
        }
    }

    fn decimal_from_f64(value: f64, error_message: &'static str) -> anyhow::Result<Number> {
        if !value.is_finite() {
            return Err(anyhow!(error_message));
        }

        BigRational::from_float(value)
            .map(Number::DecimalNumber)
            .ok_or_else(|| anyhow!(error_message))
    }

    fn number_to_rational(value: Number) -> BigRational {
        match value {
            Number::NaturalNumber(v) => BigRational::from_integer(v),
            Number::DecimalNumber(v) => v,
        }
    }

    fn to_decimal_number(value: Number) -> Number {
        match value {
            Number::NaturalNumber(v) => Number::DecimalNumber(BigRational::from_integer(v)),
            Number::DecimalNumber(v) => Number::DecimalNumber(v),
        }
    }

    fn integer_exponent(value: &Number) -> Option<BigInt> {
        match value {
            Number::NaturalNumber(v) => Some(v.clone()),
            Number::DecimalNumber(v) if v.denom().is_one() => Some(v.to_integer()),
            Number::DecimalNumber(_) => None,
        }
    }

    fn power(left_value: Number, right_value: Number) -> anyhow::Result<Number> {
        if let Some(exponent) = Self::integer_exponent(&right_value) {
            return Self::power_integer(left_value, exponent);
        }

        let base = Self::number_to_f64(&left_value, POWER_TOO_LARGE_ERR)?;
        let exponent = Self::number_to_f64(&right_value, POWER_TOO_LARGE_ERR)?;
        Self::decimal_from_f64(base.powf(exponent), INVALID_POWER_ERR)
    }

    fn power_integer(base: Number, exponent: BigInt) -> anyhow::Result<Number> {
        if exponent.is_zero() {
            return Ok(Number::NaturalNumber(BigInt::one()));
        }

        let is_negative = exponent < BigInt::zero();
        let magnitude = if is_negative { -exponent } else { exponent };
        let exponent = magnitude
            .to_biguint()
            .ok_or_else(|| anyhow!(INVALID_POWER_ERR))?;

        match base {
            Number::NaturalNumber(base) => {
                if is_negative {
                    if base.is_zero() {
                        return Err(anyhow!(DIVISION_ZERO_ERR));
                    }

                    let value = Self::pow_big_int(base, exponent);
                    Ok(Number::DecimalNumber(BigRational::new(
                        BigInt::one(),
                        value,
                    )))
                } else {
                    Ok(Number::NaturalNumber(Self::pow_big_int(base, exponent)))
                }
            }
            Number::DecimalNumber(base) => {
                if is_negative && base.is_zero() {
                    return Err(anyhow!(DIVISION_ZERO_ERR));
                }

                let value = Self::pow_big_rational(base, exponent);
                if is_negative {
                    Ok(Number::DecimalNumber(value.recip()))
                } else {
                    Ok(Number::DecimalNumber(value))
                }
            }
        }
    }

    fn pow_big_int(mut base: BigInt, mut exponent: BigUint) -> BigInt {
        let mut result = BigInt::one();

        while !exponent.is_zero() {
            if exponent.is_odd() {
                result *= &base;
            }
            exponent >>= 1_usize;
            if !exponent.is_zero() {
                base = &base * &base;
            }
        }

        result
    }

    fn pow_big_rational(mut base: BigRational, mut exponent: BigUint) -> BigRational {
        let mut result = BigRational::from_integer(BigInt::one());

        while !exponent.is_zero() {
            if exponent.is_odd() {
                result *= &base;
            }
            exponent >>= 1_usize;
            if !exponent.is_zero() {
                base = &base * &base;
            }
        }

        result
    }
}

struct DisplayThatVec<'a>(&'a Vec<Token<'a>>);
struct DisplayThisDeque<'a>(&'a VecDeque<Token<'a>>);

impl Display for DisplayThatVec<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            self.0.iter().map(ToString::to_string).collect::<String>()
        )
    }
}

impl Display for DisplayThisDeque<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            self.0.iter().map(ToString::to_string).collect::<String>()
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        session::Session,
        token::{Number, Operator},
    };
    use num_bigint::{BigInt, BigUint};

    #[test]
    fn test_reverse_polish_notation() {
        let a: Vec<Token> = vec![
            Token::Operand(Number::NaturalNumber(BigInt::from(1u8))),
            Token::Operator(Operator::Add),
            Token::Operand(Number::NaturalNumber(BigInt::from(2u8))),
        ];
        let b: Vec<Token> = vec![
            Token::Operand(Number::NaturalNumber(BigInt::from(1u8))),
            Token::Operand(Number::NaturalNumber(BigInt::from(2u8))),
            Token::Operator(Operator::Add),
        ];
        assert_eq!(
            RpnResolver::reverse_polish_notation(&a, Rc::new(RefCell::new(HashMap::new())))
                .unwrap()
                .0,
            b
        );
    }

    #[test]
    fn test_factorial() {
        assert_eq!(
            RpnResolver::factorial_helper(BigUint::from(5u8)),
            BigUint::from(120u16)
        );
    }

    #[test]
    fn test_resolve() {
        let mut resolver = RpnResolver {
            rpn_expr: VecDeque::from(vec![
                Token::Operand(Number::NaturalNumber(BigInt::from(1u8))),
                Token::Operand(Number::NaturalNumber(BigInt::from(2u8))),
                Token::Operator(Operator::Add),
            ]),
            local_heap: Rc::new(RefCell::new(HashMap::new())),
            build_error: None,
        };
        assert_eq!(
            resolver.resolve().unwrap(),
            Number::NaturalNumber(BigInt::from(3u8))
        );
    }

    #[test]
    fn test_invalid_factorial() {
        let session = Session::init();
        let mut resolver = session.process("(-1)!");
        assert!(resolver.resolve().is_err());
        let mut resolver2 = session.process("1.5!");
        assert!(resolver2.resolve().is_err());
    }

    #[test]
    fn test_max_min() {
        let session = Session::init();
        let mut resolver = session.process("max(1,2)");
        assert_eq!(
            resolver.resolve().unwrap(),
            Number::DecimalNumber(BigRational::from_float(2.0).unwrap())
        );

        let mut resolver = session.process("min(1,2)");
        assert_eq!(
            resolver.resolve().unwrap(),
            Number::DecimalNumber(BigRational::from_float(1.0).unwrap())
        );

        let mut resolver = session.process("min(max(1,2),3)");
        assert_eq!(
            resolver.resolve().unwrap(),
            Number::DecimalNumber(BigRational::from_float(2.0).unwrap())
        );
    }
}