reform 0.1.0

A symbolic manipulation toolkit which aims to handle expressions with billions of terms, taking up terabytes of diskspace.
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
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use num_traits::{One, Zero};
use number::Number;
use poly::raw::MultivariatePolynomial;
use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::fmt;
use std::hash::{Hash, Hasher};
use std::io::{Error, Read, Write};
use std::mem;
use std::ops::{Add, Div, Mul, Neg, Sub};
use structure::{fmt_varname, Element, GlobalVarInfo, VarName};
use tools::GCD;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Polynomial {
    varcount: usize,
    varmap: HashMap<VarName, usize>, // map from names to internal name
    inv_varmap: Vec<VarName>,
    pub poly: MultivariatePolynomial<Number, u32>,
}

impl Polynomial {
    pub fn new() -> Polynomial {
        Polynomial {
            poly: MultivariatePolynomial::new(),
            varmap: HashMap::new(),
            inv_varmap: vec![],
            varcount: 0,
        }
    }

    fn to_monomial(
        e: &Element,
        exp: &mut Vec<u32>,
        varmap: &mut HashMap<VarName, usize>,
        inv_varmap: &mut Vec<VarName>,
        varcount: &mut usize,
    ) -> Result<Number, String> {
        match *e {
            Element::Var(ref x, Number::SmallInt(e)) if e > 0 => {
                match varmap.entry(*x) {
                    Entry::Occupied(v) => {
                        exp[*v.get()] = e as u32;
                    }
                    Entry::Vacant(mut v) => {
                        v.insert(*varcount);
                        inv_varmap.push(*x);
                        *varcount += 1;
                        exp.push(e as u32);
                    }
                }

                Ok(Number::one())
            }
            Element::Num(_, ref nn) => Ok(nn.clone()),
            Element::Pow(_, ref p) => {
                let (ref b, ref ex) = **p;
                if let Element::Var(ref x, Number::SmallInt(ee1)) = *b {
                    if let Element::Num(_, Number::SmallInt(n)) = *ex {
                        if n > 0 {
                            match varmap.entry(*x) {
                                Entry::Occupied(v) => {
                                    exp[*v.get()] = (n * ee1) as u32;
                                }
                                Entry::Vacant(mut v) => {
                                    v.insert(*varcount);
                                    inv_varmap.push(*x);
                                    *varcount += 1;
                                    exp.push((n * ee1) as u32);
                                }
                            }
                            return Ok(Number::one());
                        }
                    }
                }
                Err(format!("{} not allowed in monomial", e))
            }
            Element::Term(_, ref args) => {
                let mut c = Number::one();
                for x in args {
                    c *= Polynomial::to_monomial(x, exp, varmap, inv_varmap, varcount)?;
                }
                Ok(c)
            }
            _ => Err(format!("{} not allowed in monomial", e)),
        }
    }

    pub fn from(e: &Element) -> Result<Polynomial, String> {
        let mut varcount = 0;
        let mut varmap = HashMap::new();
        let mut inv_varmap = vec![];

        match *e {
            Element::SubExpr(_, ref args) => {
                let mut monomials = Vec::with_capacity(args.len());
                for x in args {
                    let mut exp = vec![0; varcount];
                    let coeff = Polynomial::to_monomial(
                        x,
                        &mut exp,
                        &mut varmap,
                        &mut inv_varmap,
                        &mut varcount,
                    )?;
                    monomials.push((coeff, exp));
                }

                let mut poly = MultivariatePolynomial::with_nvars(varcount);

                for (c, mut e) in monomials {
                    if e.len() < varcount {
                        e.resize(varcount, 0);
                    }
                    poly.append_monomial(c, &e);
                }

                Ok(Polynomial {
                    poly,
                    varmap,
                    inv_varmap,
                    varcount,
                })
            }
            Element::Var(ref x, Number::SmallInt(e)) if e > 0 => {
                let mut exp = vec![e as u32];
                varmap.insert(*x, 0);
                inv_varmap.push(*x);
                Ok(Polynomial {
                    poly: MultivariatePolynomial::from_monomial(Number::one(), exp),
                    varmap: varmap,
                    inv_varmap: inv_varmap,
                    varcount: 1,
                })
            }
            Element::Num(_, ref nn) => Ok(Polynomial {
                poly: MultivariatePolynomial::from_constant_with_nvars(nn.clone(), 0),
                varmap: varmap,
                inv_varmap: inv_varmap,
                varcount: 0,
            }),
            Element::Term(..) | Element::Pow(..) => {
                let mut exp = vec![];
                let c = Polynomial::to_monomial(
                    e,
                    &mut exp,
                    &mut varmap,
                    &mut inv_varmap,
                    &mut varcount,
                )?;
                let mut poly = MultivariatePolynomial::from_monomial(c, exp);
                Ok(Polynomial {
                    poly,
                    varmap,
                    inv_varmap,
                    varcount,
                })
            }
            _ => Err(format!("{} not allowed in polynomial", e)),
        }
    }

    pub fn cloned_one(&self) -> Polynomial {
        Polynomial {
            poly: MultivariatePolynomial::from_constant_with_nvars(Number::one(), self.varcount),
            varmap: self.varmap.clone(),
            inv_varmap: self.inv_varmap.clone(),
            varcount: self.varcount,
        }
    }

    pub fn to_expression(self) -> Element {
        let mut terms = vec![];
        for v in self.poly.into_iter() {
            let mut factors = vec![];
            for (name, pow) in v.exponents.iter().enumerate() {
                if *pow >= 1 {
                    factors.push(Element::Var(
                        self.inv_varmap[name],
                        Number::SmallInt(*pow as isize),
                    ));
                }
            }

            factors.push(Element::Num(false, v.coefficient.clone()));
            terms.push(Element::Term(true, factors));
        }
        Element::SubExpr(true, terms)
    }

    /// Unify the variable maps between two polynomials
    pub fn unify_varmaps(&mut self, other: &mut Polynomial) {
        if self.varmap == other.varmap {
            return;
        }

        if self.varcount < other.varcount {
            return other.unify_varmaps(self);
        }

        let mut map = HashMap::new(); // index map

        let mut varcount = self.varcount;

        // merge 'other' map into self
        for (k1, v1) in &other.varmap {
            match self.varmap.entry(*k1) {
                Entry::Occupied(o) => {
                    map.insert(*v1, *o.get());
                }
                Entry::Vacant(mut v) => {
                    // new variable
                    self.inv_varmap.push(*k1);
                    map.insert(*v1, varcount);
                    v.insert(varcount);
                    varcount += 1;
                }
            }
        }

        if varcount > self.varcount {
            // we need to reconstruct the exponent in `self`
            let mut newexp = vec![0; varcount * self.poly.nterms];

            for t in 0..self.poly.nterms {
                newexp[t * varcount..t * varcount + self.varcount]
                    .copy_from_slice(self.poly.exponents(t));
            }

            self.poly.exponents = newexp;
            self.poly.nvars = varcount;
            self.varcount = varcount;
        }

        // reconstruct 'other' with correct monomial ordering
        let mut newother = MultivariatePolynomial::with_nvars(varcount);
        for t in 0..other.poly.nterms {
            let mut newexp = vec![0; varcount];
            for e in 0..other.varcount {
                newexp[*map.get(&e).unwrap()] = other.poly.exponents(t)[e];
            }
            newother.append_monomial(other.poly.coefficients[t].clone(), &newexp);
        }

        other.varmap = self.varmap.clone();
        other.inv_varmap = self.inv_varmap.clone();
        other.poly = newother;
        other.varcount = varcount;
    }

    fn fmt_output(&self, f: &mut fmt::Formatter, var_info: &GlobalVarInfo) -> fmt::Result {
        let mut is_first_term = true;
        for monomial in &self.poly {
            if monomial.coefficient.is_zero() {
                continue;
            }
            let mut is_first_factor = true;
            if monomial.coefficient.eq(&Number::one()) {
                if !is_first_term {
                    write!(f, "+")?;
                }
            } else if monomial.coefficient.eq(&Number::one().neg()) {
                write!(f, "-")?;
            } else {
                if is_first_term {
                    write!(f, "{}", monomial.coefficient)?;
                } else {
                    if monomial.coefficient < &Number::zero() {
                        write!(f, "{}", monomial.coefficient)?;
                    } else {
                        write!(f, "+{}", monomial.coefficient)?;
                    }
                }
                is_first_factor = false;
            }
            is_first_term = false;
            for (i, e) in monomial.exponents.into_iter().enumerate() {
                if e.is_zero() {
                    continue;
                }
                if is_first_factor {
                    is_first_factor = false;
                } else {
                    write!(f, "*")?;
                }
                fmt_varname(&self.inv_varmap[i], f, var_info)?;
                if !e.is_one() {
                    write!(f, "^{}", e)?;
                }
            }
            if is_first_factor {
                write!(f, "1")?;
            }
        }
        if is_first_term {
            write!(f, "0")?;
        }
        Ok(())
    }

    pub fn gcd(&mut self, b: &mut Polynomial) -> Polynomial {
        self.unify_varmaps(b);
        Polynomial {
            poly: MultivariatePolynomial::gcd(&self.poly, &b.poly),
            varmap: self.varmap.clone(),
            inv_varmap: self.inv_varmap.clone(),
            varcount: self.varcount.clone(),
        }
    }

    pub fn divmod(&mut self, div: &mut Polynomial) -> (Polynomial, Polynomial) {
        self.unify_varmaps(div);

        let (q, r) = self.poly.divmod(&div.poly);

        (
            Polynomial {
                poly: q,
                varmap: self.varmap.clone(),
                inv_varmap: self.inv_varmap.clone(),
                varcount: self.varcount.clone(),
            },
            Polynomial {
                poly: r,
                varmap: self.varmap.clone(),
                inv_varmap: self.inv_varmap.clone(),
                varcount: self.varcount.clone(),
            },
        )
    }
}

impl Hash for Polynomial {
    fn hash<H: Hasher>(&self, state: &mut H) {
        // we can skip the hashmap, since we simply use the inverse
        self.varcount.hash(state);
        self.inv_varmap.hash(state);
        self.poly.hash(state);
    }
}

impl Mul for Polynomial {
    type Output = Self;

    fn mul(mut self, mut other: Self) -> Self::Output {
        self.unify_varmaps(&mut other);

        Polynomial {
            poly: self.poly * &other.poly,
            varmap: self.varmap,
            inv_varmap: self.inv_varmap,
            varcount: self.varcount,
        }
    }
}

impl Mul<Number> for Polynomial {
    type Output = Self;

    fn mul(mut self, other: Number) -> Self::Output {
        for c in &mut self.poly.coefficients {
            *c *= other.clone();
        }
        self
    }
}

impl Div for Polynomial {
    type Output = Self;

    fn div(mut self, mut other: Self) -> Self::Output {
        self.unify_varmaps(&mut other);

        Polynomial {
            poly: self.poly.divmod(&other.poly).0,
            varmap: self.varmap,
            inv_varmap: self.inv_varmap,
            varcount: self.varcount,
        }
    }
}

impl Add for Polynomial {
    type Output = Self;

    fn add(mut self, mut other: Self) -> Self::Output {
        self.unify_varmaps(&mut other);

        Polynomial {
            poly: self.poly + other.poly,
            varmap: self.varmap,
            inv_varmap: self.inv_varmap,
            varcount: self.varcount,
        }
    }
}

impl Sub for Polynomial {
    type Output = Self;

    fn sub(mut self, mut other: Self) -> Self::Output {
        self.unify_varmaps(&mut other);

        Polynomial {
            poly: self.poly - other.poly,
            varmap: self.varmap,
            inv_varmap: self.inv_varmap,
            varcount: self.varcount,
        }
    }
}

impl Neg for Polynomial {
    type Output = Self;

    fn neg(self) -> Self::Output {
        Polynomial {
            poly: self.poly.neg(),
            varmap: self.varmap,
            inv_varmap: self.inv_varmap,
            varcount: self.varcount,
        }
    }
}

impl Zero for Polynomial {
    #[inline]
    fn zero() -> Self {
        Self::new()
    }

    #[inline]
    fn is_zero(&self) -> bool {
        self.poly.nterms == 0
    }
}

impl Polynomial {
    pub fn serialize(&self, buffer: &mut Write) -> usize {
        let len = 4 + self.inv_varmap.len() * 4;
        buffer
            .write_u32::<LittleEndian>(self.inv_varmap.len() as u32)
            .unwrap();
        for x in &self.inv_varmap {
            buffer.write_u32::<LittleEndian>(*x).unwrap();
        }

        len + self.poly.serialize(buffer)
    }

    pub fn deserialize(buffer: &mut Read) -> Result<Polynomial, Error> {
        let len = buffer.read_u32::<LittleEndian>().unwrap() as usize;
        let mut v = Vec::with_capacity(len);
        for _ in 0..len {
            v.push(buffer.read_u32::<LittleEndian>().unwrap());
        }

        let p = MultivariatePolynomial::deserialize(buffer)?;
        let mut hm = HashMap::new();
        for (i, x) in v.iter().enumerate() {
            hm.insert(*x, i);
        }
        Ok(Polynomial {
            poly: p,
            varmap: hm,
            inv_varmap: v,
            varcount: len,
        })
    }
}

pub struct PolyPrinter<'a> {
    pub poly: &'a Polynomial,
    pub var_info: &'a GlobalVarInfo,
}

impl<'a> fmt::Display for PolyPrinter<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.poly.fmt_output(f, self.var_info)
    }
}

/// Normalize a rational polynomial where `num` and `den` serve as
/// numerator and denominator. The gcd will be removed and
/// all the rational coefficients will be made integers.
pub fn rationalpolynomial_normalize(num: &mut Polynomial, den: &mut Polynomial) {
    num.unify_varmaps(den);

    // normalize all the coefficients by the lcm
    let mut norm = Number::one();

    for x in num.poly.coefficients.iter().chain(&den.poly.coefficients) {
        match x {
            Number::SmallRat(_, d) => {
                norm = (norm.clone() / GCD::gcd(norm, Number::SmallInt(*d))) * Number::SmallInt(*d);
            }
            Number::BigRat(i) => {
                norm = (norm.clone() / GCD::gcd(norm, Number::BigInt(i.denom().clone())))
                    * Number::BigInt(i.denom().clone());
            }
            _ => {}
        }
    }

    *num = mem::replace(num, Polynomial::new()) * norm.clone();
    *den = mem::replace(den, Polynomial::new()) * norm.clone();

    #[cfg(debug_assertions)]
    {
        // confirm that all fractions are gone
        for x in num.poly.coefficients.iter().chain(&den.poly.coefficients) {
            match x {
                Number::SmallRat(..) | Number::BigInt(..) => panic!(
                    "Fractions left in polynomial: {}; normalization: {}",
                    x, norm
                ),
                _ => {}
            }
        }
    }

    let mut g1 = num.gcd(den);
    *num = num.divmod(&mut g1).0;
    *den = den.divmod(&mut g1).0;
}

/// Add two rational polynomials: num/den+num1/den1
/// The function returns true iff the result is zero.
pub fn rationalpolynomial_add(
    num: &mut Polynomial,
    den: &mut Polynomial,
    num1: &mut Polynomial,
    den1: &mut Polynomial,
) -> bool {
    if den == den1 {
        *num = mem::replace(num, Polynomial::new()) + mem::replace(num1, Polynomial::new());
    } else {
        let mut g = den.gcd(den1);
        let scale = den1.divmod(&mut g).0;
        let scale1 = den.divmod(&mut g).0;
        *num = mem::replace(num, Polynomial::new()) * scale.clone()
            + mem::replace(num1, Polynomial::new()) * scale1;
        *den = mem::replace(den, Polynomial::new()) * scale;
    }

    let mut g1 = num.gcd(den);
    *num = num.divmod(&mut g1).0;
    *den = den.divmod(&mut g1).0;

    num.is_zero()
}

/// Subtract two rational polynomials: num/den-num1/den1
/// The function returns true iff the result is zero.
pub fn rationalpolynomial_sub(
    num: &mut Polynomial,
    den: &mut Polynomial,
    num1: &mut Polynomial,
    den1: &mut Polynomial,
) -> bool {
    if den == den1 {
        *num = mem::replace(num, Polynomial::new()) - mem::replace(num1, Polynomial::new());
    } else {
        let mut g = den.gcd(den1);
        let scale = den1.divmod(&mut g).0;
        let scale1 = den.divmod(&mut g).0;
        *num = mem::replace(num, Polynomial::new()) * scale.clone()
            - mem::replace(num1, Polynomial::new()) * scale1;
        *den = mem::replace(den, Polynomial::new()) * scale;
    }

    let mut g1 = num.gcd(den);
    *num = num.divmod(&mut g1).0;
    *den = den.divmod(&mut g1).0;

    num.is_zero()
}

/// Multiply two rational polynomials: num/den * num1/den1
/// The function returns true iff the result is zero.
pub fn rationalpolynomial_mul(
    num: &mut Polynomial,
    den: &mut Polynomial,
    num1: &mut Polynomial,
    den1: &mut Polynomial,
) -> bool {
    let mut g1 = num.gcd(den1);
    let mut g2 = num1.gcd(den);

    let numnew = num.divmod(&mut g1).0;
    let num1new = num1.divmod(&mut g2).0;
    let dennew = den.divmod(&mut g2).0;
    let den1new = den1.divmod(&mut g1).0;

    *num = numnew * num1new;
    *den = dennew * den1new;

    let mut g = num.gcd(den);

    *num = num.divmod(&mut g).0;
    *den = den.divmod(&mut g).0;

    num.is_zero()
}

/// Multiply two rational polynomials: num/den / num1/den1
/// The function returns true iff the result is zero.
#[inline]
pub fn rationalpolynomial_div(
    num: &mut Polynomial,
    den: &mut Polynomial,
    num1: &mut Polynomial,
    den1: &mut Polynomial,
) -> bool {
    rationalpolynomial_mul(num, den, den1, num1)
}

#[test]
fn serialize() {
    let mut a = MultivariatePolynomial::from_monomial(Number::SmallInt(100), vec![0, 0]);
    a.append_monomial(Number::SmallInt(100), &vec![1, 0]);

    let mut b = MultivariatePolynomial::from_monomial(Number::SmallInt(-3), vec![2, 3]);
    b.append_monomial(Number::SmallInt(1), &vec![1, 0]);

    let mut m = HashMap::new();
    m.insert(1, 0);
    m.insert(2, 1);
    let im = vec![1, 2];

    let ap = Polynomial {
        poly: a,
        varmap: m.clone(),
        inv_varmap: im.clone(),
        varcount: 2,
    };

    let bp = Polynomial {
        poly: b,
        varmap: m.clone(),
        inv_varmap: im.clone(),
        varcount: 2,
    };

    let elem = Element::RationalPolynomialCoefficient(false, Box::new((ap, bp)));

    let mut buffer = vec![];
    elem.serialize(&mut buffer);

    assert_eq!(elem, Element::deserialize(&mut buffer.as_slice()).unwrap())
}