Skip to content

Add rust-native apply_operation methods #13143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevinhartman merged 6 commits into from
Sep 17, 2024
Merged

Add rust-native apply_operation methods #13143

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8625f74
Initial: Add rust-native `apply_operation_front` and `apply_operation…
raynelfss Sep 12, 2024
4e0b9f7
Fix: Remove extra blank space
raynelfss Sep 12, 2024
855796d
Fix: Revert changes to python `apply_op` methods.
raynelfss Sep 13, 2024
0dd46d8
Merge branch 'main' into dag_apply_ops
raynelfss Sep 16, 2024
587874e
Fix: Adapt to new `ExtraInstructionProperties` infrastructure.
raynelfss Sep 16, 2024
35c79d6
Format: Change redundant iteration statement for params
raynelfss Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 154 additions & 43 deletions crates/circuit/src/dag_circuit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use std::hash::{Hash, Hasher};

use ahash::RandomState;
use smallvec::SmallVec;

use crate::bit_data::BitData;
use crate::circuit_data::CircuitData;
Expand All @@ -26,7 +27,7 @@ use crate::error::DAGCircuitError;
use crate::imports;
use crate::interner::{Interned, Interner};
use crate::operations::{Operation, OperationRef, Param, PyInstruction, StandardGate};
use crate::packed_instruction::PackedInstruction;
use crate::packed_instruction::{PackedInstruction, PackedOperation};
use crate::rustworkx_core_vnext::isomorphism;
use crate::{BitType, Clbit, Qubit, TupleLikeArg};

Expand Down Expand Up @@ -1681,28 +1682,25 @@ def _format(operand):
let py_op = op.extract::<OperationFromPython>()?;
let qargs = qargs.map(|q| q.value);
let cargs = cargs.map(|c| c.value);
let node = {
Comment thread
raynelfss marked this conversation as resolved.
let qubits_id = self
.qargs_interner
.insert_owned(self.qubits.map_bits(qargs.iter().flatten())?.collect());
let clbits_id = self
.cargs_interner
.insert_owned(self.clbits.map_bits(cargs.iter().flatten())?.collect());
let instr = PackedInstruction {
op: py_op.operation,
qubits: qubits_id,
clbits: clbits_id,
params: (!py_op.params.is_empty()).then(|| Box::new(py_op.params)),
extra_attrs: py_op.extra_attrs,
#[cfg(feature = "cache_pygates")]
py_op: op.unbind().into(),
};

if check {
self.check_op_addition(py, &instr)?;
}
self.push_back(py, instr)?
};
// Map the qargs to is respective indices
let qarg_indices: Vec<Qubit> = self.qubits.map_bits(qargs.iter().flatten())?.collect();
// Map the qargs to is respective indices
let carg_indices: Vec<Clbit> = self.clbits.map_bits(cargs.iter().flatten())?.collect();

let params = (!py_op.params.is_empty()).then_some(py_op.params);

let node = self.apply_operation_back(
py,
py_op.operation,
&qarg_indices,
&carg_indices,
params,
py_op.extra_attrs,
#[cfg(feature = "cache_pygates")]
Some(op.unbind()),
check,
)?;

self.get_node(py, node)
}
Expand Down Expand Up @@ -1735,28 +1733,24 @@ def _format(operand):
let py_op = op.extract::<OperationFromPython>()?;
let qargs = qargs.map(|q| q.value);
let cargs = cargs.map(|c| c.value);
let node = {
let qubits_id = self
.qargs_interner
.insert_owned(self.qubits.map_bits(qargs.iter().flatten())?.collect());
let clbits_id = self
.cargs_interner
.insert_owned(self.clbits.map_bits(cargs.iter().flatten())?.collect());
let instr = PackedInstruction {
op: py_op.operation,
qubits: qubits_id,
clbits: clbits_id,
params: (!py_op.params.is_empty()).then(|| Box::new(py_op.params)),
extra_attrs: py_op.extra_attrs,
#[cfg(feature = "cache_pygates")]
py_op: op.unbind().into(),
};
// Map the qargs to is respective indices
let qarg_indices: Vec<Qubit> = self.qubits.map_bits(qargs.iter().flatten())?.collect();
// Map the qargs to is respective indices
let carg_indices: Vec<Clbit> = self.clbits.map_bits(cargs.iter().flatten())?.collect();

if check {
self.check_op_addition(py, &instr)?;
}
self.push_front(py, instr)?
};
let params = (!py_op.params.is_empty()).then_some(py_op.params);

let node = self.apply_operation_front(
py,
py_op.operation,
&qarg_indices,
&carg_indices,
params,
py_op.extra_attrs,
#[cfg(feature = "cache_pygates")]
Some(op.unbind()),
check,
)?;

self.get_node(py, node)
}
Expand Down Expand Up @@ -5263,6 +5257,123 @@ impl DAGCircuit {
Ok(new_node)
}

/// Apply a [PackedOperation] to the back of the circuit.
#[allow(clippy::too_many_arguments)]
pub fn apply_operation_back(
&mut self,
py: Python,
op: PackedOperation,
qargs: &[Qubit],
cargs: &[Clbit],
params: Option<SmallVec<[Param; 3]>>,
extra_attrs: Option<Box<ExtraInstructionAttributes>>,
#[cfg(feature = "cache_pygates")] py_op: Option<PyObject>,
check: bool,
) -> PyResult<NodeIndex> {
self.inner_apply_op(
py,
op,
qargs,
cargs,
params,
extra_attrs,
#[cfg(feature = "cache_pygates")]
py_op,
check,
false,
)
}

/// Apply a [PackedOperation] to the front of the circuit.
#[allow(clippy::too_many_arguments)]
pub fn apply_operation_front(
&mut self,
py: Python,
op: PackedOperation,
qargs: &[Qubit],
cargs: &[Clbit],
params: Option<SmallVec<[Param; 3]>>,
extra_attrs: Option<Box<ExtraInstructionAttributes>>,
#[cfg(feature = "cache_pygates")] py_op: Option<PyObject>,
check: bool,
) -> PyResult<NodeIndex> {
self.inner_apply_op(
py,
op,
qargs,
cargs,
params,
extra_attrs,
#[cfg(feature = "cache_pygates")]
py_op,
check,
true,
)
}

#[allow(clippy::too_many_arguments)]
fn inner_apply_op(
&mut self,
py: Python,
op: PackedOperation,
qargs: &[Qubit],
cargs: &[Clbit],
params: Option<SmallVec<[Param; 3]>>,
extra_attrs: Option<Box<ExtraInstructionAttributes>>,
#[cfg(feature = "cache_pygates")] py_op: Option<PyObject>,
check: bool,
front: bool,
Comment thread
raynelfss marked this conversation as resolved.
) -> PyResult<NodeIndex> {
// Check that all qargs are within an acceptable range
qargs.iter().try_for_each(|qarg| {
if !(0..self.num_qubits() as u32).contains(&qarg.0) {
return Err(PyValueError::new_err(format!(
"Qubit index {} is out of range. This DAGCircuit currently has only {} qubits.",
qarg.0,
self.num_qubits()
)));
}
Ok(())
})?;
Comment thread
raynelfss marked this conversation as resolved.

// Check that all cargs are within an acceptable range
cargs.iter().try_for_each(|carg| {
if !(0..self.num_clbits() as u32).contains(&carg.0) {
return Err(PyValueError::new_err(format!(
"Clbit index {} is out of range. This DAGCircuit currently has only {} clbits.",
carg.0,
self.num_clbits()
)));
}
Ok(())
})?;

#[cfg(feature = "cache_pygates")]
let py_op = if let Some(py_op) = py_op {
py_op.into()
} else {
OnceCell::new()
};
let packed_instruction = PackedInstruction {
op,
qubits: self.qargs_interner.insert(qargs),
clbits: self.cargs_interner.insert(cargs),
params: params.map(|params: SmallVec<[Param; 3]>| Box::new(params)),
extra_attrs,
#[cfg(feature = "cache_pygates")]
py_op,
};
if check {
self.check_op_addition(py, &packed_instruction)?;
}

if front {
self.push_front(py, packed_instruction)
} else {
self.push_back(py, packed_instruction)
}
}

fn sort_key(&self, node: NodeIndex) -> SortKeyType {
match &self.dag[node] {
NodeType::Operation(packed) => (
Expand Down