Struct qip::qubits::Register

pub struct Register {
    pub indices: Vec<u64>,
    pub parent: Option<Parent>,
    pub deps: Option<Vec<Rc<Register>>>,
    pub id: u64,
}

A Register object, possible representing multiple physical qubit indices.

Fields

indices: Vec<u64>

The set of indices (qubits) represented by this Register.

parent: Option<Parent>

The parent(s) of this Register (prior in time in the quantum circuit).

deps: Option<Vec<Rc<Register>>>

Additional dependencies for this Register (such as if it relies on the classical measurements of other Register).

id: u64

The unique ID of this Register.

Methods

impl Register

pub fn handle(&self) -> RegisterHandle

Create a handle for feeding values.

pub fn merge_with_modifier(
    id: u64,
    registers: Vec<Register>,
    modifier: Option<StateModifier>
) -> Register

Merge Registers to form a new Register object.

pub fn split(
    ida: u64,
    idb: u64,
    r: Register,
    indices: Vec<u64>
) -> Result<(Register, Register), CircuitError>

Split the relative indices out of r into its own qubit, remaining live in second qubit.

pub fn split_absolute(
    ida: u64,
    idb: u64,
    r: Register,
    selected_indices: Vec<u64>
) -> Result<(Register, Register), CircuitError>

Split a Register in two, with one having the indices in selected_indices

pub fn make_measurement_handle(
    id: u64,
    r: Register
) -> (Register, MeasurementHandle)

Make a measurement handle and a Register which depends on that measurement.

pub fn add_deps(r: Register, deps: Vec<Rc<Register>>) -> Register

Add additional Register dependencies to a given Register.

pub fn n(&self) -> u64

Get number of qubits in this Register object

Trait Implementations

impl Ord for Register

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Register> for Register

fn eq(&self, other: &Register) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Register

impl PartialOrd<Register> for Register

fn partial_cmp(&self, other: &Register) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Register

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

Formats the value using the given formatter.