laddu-compile 0.24.0

Amplitude analysis tools for Rust
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

use super::*;

#[test]
fn search_selects_cheaper_equivalent() {
    let x = Expr::from(parameter!("x"));
    let expr = (x.clone() + 0.0) * 1.0;
    let compiled = CompiledModel::from_expr(&expr).unwrap();
    assert!(matches!(compiled.graph().node(compiled.graph().root()),
        Some(ExprNode::ScalarParam(parameter)) if parameter.name() == "x"));
    assert!(
        compiled
            .optimization_diagnostics()
            .unwrap()
            .execution_exact()
    );
}

#[test]
fn search_constant_folds_scalar_nodes() {
    let expr = (Expr::from(2.0) + 3.0).powi(2);
    let compiled = CompiledModel::from_expr(&expr).unwrap();
    assert!(matches!(
        compiled.graph().node(compiled.graph().root()),
        Some(ExprNode::RealConst(25.0))
    ));
}

#[test]
fn search_removes_unit_phase_from_squared_norm() {
    let costheta = Expr::from(parameter!("costheta"));
    let phi = Expr::from(parameter!("phi"));
    let expr = ((Complex64::I * phi).exp() * (1.0 + costheta)).norm_sqr();
    let source =
        CompiledModel::from_expr_with_options(&expr, &CompileOptions::without_optimizations())
            .unwrap();
    let compiled = CompiledModel::from_expr(&expr).unwrap();
    assert!(compiled.cost().is_no_worse_than(&source.cost()));
    assert_eq!(count_unary_op(&compiled, UnaryOp::Exp), 0);
}

#[test]
fn search_revisits_new_equivalents() {
    let x = Expr::from(parameter!("x"));
    let expr = (x.clone() + 0.0) - x;
    let compiled = CompiledModel::from_expr(&expr).unwrap();
    assert!(matches!(
        compiled.graph().node(compiled.graph().root()),
        Some(ExprNode::RealConst(0.0))
    ));
    assert!(compiled.optimization_diagnostics().unwrap().rounds() > 1);
}

#[test]
fn node_budget_retains_a_valid_graph() {
    let x = Expr::from(parameter!("x"));
    let expr = x.clone().sin().powi(2) + x.cos().powi(2) + 7.0;
    let options = CompileOptions::default().with_optimization_budget(crate::OptimizationBudget {
        rounds: 8,
        nodes: 1,
        ..Default::default()
    });
    let compiled = CompiledModel::from_expr_with_options(&expr, &options).unwrap();
    assert_eq!(
        compiled.optimization_diagnostics().unwrap().stop_reason(),
        "node budget"
    );
    assert!(compiled.graph().node(compiled.graph().root()).is_some());
}

#[test]
fn memory_budget_retains_a_valid_graph() {
    let expr = Expr::from(parameter!("x")).sin() + 1.0;
    let options = CompileOptions::default().with_optimization_budget(crate::OptimizationBudget {
        memory_bytes: 1,
        ..Default::default()
    });
    let compiled = CompiledModel::from_expr_with_options(&expr, &options).unwrap();
    let diagnostics = compiled.optimization_diagnostics().unwrap();
    assert_eq!(diagnostics.stop_reason(), "memory budget");
    assert!(diagnostics.peak_memory_bytes() > 1);
    assert!(compiled.graph().node(compiled.graph().root()).is_some());
}

#[test]
fn search_time_budget_retains_a_valid_graph() {
    let expr = Expr::from(parameter!("x")).sin() + 1.0;
    let options = CompileOptions::default().with_optimization_budget(crate::OptimizationBudget {
        search_seconds: 0.0,
        ..Default::default()
    });
    let compiled = CompiledModel::from_expr_with_options(&expr, &options).unwrap();
    assert_eq!(
        compiled.optimization_diagnostics().unwrap().stop_reason(),
        "time budget"
    );
    assert!(compiled.graph().node(compiled.graph().root()).is_some());
}

#[test]
fn solver_budget_uses_deterministic_fallback() {
    let x = Expr::from(parameter!("x"));
    let expr = (x.clone() + 0.0) * (x + 1.0);
    let options = CompileOptions::default().with_optimization_budget(crate::OptimizationBudget {
        solver_seconds: 0.0,
        ..Default::default()
    });
    let first = CompiledModel::from_expr_with_options(&expr, &options).unwrap();
    let second = CompiledModel::from_expr_with_options(&expr, &options).unwrap();
    assert_eq!(first.graph().nodes(), second.graph().nodes());
    let diagnostics = first.optimization_diagnostics().unwrap();
    assert!(!diagnostics.execution_exact());
    assert_eq!(diagnostics.execution_fallback(), Some("solver limit"));
}

#[test]
fn exact_extraction_is_deterministic() {
    let x = Expr::from(parameter!("x"));
    let y = Expr::from(parameter!("y"));
    let expr = (x.clone() + y.clone()) * (y + x);
    let first = CompiledModel::from_expr(&expr).unwrap();
    let second = CompiledModel::from_expr(&expr).unwrap();
    assert!(first.optimization_diagnostics().unwrap().execution_exact());
    assert_eq!(first.graph().nodes(), second.graph().nodes());
}