Function dqcsim::bindings::dqcs_gm_add_predef_unitary

#[no_mangle]pub extern "C" fn dqcs_gm_add_predef_unitary(
    gm: dqcs_handle_t, 
    key_free: Option<extern "C" fn(user_data: *mut c_void)>, 
    key_data: *mut c_void, 
    gate: dqcs_predefined_gate_t, 
    num_controls: isize, 
    epsilon: c_double, 
    ignore_gphase: bool
) -> dqcs_return_t

Adds a unitary gate mapping for the given DQCsim-defined gate to the given gate map. >

gm must be a handle to a gate map object (dqcs_gm_new()). key_free is an optional callback function used to free key_data when the gate map is destroyed, or when this function fails. key_data is the user-specified value used to identify this mapping. gate defines which predefined gate to use. Some of the predefined gates are parameterized. num_controls specifies the number of control qubits associated with this gate type. If negative, the gate can have any number of control qubits. If zero or positive, the number of control qubits must be as specified. epsilon specifies the maximum element-wise root-mean-square error between the incoming matrix and the to be detected matrix that results in a positive match. ignore_phase specifies whether the aforementioned check should ignore global phase or not when there are no explicit control qubits.

For most gate types, the parameterization ArbData object returned by detection and consumed by construction is mapped one-to-one to the user data of the gate in the DQCsim-protocol. Some of the detectors however detect parameterized gate matrices. These detectors prefix a fixed number of binary string arguments to the ArbData upon detection, and pop these when constructing. The specs for this can be found in the docs for dqcs_predefined_gate_t.