Struct qip::builders::OpBuilder

pub struct OpBuilder { /* fields omitted */ }

A basic builder for unitary and non-unitary ops.

Methods

impl OpBuilder

pub fn new() -> OpBuilder

Build a new OpBuilder

pub fn register(&mut self, n: u64) -> Result<Register, CircuitError>

Build a new Register with n indices

pub fn registers(&mut self, ns: &[u64]) -> Result<Vec<Register>, CircuitError>

Builds a vector of new Register

pub fn r(&mut self, n: u64) -> Register

If you just plan to call unwrap this is cleaner.

pub fn qubit(&mut self) -> Register

Create a single qubit register.

pub fn register_and_handle(
    &mut self,
    n: u64
) -> Result<(Register, RegisterHandle), CircuitError>

Build a new register with n indices, return it plus a handle which can be used for feeding in an initial state.

pub fn get_temp_register(&mut self, n: u64, value: bool) -> Register

Get a temporary Register with value |0n> or |1n>. This value is not checked and may be subject to the noise of your circuit, since it can recycle Registers which were returned with return_temp_register. If not enough Registers have been returned, then new Registers may be allocated (and initialized with the correct value).

pub fn return_temp_register(&mut self, r: Register, value: bool)

Return a temporary Register which is supposed to have a given value |0n> or |1n> This value is not checked and may be subject to the noise of your circuit, in turn causing noise to future calls to get_temp_register.

pub fn measure(&mut self, r: Register) -> (Register, MeasurementHandle)

Add a measure op to the pipeline for r and return a reference which can later be used to access the measured value from the results of pipeline::run.

pub fn measure_basis(
    &mut self,
    r: Register,
    angle: f64
) -> (Register, MeasurementHandle)

Measure in the basis of cos(phase)|0> + sin(phase)|1>

Trait Implementations

impl UnitaryBuilder for OpBuilder

fn with_condition(&mut self, r: Register) -> ConditionalContextBuilder

Build a builder which uses r as a condition.

fn mat(
    &mut self,
    name: &str,
    r: Register,
    mat: Vec<Complex<f64>>
) -> Result<Register, CircuitError>

Build a generic matrix op, apply to r, if r is multiple indices and mat is 2x2, apply to each index, otherwise returns an error if the matrix is not the correct size for the number of indices in r (mat.len() == 2^(2n)).

fn sparse_mat(
    &mut self,
    name: &str,
    r: Register,
    mat: Vec<Vec<(u64, Complex<f64>)>>,
    natural_order: bool
) -> Result<Register, CircuitError>

Build a sparse matrix op, apply to r, if r is multiple indices and mat is 2x2, apply to each index, otherwise returns an error if the matrix is not the correct size for the number of indices in r (mat.len() == 2^n).

fn apply_function(
    &mut self,
    r_in: Register,
    r_out: Register,
    f: Box<dyn Fn(u64) -> (u64, f64) + Send + Sync>
) -> Result<(Register, Register), CircuitError>

Make an operation from the boxed function f. This maps c|r_in>|r_out> to c*e^itheta|r_in>|r_out ^ indx> where indx and theta are the outputs from the function f(x) = (indx, theta)

fn cx(&mut self, cr: Register, rb: Register) -> (Register, Register)

A controlled x, using cr as control and r as input.

fn cy(&mut self, cr: Register, rb: Register) -> (Register, Register)

A controlled y, using cr as control and r as input.

fn cz(&mut self, cr: Register, rb: Register) -> (Register, Register)

A controlled z, using cr as control and r as input.

fn cnot(&mut self, cr: Register, rb: Register) -> (Register, Register)

A controlled not, using cr as control and r as input.

fn cswap(
    &mut self,
    cr: Register,
    ra: Register,
    rb: Register
) -> Result<(Register, Register, Register), CircuitError>

Swap ra and rb controlled by cr.

fn cmat(
    &mut self,
    name: &str,
    cr: Register,
    r: Register,
    mat: Vec<Complex<f64>>
) -> Result<(Register, Register), CircuitError>

Apply a unitary matrix to the register. If mat is 2x2 then can broadcast to all qubits.

fn crealmat(
    &mut self,
    name: &str,
    cr: Register,
    r: Register,
    mat: &[f64]
) -> Result<(Register, Register), CircuitError>

Apply a orthonormal matrix to the register. If mat is 2x2 then can broadcast to all qubits.

fn split_absolute(
    &mut self,
    r: Register,
    selected_indices: &[u64]
) -> Result<(Register, Register), CircuitError>

Split the Register r into two Registers, one with selected_indices and one with the remaining.

fn merge_with_op(
    &mut self,
    rs: Vec<Register>,
    named_operator: Option<(String, UnitaryOp)>
) -> Result<Register, CircuitError>

Merge Registers using a generic state processing function.

fn stochastic_measure(&mut self, r: Register) -> (Register, u64)

Measure all Register states and probabilities, does not edit state (thus Unitary). Returns Register and handle.

fn sidechannel_helper(
    &mut self,
    rs: Vec<Register>,
    handles: &[MeasurementHandle],
    f: Box<dyn Fn(&mut dyn UnitaryBuilder, Register, &[u64]) -> Result<Vec<Register>, CircuitError>>
) -> Vec<Register>

A helper function for the classical_sidechannel. Takes a set of Registers to pass to the subcircuit, a set of handles whose measured values will also be passed, and a function which matches to description of SideChannelHelperFn. Returns a set of Registers whose indices match those of the input Registers. This shouldn't be called in circuits, and is a helper to classical_sidechannel and single_register_classical_sidechannel.

fn real_mat(
    &mut self,
    name: &str,
    r: Register,
    mat: &[f64]
) -> Result<Register, CircuitError>

Build a matrix op from real numbers, apply to r, if r is multiple indices and mat is 2x2, apply to each index, otherwise returns an error if the matrix is not the correct size for the number of indices in r (mat.len() == 2^(2n)).

fn sparse_mat_from_fn(
    &mut self,
    name: &str,
    r: Register,
    f: Box<dyn Fn(u64) -> Vec<(u64, Complex<f64>)>>,
    natural_order: bool
) -> Result<Register, CircuitError>

Build a sparse matrix op from f, apply to r, if r is multiple indices and mat is 2x2, apply to each index, otherwise returns an error if the matrix is not the correct size for the number of indices in r (mat.len() == 2^n).

fn real_sparse_mat(
    &mut self,
    name: &str,
    r: Register,
    mat: &[Vec<(u64, f64)>],
    natural_order: bool
) -> Result<Register, CircuitError>

Build a sparse matrix op from real numbers, apply to r, if r is multiple indices and mat is 2x2, apply to each index, otherwise returns an error if the matrix is not the correct size for the number of indices in r (mat.len() == 2^n).

fn not(&mut self, r: Register) -> Register

Apply NOT to r, if r is multiple indices, apply to each

fn x(&mut self, r: Register) -> Register

Apply X to r, if r is multiple indices, apply to each

fn y(&mut self, r: Register) -> Register

Apply Y to r, if r is multiple indices, apply to each

fn z(&mut self, r: Register) -> Register

Apply Z to r, if r is multiple indices, apply to each

fn hadamard(&mut self, r: Register) -> Register

Apply H to r, if r is multiple indices, apply to each

fn phase(&mut self, r: Register, theta: f64) -> Register

Transforms |psi> to e^{i*theta}|psi>

fn swap(
    &mut self,
    ra: Register,
    rb: Register
) -> Result<(Register, Register), CircuitError>

Apply SWAP to ra and rb

fn merge(&mut self, rs: Vec<Register>) -> Result<Register, CircuitError>

Merge the Registers in rs into a single Register.

fn split(
    &mut self,
    r: Register,
    indices: &[u64]
) -> Result<(Register, Register), CircuitError>

Split the Register r into two Registers, one with relative indices and one with the remaining.

fn split_absolute_many(
    &mut self,
    r: Register,
    index_groups: &[Vec<u64>]
) -> Result<(Vec<Register>, Option<Register>), CircuitError>

Split the Register into many Registers, each with the given set of indices.

fn split_all(&mut self, r: Register) -> Vec<Register>

Split r into a single Register for each index.

fn make_mat_op(
    &self,
    r: &Register,
    data: Vec<Complex<f64>>
) -> Result<UnitaryOp, CircuitError>

Build a generic matrix op.

fn make_sparse_mat_op(
    &self,
    r: &Register,
    data: Vec<Vec<(u64, Complex<f64>)>>,
    natural_order: bool
) -> Result<UnitaryOp, CircuitError>

Build a sparse matrix op

fn make_swap_op(
    &self,
    ra: &Register,
    rb: &Register
) -> Result<UnitaryOp, CircuitError>

Build a swap op. ra and rb must have the same number of indices.

fn make_function_op(
    &self,
    r_in: &Register,
    r_out: &Register,
    f: Box<dyn Fn(u64) -> (u64, f64) + Send + Sync>
) -> Result<UnitaryOp, CircuitError>

Make a function op. f must be boxed so that this function doesn't need to be parameterized.

fn merge_with_indices(
    &mut self,
    into: Register,
    qubits: Vec<Register>,
    at_indices: &[u64]
) -> Result<Register, CircuitError>

Merge a set of qubits into a given qubit at a set of indices

fn merge_with(
    &mut self,
    into: Register,
    qubit_and_index: Vec<(Register, u64)>
) -> Result<Register, CircuitError>

Merge a set of qubits into a given qubit at a set of indices

fn single_register_classical_sidechannel(
    &mut self,
    r: Register,
    handles: &[MeasurementHandle],
    f: Box<dyn Fn(&mut dyn UnitaryBuilder, Register, &[u64]) -> Result<Register, CircuitError>>
) -> Register

Create a circuit portion which depends on the classical results of measuring some Registers.

fn classical_sidechannel(
    &mut self,
    rs: Vec<Register>,
    handles: &[MeasurementHandle],
    f: Box<dyn Fn(&mut dyn UnitaryBuilder, Vec<Register>, &[u64]) -> Result<Vec<Register>, CircuitError>>
) -> Vec<Register>

Create a circuit portion which depends on the classical results of measuring some Registers.

impl Default for OpBuilder

fn default() -> OpBuilder

Returns the "default value" for a type.

impl Debug for OpBuilder

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.