Skip to main content

PauliGraph

Struct PauliGraph 

Source
pub struct PauliGraph { /* private fields */ }
Expand description

A tk-pg-core program consisting of a qubit count and an ordered list of operations.

The following structural validity checks are performed at Op insertion time:

  • All Op::Gate operations have valid parameter counts for their gate type.
  • All Op::Gate operations have valid arguments for their gate type, within the valid range.
  • All Pauli graph native operations have Pauli strings with length matching the graph’s qubit count.
  • Conditional bits/values lengths match.
  • Op::BlackBox operations have all argument qubits within the valid range.
  • GateType::BlackBox gates have no conditions, and they must have data.

Implementations§

Source§

impl PauliGraph

Source

pub fn new(n_qubits: usize) -> PauliGraph

Creates a new PauliGraph with the specified number of qubits and an empty Op list.

§Arguments
  • n_qubits (usize) - The number of qubits in the graph.
§Returns
  • Self - A new PauliGraph instance with the specified number of qubits and an empty Op list.
Source

pub fn with_ops(self, ops: Vec<Op>) -> PauliGraph

Returns the graph with its operation list replaced by ops.

§Arguments
  • mut self (Self) - The current graph instance.
  • ops (Vec<Op>) - The new list of Ops to replace the current list.
§Returns
  • Self - The updated graph instance with the new Op list.
§Panics

Panics if any operation in ops fails the structural validity checks.

Source

pub fn add_op(&mut self, op: Op)

Appends a single op to the graph.

§Arguments
  • &mut self (Self) - The current graph instance.
  • op (Op) - The Op to append.
§Panics

Panics if op fails the structural validity checks.

Source

pub fn insert_op(&mut self, index: usize, op: Op)

Inserts op at position index in the Op list.

§Arguments
  • &mut self (Self) - The current graph instance.
  • index (usize) - The position at which to insert the Op.
  • op (Op) - The Op to insert.
§Panics

Panics if op fails the structural validity checks.

Source

pub fn extend(&mut self, other: PauliGraph)

Appends all operations from other onto this graph.

§Arguments
  • &mut self (Self) - The current graph instance.
  • mut other (PauliGraph) - The graph whose operations are to be appended.
§Panics

Panics if the number of qubits in self and other do not match.

Source

pub fn add_conditional_op( &mut self, op: Op, conditional_bits: Vec<usize>, conditional_values: Vec<bool>, )

Appends conditional op.

If the last operation is a Op::ConditionalBox with matching conditions, op is appended into it instead of creating a new box. If conditional_bits is empty, op is added unconditionally via Self::add_op.

§Panics

Panics if op fails the structural validity checks, or if conditional_bits and conditional_values have different lengths.

Source

pub fn insert_conditional_op( &mut self, index: usize, op: Op, conditional_bits: Vec<usize>, conditional_values: Vec<bool>, )

Inserts conditional op at position index.

If the adjacent operation at index - 1 or index is a Op::ConditionalBox with matching conditions, op is merged into it instead of creating a new box. If conditional_bits is empty, op is inserted unconditionally via Self::insert_op.

§Panics

Panics if op fails the structural validity checks, or if conditional_bits and conditional_values have different lengths.

Source

pub fn remove_op(&mut self, index: usize)

Removes the operation at position index.

§Panics

Panics if index is out of bounds.

Source

pub fn swap_ops(&mut self, index1: usize, index2: usize)

Swaps the operations at positions index1 and index2.

§Panics

Panics if index1 or index2 is out of bounds.

Source

pub fn replace_slice(&mut self, range: Range<usize>, new_ops: Vec<Op>)

Replaces the operations in the index range range with new_ops.

§Panics

Panics if any operation in new_ops fails the structural validity checks or if range is out of bounds.

Source

pub fn add_qubit(&mut self)

Increases the qubit count by one, extending all Pauli strings with an identity on the new qubit.

Source

pub fn get_ops(&self) -> &Vec<Op>

Returns the ordered operations in the graph.

Source

pub fn get_n_qubits(&self) -> usize

Returns the number of qubits.

Source

pub fn try_validate(&self) -> Result<(), PauliGraphError>

Validates all operations against the structural validity checks.

§Panics

Panics if any operation fails the structural validity checks.

Trait Implementations§

Source§

impl Clone for PauliGraph

Source§

fn clone(&self) -> PauliGraph

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PauliGraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PauliGraph

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<PauliGraph, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PGRewrite for PauliGraph

Source§

fn can_be_conjugated(&self, i: usize) -> bool

determine if the op can be conjugated

Source§

fn is_left_boundary(&self, i: usize) -> bool

Check if a given operation is at the left boundary of the PauliGraph.
Source§

fn is_right_boundary(&self, i: usize) -> bool

Check if a given operation is at the right boundary of the PauliGraph.
Source§

fn is_clifford(&self, i: usize) -> bool

Check if a given operation is a Clifford operation.
Source§

fn is_identity<T>(&self, i: usize) -> bool
where T: PGTableau,

Check if a given operation is the identity operation.
Source§

fn op_to_tableau<T>(&mut self, i: usize)
where T: PGTableau,

Convert an operation to a tableau representation.
Source§

fn conj_left_op<T>(&mut self, i: usize)
where T: PGTableau,

Given the index of a Clifford operation, conjugate the operation to its left by it.
Source§

fn conj_right_op<T>(&mut self, i: usize)
where T: PGTableau,

Given the index of a Clifford operation, conjugate the operation to its right by it.
Source§

fn do_commute<T>(&self, i: usize, j: usize) -> bool
where T: PGTableau,

Check if two operations commute.
Source§

fn commute_ops<T>(&mut self, i: usize, j: usize)
where T: PGTableau,

Commute two operations.
Source§

fn can_merge(&self, i: usize, j: usize) -> bool

Check if two operations can be merged.
Source§

fn merge_ops<T>(&mut self, i: usize, j: usize)
where T: PGTableau,

Merge two operations.
Source§

impl PartialEq for PauliGraph

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PauliGraph

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PauliGraph

Source§

impl TryFrom<PauliGraphRaw> for PauliGraph

Source§

type Error = String

The type returned in the event of a conversion error.
Source§

fn try_from( raw: PauliGraphRaw, ) -> Result<PauliGraph, <PauliGraph as TryFrom<PauliGraphRaw>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.