symoxide 0.1.2

Intermediate Representation and Transformations for Computer Algebra Systems
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

// Copyright (c) 2022 Kaushik Kulkarni
// Copyright (c) 2009-2013 Andreas Kloeckner (for regressions in pymbolic)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use std::collections::HashSet;
use sym::scalar;
use symoxide as sym;
use symoxide::operations as ops;
use symoxide::parse;

#[test]
fn test_parser() {
    let (a,) = sym::variables!("a");
    parse(concat!("(2*a[1]*b[1]+2*a[0]*b[0])*(hankel_1(-1,sqrt(a[1]**2+a[0]**2)*k) ",
                  "-hankel_1(1,sqrt(a[1]**2+a[0]**2)*k))*k /(4*sqrt(a[1]**2+a[0]**2)) ",
                  "+hankel_1(0,sqrt(a[1]**2+a[0]**2)*k)"));
    assert_eq!(parse("d4knl0"), sym::var("d4knl0"));
    assert_eq!(parse("0."), scalar!(0.));
    assert_eq!(parse("0.e1"), scalar!(0.));
    assert_eq!(parse("1e-12"), scalar!(1e-12));

    assert_eq!(parse("a >= 1"), ops::greater_equal(&a, &1));
    assert_eq!(parse("a <= 1"), ops::less_equal(&a, &1));

    let (foo, bar) = sym::variables!("foo bar");
    assert_eq!(parse("foo[2, bar]"), ops::index(foo, [scalar!(2), bar]));

    let (foo, bar, baz) = sym::variables!("foo bar baz");
    assert_eq!(parse("foo[2, bar, baz]"),
               ops::index(foo, vec![scalar!(2), bar, baz]));

    let i = sym::var("i");
    assert_eq!(parse("5+i if i>=0 else (0 if i<-1 else 10)"),
               ops::ifthenelse(ops::greater_equal(&i, &sym::scalar!(0)),
                               ops::add(&sym::scalar!(5), &i),
                               ops::ifthenelse(ops::less(&i, &sym::scalar!(-1)),
                                               sym::scalar!(0),
                                               sym::scalar!(10))));
    assert_eq!(parse("0 if (1 if 2 else 3) else 4"),
               ops::ifthenelse(ops::ifthenelse(sym::scalar!(2), sym::scalar!(1), sym::scalar!(3)),
                               sym::scalar!(0),
                               sym::scalar!(4)));
}

#[test]
fn test_get_dependencies() {
    let expr = parse("2*foo(bar, baz[1.0, quux])");
    assert_eq!(sym::get_dependencies(&expr),
               HashSet::from(["foo".to_string(),
                              "bar".to_string(),
                              "baz".to_string(),
                              "quux".to_string()]))
}

#[test]
fn test_get_num_nodes() {
    let expr = parse("2*foo(bar, baz[1.0, quux]) - 1729");
    assert_eq!(sym::get_num_nodes(&expr), 11);
}

#[test]
fn test_get_hasher() {
    let (foo, bar, baz, quux) = sym::variables!("foo bar baz quux");
    let (two, two_dup, pi) = (scalar!(2), scalar!(2), scalar!(3.14159265359));
    // exp = 3.14159265359 * foo[bar << 2, baz + 2, 2 > quux]
    let expr = ops::mul(&pi,
                        &ops::index(foo.clone(),
                                    [ops::left_shift(&bar, &two),
                                     ops::add(&baz, &two),
                                     ops::greater(&two_dup, &quux)]));
    let hasher = sym::get_hasher(expr.clone());

    // {{{ necessary test that 2 different object instances hash to the same value

    assert!(!std::rc::Rc::ptr_eq(&two, &two_dup));
    assert_eq!(hasher.get(two.clone()), hasher.get(two_dup.clone()));

    // }}}

    assert_ne!(foo.clone(), bar.clone());
    assert_ne!(bar.clone(), baz.clone());
    for subexpr in [foo, bar, baz, quux, two, two_dup, pi] {
        assert_eq!(hasher.get(subexpr.clone()), hasher.get(subexpr.clone()));
    }
    assert_eq!(expr.clone(), expr.clone());
}

#[test]
fn test_deduplicator() {
    let expr = parse("42*foo[42*bar*foo, quux+bar, 42+baz]");
    let deduped_expr = sym::deduplicate_nodes(&expr);
    assert_eq!(sym::get_num_nodes(&expr), 15);
    assert_eq!(sym::get_num_nodes(&deduped_expr), 11);
}

fn assert_parse_roundtrip(code: &str) {
    let expr = parse(code);
    assert_eq!(expr, parse(format!("{}", expr)));
}

#[test]
fn test_stringify_parse_are_inverses() {
    assert_parse_roundtrip("g[i, k] + 2.1*h[i, k]");
    assert_parse_roundtrip("a - b - c");
    assert_parse_roundtrip("-a - -b - -c");
    assert_parse_roundtrip("- - - a - - - - b - - - - - c");
    assert_parse_roundtrip("~(a ^ b)");
    assert_parse_roundtrip("(a | b) | ~(~a & ~b)");
    assert_parse_roundtrip("3 << 1");
    assert_parse_roundtrip("1 >> 3");
    // Requires tuple expression types -->
    // assert_parse_roundtrip("f((x,y),z)");
    // assert_parse_roundtrip("f((x,),z)");
    // assert_parse_roundtrip("f(x,(y,z),z)");
}