Struct qip::pipeline::LocalQuantumState

pub struct LocalQuantumState<P: Precision> { /* fields omitted */ }

A basic representation of a quantum state, given by a vector of complex numbers stored locally on the machine (plus an arena of equal size to work in).

Implementations

impl<P: Precision> LocalQuantumState<P>

pub fn new_from_full_state(
    n: u64,
    state: Vec<Complex<P>>,
    order: Representation
) -> Result<LocalQuantumState<P>, CircuitError>

Make a new LocalQuantumState from a fully defined state.

pub fn state_ref(&self) -> &Vec<Complex<P>>

Return a reference to the internal state.

pub fn mut_state_ref(&mut self) -> &mut Vec<Complex<P>>

Return a mutable reference to the internal state.

pub fn clone_state(&mut self, order: Representation) -> Vec<Complex<P>>

Clone the state in either the natural_order or the internal order.

Trait Implementations

impl<P: Precision> Clone for LocalQuantumState<P>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug + Precision> Debug for LocalQuantumState<P>

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

Formats the value using the given formatter.

impl<P: Precision> QuantumState<P> for LocalQuantumState<P>

fn new(n: u64) -> LocalQuantumState<P>

Build a new LocalQuantumState

fn new_from_initial_states(
    n: u64,
    states: &[RegisterInitialState<P>]
) -> LocalQuantumState<P>

Build a local state using a set of initial states for subsets of the qubits. These initial states are made from the qubit handles.

fn n(&self) -> u64

Get number of qubits represented by this state.

fn apply_op_with_name(&mut self, _name: Option<&str>, op: &UnitaryOp)

Apply op with a given name. Mutate self using op.

fn measure(
    &mut self,
    indices: &[u64],
    measured: Option<MeasuredCondition<P>>,
    angle: f64
) -> (u64, P)

Mutate self with measurement, return result as index and probability

fn soft_measure(
    &mut self,
    indices: &[u64],
    measured: Option<u64>,
    angle: f64
) -> (u64, P)

Perform calculations of measure without mutating result. Returns a possible measured value and associated probability.

fn state_magnitude(&self) -> P

Give the total magnitude represented by this state. Most often 1.0

fn stochastic_measure(&mut self, indices: &[u64], angle: f64) -> Vec<P>

Measure stochastically, do not alter internal state. Returns a vector of size 2^indices.len()

fn into_state(self, order: Representation) -> Vec<Complex<P>>

Consume the QuantumState object and return the state as a vector of complex numbers.

fn apply_op(&mut self, op: &UnitaryOp)

Function to mutate self into the state with op applied.

fn rotate_basis(&mut self, indices: &[u64], angle: f64)

Rotate to a new computational basis: |0'> = cos(angle)|0> + sin(angle)|1> |1'> = -sin(angle)|0> + cos(angle)|1>