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) -> Self

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>) -> Self

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) -> Self

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

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

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

Source§

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

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

impl PartialEq for PauliGraph

Source§

fn eq(&self, other: &Self) -> 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::Ok, __S::Error>
where __S: Serializer,

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

impl StructuralPartialEq for PauliGraph

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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, 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.