Struct qip::qubit_chainer::VecRegisterChain

pub struct VecRegisterChain<'a, B: UnitaryBuilder> { /* fields omitted */ }

Chaining struct for a vector of Registers (each may have multiple indices)

Methods

impl<'a, B: UnitaryBuilder> VecRegisterChain<'a, B>

pub fn new(builder: &'a mut B, rs: Vec<Register>) -> Self

Make a new VecRegisterChain, prefer to use chain_vec.

pub fn release(self) -> Vec<Register>

Release the contained vec of Registers.

pub fn rs(self) -> Vec<Register>

Release the contained vec of Registers.

pub fn merge(self) -> SingleRegisterChain<'a, B>

Merge the contained vec of Registers into a single Register.

pub fn partition_by_relative(
    self,
    f: impl Fn(u64) -> bool
) -> Result<DoubleRegisterChain<'a, B>, CircuitError>

Partition the contained Registers into two groups by their index in the underlying vector. Merge each group into a Register and produce a chained struct for the tuple.

pub fn flatten(self) -> Self

Flatten the Registers: make a chain struct representing the vec of all single-index Registers which can be made from the current set of owned indices. Acts as flatten would on a vec of vec of indices.

pub fn apply_merge(
    self,
    f: impl FnOnce(&mut B, Vec<Register>) -> Register
) -> SingleRegisterChain<'a, B>

Apply a function which outputs a single Register.

pub fn apply_partition(
    self,
    f: impl FnOnce(&mut B, Vec<Register>) -> (Register, Register)
) -> DoubleRegisterChain<'a, B>

Apply a function which outputs a tuple of Registers.

pub fn apply(
    self,
    f: impl FnOnce(&mut B, Vec<Register>) -> Vec<Register>
) -> Self

Apply a function which outputs a vector of Registers.

Trait Implementations

impl<'a, B: Debug + UnitaryBuilder> Debug for VecRegisterChain<'a, B>

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

Formats the value using the given formatter.