quant-iron 2.0.0

A high-performance, hardware-accelerated modular quantum computing library with a focus on physical applications. Quant-Iron provides tools to represent quantum states, apply standard quantum gates, perform measurements, build quantum circuits, and implement quantum algorithms.
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
use crate::{components::parametric::{
    parameter::Parameter,
}, CircuitBuilder};

#[test]
fn test_parametric_parameter_new() {
    // This should compile and run
    let _parameter = Parameter::new([0.5, 1.0]);
}

#[test]
fn test_parametric_parameter_get() {
    let parameter = Parameter::new([0.5, 1.0]);
    let values = parameter.get();
    assert_eq!(values, [0.5, 1.0]);
}

#[test]
fn test_parametric_parameter_set() {
    let parameter = Parameter::new([0.5, 1.0]);
    parameter.set([0.6, 1.1]);
    let values = parameter.get();
    assert_eq!(values, [0.6, 1.1]);
}

#[test]
fn test_parametric_parameter_deep_clone() {
    let parameter = Parameter::new([0.5, 1.0]);
    let cloned_parameter = parameter.clone();
    let deep_cloned_parameter = parameter.deep_clone();
    
    assert_eq!(cloned_parameter.get(), [0.5, 1.0]);
    assert_eq!(deep_cloned_parameter.get(), [0.5, 1.0]);

    // Change original parameter and check that deep cloned parameter is unaffected
    parameter.set([0.6, 1.1]);
    assert_eq!(cloned_parameter.get(), [0.6, 1.1]);
    assert_eq!(deep_cloned_parameter.get(), [0.5, 1.0]);
}

#[test]
fn test_parametric_parametric_ryphase() {
    let parameter = Parameter::new([0.5, 1.0]);

    let circuit_ry_phase = CircuitBuilder::new(1)
        .parametric_ry_phase_gate(0, parameter.clone())
        .build_final().expect("Failed to build circuit").to_concrete_circuit();

    let concrete_circuit_ry_phase = circuit! {
        qubits: 1,
        ry_phase(0, parameter.get()[0], parameter.get()[1])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit_ry_phase), format!("{:?}", concrete_circuit_ry_phase));

    let circuit_cry_phase = CircuitBuilder::new(3)
        .parametric_cry_phase_gates(vec![0, 1], vec![2], vec![parameter.clone(), parameter.clone()]).unwrap()
        .build_final().expect("Failed to build circuit").to_concrete_circuit();

    let concrete_circuit_cry_phase = circuit! {
        qubits: 3,
        cry_phase([0, 1], 2, parameter.get()[0], parameter.get()[1]),
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit_cry_phase), format!("{:?}", concrete_circuit_cry_phase));

    let circuit = CircuitBuilder::new(2)
        .parametric_ry_phase_gates(vec![0, 1], vec![parameter.clone(), parameter.clone()]).unwrap()
        .build_final().expect("Failed to build circuit").to_concrete_circuit();

    let concrete_circuit = circuit! {
        qubits: 2,
        ry_phase([0, 1], parameter.get()[0], parameter.get()[1])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit), format!("{:?}", concrete_circuit));
}

#[test]
fn test_parametric_parametric_matchgate() {
    let parameter = Parameter::new([0.5, 1.0, 1.5]);

    let circuit = CircuitBuilder::new(2)
        .parametric_matchgate(0, parameter.clone())
        .build_final().expect("Failed to build circuit").to_concrete_circuit();

    let concrete_circuit = circuit! {
        qubits: 2,
        matchgate(0, parameter.get()[0], parameter.get()[1], parameter.get()[2])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit), format!("{:?}", concrete_circuit));

    let circuit_controlled = CircuitBuilder::new(3)
        .parametric_cmatchgate(0, vec![2], parameter.clone())
        .build_final().expect("Failed to build circuit").to_concrete_circuit();

    let concrete_circuit_controlled = circuit! {
        qubits: 3,
        cmatchgate(0, [2], parameter.get()[0], parameter.get()[1], parameter.get()[2])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit_controlled), format!("{:?}", concrete_circuit_controlled));
}

#[test]
fn test_parametric_change_parameter_val() {
    let parameter_ryp = Parameter::new([0.5, 1.0]);
    let parameter_mc = Parameter::new([0.5, 1.0, 1.5]);
    let circuit = CircuitBuilder::new(3)
        .parametric_cry_phase_gates(vec![0, 1], vec![2], vec![parameter_ryp.clone(), parameter_ryp.clone()])
        .expect("Failed to create parametric cry phase gates")
        .parametric_matchgate(0, parameter_mc.clone())
        .build_final().expect("Failed to build circuit");

    let circuit_1 = circuit! {
        qubits: 3,
        cry_phase([0, 1], 2, parameter_ryp.get()[0], parameter_ryp.get()[1]),
        matchgate(0, parameter_mc.get()[0], parameter_mc.get()[1], parameter_mc.get()[2])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit.to_concrete_circuit()), format!("{:?}", circuit_1));

    // Change param values
    parameter_ryp.set([0.6, 1.1]);
    parameter_mc.set([0.6, 1.1, 1.6]);

    let circuit_2 = circuit! {
        qubits: 3,
        cry_phase([0, 1], 2, parameter_ryp.get()[0], parameter_ryp.get()[1]),
        matchgate(0, parameter_mc.get()[0], parameter_mc.get()[1], parameter_mc.get()[2])
    }.expect("Failed to create concrete circuit");

    assert_eq!(format!("{:?}", circuit.to_concrete_circuit()), format!("{:?}", circuit_2));
}

#[test]
fn test_parametric_mismatched_parameters_error() {
    let parameter = Parameter::new([0.5, 1.0]);
    let mut builder = CircuitBuilder::new(3);
    let err_cry = builder.parametric_cry_phase_gates(vec![0, 1], vec![2], vec![parameter.clone()]);

    if let Err(err) = err_cry {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters");
    }

    let mut builder = CircuitBuilder::new(3);
    let err_ry = builder.parametric_ry_phase_gates(vec![0, 1], vec![parameter.clone()]);
    if let Err(err) = err_ry {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters");
    }

    let parameter_1d = Parameter::new([0.5]);

    // Test crx_gates
    let mut builder_crx = CircuitBuilder::new(3);
    let err_crx = builder_crx.parametric_crx_gates(vec![0, 1], vec![2], vec![parameter_1d.clone()]);
    if let Err(err) = err_crx {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for crx");
    }

    // Test cry_gates
    let mut builder_cry = CircuitBuilder::new(3);
    let err_cry = builder_cry.parametric_cry_gates(vec![0, 1], vec![2], vec![parameter_1d.clone()]);
    if let Err(err) = err_cry {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for cry");
    }

    // Test crz_gates
    let mut builder_crz = CircuitBuilder::new(3);
    let err_crz = builder_crz.parametric_crz_gates(vec![0, 1], vec![2], vec![parameter_1d.clone()]);
    if let Err(err) = err_crz {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for crz");
    }

    // Test cp_gates
    let mut builder_cp = CircuitBuilder::new(3);
    let err_cp = builder_cp.parametric_cp_gates(vec![0, 1], vec![2], vec![parameter_1d.clone()]);
    if let Err(err) = err_cp {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for cp");
    }

    // Add mismatched parameter tests for ry_phase_dag variants
    let parameter = Parameter::new([0.5, 1.0]);

    let mut builder = CircuitBuilder::new(3);
    let err_cry_phase_dag = builder.parametric_cry_phase_dag_gates(
        vec![0, 1],
        vec![2],
        vec![parameter.clone()],
    );
    if let Err(err) = err_cry_phase_dag {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for cry_phase_dag");
    }

    let mut builder = CircuitBuilder::new(3);
    let err_ry_phase_dag = builder.parametric_ry_phase_dag_gates(
        vec![0, 1],
        vec![parameter.clone()],
    );
    if let Err(err) = err_ry_phase_dag {
        assert_eq!(
            err.to_string(),
            "Mismatched number of parameters: expected 2, got 1"
        );
    } else {
        panic!("Expected an error due to mismatched parameters for ry_phase_dag");
    }
}

#[test]
fn test_parametric_rotations() {
    let parameter = Parameter::new([0.5]);

    // Rx
    let circuit_rx = CircuitBuilder::new(1)
        .parametric_rx_gate(0, parameter.clone())
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_rx = circuit! {
        qubits: 1,
        rx(0, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_rx),
        format!("{:?}", concrete_circuit_rx)
    );

    // cRx
    let circuit_crx = CircuitBuilder::new(2)
        .parametric_crx_gates(vec![0], vec![1], vec![parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_crx = circuit! {
        qubits: 2,
        crx(0, 1, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_crx),
        format!("{:?}", concrete_circuit_crx)
    );

    // Ry
    let circuit_ry = CircuitBuilder::new(1)
        .parametric_ry_gate(0, parameter.clone())
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_ry = circuit! {
        qubits: 1,
        ry(0, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_ry),
        format!("{:?}", concrete_circuit_ry)
    );

    // cRy
    let circuit_cry = CircuitBuilder::new(2)
        .parametric_cry_gates(vec![0], vec![1], vec![parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_cry = circuit! {
        qubits: 2,
        cry(0, 1, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_cry),
        format!("{:?}", concrete_circuit_cry)
    );

    // Rz
    let circuit_rz = CircuitBuilder::new(1)
        .parametric_rz_gate(0, parameter.clone())
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_rz = circuit! {
        qubits: 1,
        rz(0, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_rz),
        format!("{:?}", concrete_circuit_rz)
    );

    // cRz
    let circuit_crz = CircuitBuilder::new(2)
        .parametric_crz_gates(vec![0], vec![1], vec![parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_crz = circuit! {
        qubits: 2,
        crz(0, 1, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_crz),
        format!("{:?}", concrete_circuit_crz)
    );
}

#[test]
fn test_parametric_phase() {
    let parameter = Parameter::new([0.5]);

    // P
    let circuit_p = CircuitBuilder::new(1)
        .parametric_p_gate(0, parameter.clone())
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_p = circuit! {
        qubits: 1,
        p(0, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_p),
        format!("{:?}", concrete_circuit_p)
    );

    // cP
    let circuit_cp = CircuitBuilder::new(2)
        .parametric_cp_gates(vec![0], vec![1], vec![parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();
    let concrete_circuit_cp = circuit! {
        qubits: 2,
        cp(0, 1, parameter.get()[0])
    }
    .expect("Failed to create concrete circuit");
    assert_eq!(
        format!("{:?}", circuit_cp),
        format!("{:?}", concrete_circuit_cp)
    );
}

#[test]
fn test_parametric_ry_phase_dag() {
    let parameter = Parameter::new([0.5, 1.0]);

    // Single-qubit parametric_ry_phase_dag
    let circuit_ry_phase_dag_single = CircuitBuilder::new(1)
        .parametric_ry_phase_dag_gate(0, parameter.clone())
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();

    let concrete_circuit_ry_phase_dag_single = circuit! {
        qubits: 1,
        ry_phase_dag(0, parameter.get()[0], parameter.get()[1])
    }
    .expect("Failed to create concrete circuit");

    assert_eq!(
        format!("{:?}", circuit_ry_phase_dag_single),
        format!("{:?}", concrete_circuit_ry_phase_dag_single)
    );

    let circuit_ry_phase_dag = CircuitBuilder::new(2)
        .parametric_ry_phase_dag_gates(vec![0, 1], vec![parameter.clone(), parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();

    let concrete_circuit_ry_phase_dag = circuit! {
        qubits: 2,
        ry_phase_dag([0, 1], parameter.get()[0], parameter.get()[1])
    }
    .expect("Failed to create concrete circuit");

    assert_eq!(
        format!("{:?}", circuit_ry_phase_dag),
        format!("{:?}", concrete_circuit_ry_phase_dag)
    );

    let circuit_cry_phase_dag = CircuitBuilder::new(3)
        .parametric_cry_phase_dag_gates(vec![0, 1], vec![2], vec![parameter.clone(), parameter.clone()])
        .unwrap()
        .build_final()
        .expect("Failed to build circuit")
        .to_concrete_circuit();

    let concrete_circuit_cry_phase_dag = circuit! {
        qubits: 3,
        cry_phase_dag([0, 1], 2, parameter.get()[0], parameter.get()[1])
    }
    .expect("Failed to create concrete circuit");

    assert_eq!(
        format!("{:?}", circuit_cry_phase_dag),
        format!("{:?}", concrete_circuit_cry_phase_dag)
    );
}