laddu-runtime 0.21.5

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
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

use super::*;
use laddu_kernel::ir::{KernelInstruction, KernelValueKind};

#[test]
fn evaluates_scalar_expression_with_parameters() {
    let expr = (2.0 * parameter!("x", initial: 3.0)
        + complex(
            parameter!("re", initial: 1.0),
            parameter!("im", initial: 2.0),
        ))
    .norm_sqr();

    assert_eq!(evaluate(&expr), Complex64::from(53.0));
}
#[test]
fn evaluates_event_scalars() {
    let expr = laddu_expr::event_scalar("x") * 2.0;
    let model = CompiledModel::from_expr(&expr).unwrap();
    let params = Arc::new(model.params().clone()).default_values();
    let plan = CpuBackend.prepare(&model);
    let event = HashMap::from([("x".to_owned(), 3.0)]);

    assert_eq!(
        plan.evaluate_with_event(&params, &event).unwrap(),
        Complex64::from(6.0)
    );
}
#[test]
fn scalar_kernel_ir_preserves_typed_dependency_classes() {
    let coefficient = complex(parameter!("re", initial: 2.0), 1.0);
    let expr = coefficient * event_scalar("x");
    let model = CompiledModel::from_expr(&expr).unwrap();
    let plan = CpuBackend.prepare(&model);
    let kernel = plan.scalar_kernel.as_ref().unwrap();

    assert!(
        kernel
            .values()
            .iter()
            .any(|value| value.class == KernelValueClass::Invariant)
    );
    assert!(
        kernel
            .values()
            .iter()
            .any(|value| value.class == KernelValueClass::Event)
    );
    let root = &kernel.values()[kernel.root().index()];
    assert_eq!(root.kind, KernelValueKind::Complex);
    assert_eq!(root.class, KernelValueClass::Event);
    assert!(matches!(root.instruction, KernelInstruction::Mul(_)));
}
#[test]
fn cpu_execution_mode_selects_retained_interpreter() {
    let expr = laddu_expr::Expr::from(parameter!("x", initial: 2.0)).exp() + 1.0;
    let model = CompiledModel::from_expr(&expr).unwrap();
    let params = Arc::new(model.params().clone()).default_values();
    let automatic = CpuBackend.prepare(&model);
    let interpreted = CpuBackend.prepare_with_execution_mode(&model, CpuExecutionMode::Interpreter);
    let execution = Execution::local(crate::ExecutionOptions {
        device: crate::Device::Cpu(crate::CpuOptions {
            jit: crate::JitPolicy::Disabled,
            ..crate::CpuOptions::default()
        }),
        ..crate::ExecutionOptions::default()
    })
    .unwrap();
    let configured = CpuBackend
        .prepare_for_execution(&model, &execution)
        .unwrap();

    assert!(matches!(
        interpreted.scalar_executor,
        Some(ScalarExecutor::Interpreter(_))
    ));
    assert!(matches!(
        configured.scalar_executor,
        Some(ScalarExecutor::Interpreter(_))
    ));
    assert!(matches!(
        configured.gradient_executor,
        GradientExecutor::Interpreter(_)
    ));
    assert_eq!(
        automatic.evaluate(&params).unwrap(),
        interpreted.evaluate(&params).unwrap()
    );

    let empty_model = CompiledModel::from_expr(&laddu_expr::Expr::from(1.0)).unwrap();
    let wrong_params = empty_model.params().default_values();
    assert!(matches!(
        automatic.evaluate(&wrong_params),
        Err(RuntimeError::Parameter(_))
    ));
}
#[test]
fn cpu_plan_executes_parameter_only_scalar_kernel_in_f32() {
    let x = laddu_expr::Expr::from(parameter!("x", initial: 16_777_216.0));
    let y = laddu_expr::Expr::from(parameter!("y", initial: 1.0));
    let model = CompiledModel::from_expr(&(x + y)).unwrap();
    let params = model.params().default_values();
    let execution = Execution::local(crate::ExecutionOptions {
        device: crate::Device::Cpu(crate::CpuOptions::default()),
        precision: Precision::F32,
        ..crate::ExecutionOptions::default()
    })
    .unwrap();
    let f32_plan = CpuBackend
        .prepare_for_execution(&model, &execution)
        .unwrap();
    let f64_plan = CpuBackend.prepare(&model);

    assert_eq!(f32_plan.evaluate(&params).unwrap().re, 16_777_216.0);
    assert_eq!(f64_plan.evaluate(&params).unwrap().re, 16_777_217.0);
    let gradient = f32_plan.evaluate_with_gradient(&params).unwrap();
    assert_eq!(gradient.value().re, 16_777_216.0);
    assert_eq!(gradient.gradient(), &[Complex64::ONE, Complex64::ONE]);
}
#[test]
fn cpu_f32_evaluates_complex_linear_algebra() {
    let scale = laddu_expr::Expr::from(parameter!("scale", initial: 1.25));
    let lhs = matrix([
        [scale.clone() + 2.0, complex(0.25, -0.5)],
        [0.5.into(), scale.clone() + 3.0],
    ]);
    let rhs = vector([1.0.into(), scale]);
    let model = CompiledModel::from_expr(&dot(
        vector([1.0.into(), complex(0.0, 1.0)]),
        solve(lhs, rhs),
    ))
    .unwrap();
    let params = model.params().default_values();
    let execution = Execution::local(crate::ExecutionOptions {
        device: crate::Device::Cpu(crate::CpuOptions::default()),
        precision: Precision::F32,
        ..crate::ExecutionOptions::default()
    })
    .unwrap();
    let f32_plan = CpuBackend
        .prepare_for_execution(&model, &execution)
        .unwrap();
    let f64_plan = CpuBackend.prepare(&model);

    let actual = f32_plan.evaluate(&params).unwrap();
    let expected = f64_plan.evaluate(&params).unwrap();
    assert!((actual.re - expected.re).abs() < 1.0e-6);
    assert!((actual.im - expected.im).abs() < 1.0e-6);
}
#[test]
fn evaluates_p4_schema_components_and_atan2() {
    let expr = event_p4_component("ks1", P4Component::E)
        + event_p4_component("ks1", P4Component::Px)
        + atan2(
            event_p4_component("ks1", P4Component::Py),
            event_p4_component("ks1", P4Component::Px),
        );
    let model = CompiledModel::from_expr(&expr).unwrap();
    let params = Arc::new(model.params().clone()).default_values();
    let plan = CpuBackend.prepare(&model);
    let batch = EventBatch::from_events(
        Arc::new(Schema::new(["ks1"], std::iter::empty::<&str>(), false).unwrap()),
        [OwnedEvent::new(
            vec![RealVec4::new(10.0, 3.0, 4.0, 5.0)],
            vec![],
        )],
    )
    .unwrap();

    assert_eq!(
        plan.evaluate_batch(&params, &batch).unwrap()[0],
        Complex64::from(13.0 + 4.0_f64.atan2(3.0))
    );
}
#[test]
fn evaluates_linear_algebra_nodes() {
    let a = matrix([[2.0, 0.0], [0.0, 4.0]]);
    let b = vector([8.0, 12.0]);
    let x = solve(a, b);
    let expr = dot(&x, vector([1.0, 1.0]));
    let model = CompiledModel::from_expr(&expr).unwrap();
    let params = Arc::new(model.params().clone()).default_values();
    let plan = CpuBackend.prepare_with_execution_mode(&model, CpuExecutionMode::Interpreter);

    assert_eq!(plan.evaluate(&params).unwrap(), Complex64::from(7.0));
    assert_eq!(plan.constant_factors.len(), 1);
    assert!(plan.constant_factors[0].get().is_some());
}
#[test]
fn optimized_and_unoptimized_plans_evaluate_the_same_expression() {
    let solved = solve(matrix([[2.0, 0.0], [0.0, 4.0]]), vector([8.0, 12.0]));
    let complex_offset = complex(
        parameter!("offset_re", initial: 1.5),
        parameter!("offset_im", initial: -0.5),
    );
    let polar_product = polar_complex(
        parameter!("mag1", initial: 2.0),
        parameter!("phase1", initial: 0.25),
    ) * polar_complex(
        parameter!("mag2", initial: 3.0),
        parameter!("phase2", initial: -0.5),
    );
    let expr = ((laddu_expr::event_scalar("mass") + 0.0) * 1.0
        + dot(solved, vector([1.0, 1.0]))
        + complex_offset.conj().real()
        + polar_product.real()
        + parameter!("unused", initial: 3.0) * 0.0)
        .norm_sqr();
    let no_optimization = CompileOptions::without_optimizations();
    let optimized = CompiledModel::from_expr(&expr).unwrap();
    let unoptimized = CompiledModel::from_expr_with_options(&expr, &no_optimization).unwrap();
    let optimized_params = Arc::new(optimized.params().clone()).default_values();
    let unoptimized_params = Arc::new(unoptimized.params().clone()).default_values();
    let event = HashMap::from([("mass".to_owned(), 2.0)]);

    let optimized = CpuBackend
        .prepare(&optimized)
        .evaluate_with_event_and_gradient(&optimized_params, &event)
        .unwrap();
    let unoptimized = CpuBackend
        .prepare(&unoptimized)
        .evaluate_with_event_and_gradient(&unoptimized_params, &event)
        .unwrap();
    assert_eq!(optimized.value(), unoptimized.value());
    for (optimized, unoptimized) in optimized.gradient().iter().zip(unoptimized.gradient()) {
        assert!((optimized - unoptimized).norm() < 1.0e-12);
    }
}