dqcsim 0.0.4

DQCsim: Delft Quantum Classical Simulator
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

use super::*;

/// Creates a new set of qubit references.
///>
///> Returns the handle of the newly created set. The set is initially empty.
///> Qubit sets are ordered, meaning that the order in which qubits are popped
///> from the set equals the order in which they were pushed. To iterate over a
///> set, simply make a copy and drain the copy using pop.
#[no_mangle]
pub extern "C" fn dqcs_qbset_new() -> dqcs_handle_t {
    insert(QubitReferenceSet::new())
}

/// Returns whether the given qubit set contains the given qubit.
#[no_mangle]
pub extern "C" fn dqcs_qbset_contains(
    qbset: dqcs_handle_t,
    qubit: dqcs_qubit_t,
) -> dqcs_bool_return_t {
    api_return_bool(|| {
        resolve!(qbset as &mut QubitReferenceSet);
        let qubit = QubitRef::from_foreign(qubit)
            .ok_or_else(oe_inv_arg("0 is not a valid qubit reference"))?;
        Ok(qbset.contains(&qubit))
    })
}

/// Pushes a qubit reference into a qubit reference set.
///>
///> This function will fail if the specified qubit was already part of the set.
#[no_mangle]
pub extern "C" fn dqcs_qbset_push(qbset: dqcs_handle_t, qubit: dqcs_qubit_t) -> dqcs_return_t {
    api_return_none(|| {
        resolve!(qbset as &mut QubitReferenceSet);
        let qubit = QubitRef::from_foreign(qubit)
            .ok_or_else(oe_inv_arg("0 is not a valid qubit reference"))?;
        if qbset.contains(&qubit) {
            inv_arg("the specified qubit is already part of the set")
        } else {
            qbset.push_back(qubit);
            Ok(())
        }
    })
}

/// Pops a qubit reference off of a qubit reference set.
///>
///> Qubits are popped in the same order in which they were pushed. That is,
///> they are FIFO-ordered.
#[no_mangle]
pub extern "C" fn dqcs_qbset_pop(qbset: dqcs_handle_t) -> dqcs_qubit_t {
    api_return(0, || {
        resolve!(qbset as &mut QubitReferenceSet);
        if let Some(qubit) = qbset.pop_front() {
            Ok(qubit.to_foreign())
        } else {
            inv_arg("the qubit set is already empty")
        }
    })
}

/// Returns the number of qubits in the given set.
///>
///> This function returns -1 to indicate failure.
#[no_mangle]
pub extern "C" fn dqcs_qbset_len(qbset: dqcs_handle_t) -> ssize_t {
    api_return(-1, || {
        resolve!(qbset as &QubitReferenceSet);
        Ok(qbset.len() as ssize_t)
    })
}

/// Returns a copy of the given qubit set, intended for non-destructive
/// iteration.
#[no_mangle]
pub extern "C" fn dqcs_qbset_copy(qbset: dqcs_handle_t) -> dqcs_handle_t {
    api_return(0, || {
        resolve!(qbset as &QubitReferenceSet);
        Ok(insert(qbset.clone()))
    })
}