Skip to content

Commit

Permalink
Initial: implement fixed capacity constructor for DAGCircuit
Browse files Browse the repository at this point in the history
- Implement `DAGCircuit` with `with_capacity` to create an initially allocated instance, for rust only.
- Implement `with_capacity` for `BitData` and `IndexInterner` that creates an initally allocated instance of each type.
- Other small tweaks and fixes.
- Add num_edges optional argument. If known, use `num_edges` argument to create a `DAGCircuit` with the exact number of edges.
- Leverage usage of new method in `copy_empty_like`.
- Use `..Default::default()` for `op_names` and `calibrations` fields in `DAGCircuit::with_capacity()`
  • Loading branch information
raynelfss committed Aug 26, 2024
1 parent cc87318 commit 9b9f124
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
9 changes: 9 additions & 0 deletions crates/circuit/src/bit_data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,15 @@ where
}
}

pub fn with_capacity(py: Python<'_>, description: String, capacity: usize) -> Self {
BitData {
description,
bits: Vec::with_capacity(capacity),
indices: HashMap::with_capacity(capacity),
cached: PyList::empty_bound(py).unbind(),
}
}

/// Gets the number of bits.
pub fn len(&self) -> usize {
self.bits.len()
Expand Down
71 changes: 70 additions & 1 deletion crates/circuit/src/dag_circuit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1560,7 +1560,14 @@ def _format(operand):
/// DAGCircuit: An empty copy of self.
#[pyo3(signature = (*, vars_mode="alike"))]
fn copy_empty_like(&self, py: Python, vars_mode: &str) -> PyResult<Self> {
let mut target_dag = DAGCircuit::new(py)?;
let mut target_dag = DAGCircuit::with_capacity(
py,
self.num_qubits(),
self.num_clbits(),
Some(self.num_vars()),
None,
None,
)?;
target_dag.name = self.name.as_ref().map(|n| n.clone_ref(py));
target_dag.global_phase = self.global_phase.clone();
target_dag.duration = self.duration.as_ref().map(|d| d.clone_ref(py));
Expand Down Expand Up @@ -6167,6 +6174,68 @@ impl DAGCircuit {
}
Ok(())
}

/// Alternative constructor, builds a DAGCircuit with a fixed capacity.
///
/// # Arguments:
/// - `py`: Python GIL token
/// - `num_qubits`: Number of qubits in the circuit
/// - `num_clbits`: Number of classical bits in the circuit.
/// - `num_vars`: (Optional) number of variables in the circuit.
/// - `num_ops`: (Optional) number of operations in the circuit.
/// - `num_edges`: (Optional) If known, number of edges in the circuit.
pub fn with_capacity(
py: Python,
num_qubits: usize,
num_clbits: usize,
num_ops: Option<usize>,
num_vars: Option<usize>,
num_edges: Option<usize>,
) -> PyResult<Self> {
let num_ops: usize = num_ops.unwrap_or_default();
let num_vars = num_vars.unwrap_or_default();
let num_edges = num_edges.unwrap_or(
num_qubits + // 1 edge between the input node and the output node or 1st op node.
num_clbits + // 1 edge between the input node and the output node or 1st op node.
num_vars + // 1 edge between the input node and the output node or 1st op node.
num_ops, // In Average there will be 3 edges (2 qubits and 1 clbit, or 3 qubits) per op_node.
);

let num_nodes = num_qubits * 2 + // One input + One output node per qubit
num_clbits * 2 + // One input + One output node per clbit
num_vars * 2 + // One input + output node per variable
num_ops;

Ok(Self {
name: None,
metadata: Some(PyDict::new_bound(py).unbind().into()),
calibrations: HashMap::default(),
dag: StableDiGraph::with_capacity(num_nodes, num_edges),
qregs: PyDict::new_bound(py).unbind(),
cregs: PyDict::new_bound(py).unbind(),
qargs_cache: IndexedInterner::with_capacity(num_qubits),
cargs_cache: IndexedInterner::with_capacity(num_clbits),
qubits: BitData::with_capacity(py, "qubits".to_string(), num_qubits),
clbits: BitData::with_capacity(py, "clbits".to_string(), num_clbits),
global_phase: Param::Float(0.),
duration: None,
unit: "dt".to_string(),
qubit_locations: PyDict::new_bound(py).unbind(),
clbit_locations: PyDict::new_bound(py).unbind(),
qubit_io_map: Vec::with_capacity(num_qubits),
clbit_io_map: Vec::with_capacity(num_clbits),
var_input_map: _VarIndexMap::new(py),
var_output_map: _VarIndexMap::new(py),
op_names: IndexMap::default(),
control_flow_module: PyControlFlowModule::new(py)?,
vars_info: HashMap::with_capacity(num_vars),
vars_by_type: [
PySet::empty_bound(py)?.unbind(),
PySet::empty_bound(py)?.unbind(),
PySet::empty_bound(py)?.unbind(),
],
})
}
}

/// Add to global phase. Global phase can only be Float or ParameterExpression so this
Expand Down
7 changes: 7 additions & 0 deletions crates/circuit/src/interner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,13 @@ impl<T: Eq + Hash> IndexedInterner<T> {
index_lookup: HashMap::new(),
}
}

pub fn with_capacity(capacity: usize) -> Self {
Self {
entries: Vec::with_capacity(capacity),
index_lookup: HashMap::with_capacity(capacity),
}
}
}

impl<T: Eq + Hash> Default for IndexedInterner<T> {
Expand Down

0 comments on commit 9b9f124

Please sign in to comment.