Struct SerialCircuit

#[non_exhaustive]
pub struct SerialCircuit<P = String> {
    pub name: Option<String>,
    pub phase: P,
    pub commands: Vec<Command<P>>,
    pub qubits: Vec<Qubit>,
    pub bits: Vec<Bit>,
    pub implicit_permutation: Vec<ImplicitPermutation>,
    pub number_of_ws: Option<u64>,
    pub number_of_rs: Option<u64>,
    pub created_qubits: Option<Vec<Qubit>>,
    pub discarded_qubits: Option<Vec<Bit>>,
}

Pytket canonical serialized circuit

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the circuit.

phase: P

The global phase, as a symengine expression.

commands: Vec<Command<P>>

List of commands in the circuit.

qubits: Vec<Qubit>

Input qubits.

bits: Vec<Bit>

Input bits.

implicit_permutation: Vec<ImplicitPermutation>

Implicit permutation of the output qubits.

number_of_ws: Option<u64>

Number of wasm wires in the circuit.

number_of_rs: Option<u64>

Number of RNG wires in the circuit.

created_qubits: Option<Vec<Qubit>>

A list of qubits initialized at the start of the circuit.

discarded_qubits: Option<Vec<Bit>>

A list of qubits discarded at the end of the circuit.

Implementations

impl<P> SerialCircuit<P>

pub fn new(name: Option<String>, phase: P) -> Self

Initialize a new SerialCircuit with the given name and phase.

pub fn map_params<Q>(self, f: impl FnMut(P) -> Q) -> SerialCircuit<Q>

Applies a function over the parameters of the circuit.

Returns a new SerialCircuit with the same data, but with a new generic type for the parameters.

Trait Implementations

impl<P: Clone> Clone for SerialCircuit<P>

fn clone(&self) -> SerialCircuit<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for SerialCircuit<P>

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

Formats the value using the given formatter.

impl<P: Default> Default for SerialCircuit<P>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for SerialCircuit<P>

where P: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: PartialEq> PartialEq for SerialCircuit<P>

fn eq(&self, other: &SerialCircuit<P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> Serialize for SerialCircuit<P>

where P: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P> StructuralPartialEq for SerialCircuit<P>