Skip to content

Add barrier label rendering with barrier_label_len to the Rust circuit drawer #16598

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

Open
kmbys wants to merge 1 commit into
base: main
Choose a base branch
from
+251 −36
Open

Add barrier label rendering with barrier_label_len to the Rust circuit drawer #16598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 16 additions & 5 deletions crates/cext/src/circuit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ use num_complex::{Complex64, ComplexFloat};
use qiskit_circuit::bit::{ClassicalRegister, QuantumRegister};
use qiskit_circuit::bit::{ShareableClbit, ShareableQubit};
use qiskit_circuit::circuit_data::{CircuitData, CircuitDataError};
use qiskit_circuit::circuit_drawer::draw_circuit;
use qiskit_circuit::circuit_drawer::{DEFAULT_BARRIER_LABEL_LEN, draw_circuit};
use qiskit_circuit::dag_circuit::DAGCircuit;
use qiskit_circuit::instruction::Parameters;
use qiskit_circuit::interner::Interner;
Expand Down Expand Up @@ -2443,6 +2443,10 @@ pub struct CircuitDrawerConfig {
/// to auto-detect console width. Use `SIZE_MAX` to effectively skip
/// wrapping altogether.
fold: usize,
/// Sets the number of characters to display for barrier labels. If
/// this number is exceeded, the label is truncated at that number and
/// '...' is appended. Use 0 to apply the default of 16 characters.
barrier_label_len: usize,
}

/// @ingroup QkCircuit
Expand All @@ -2454,6 +2458,7 @@ pub struct CircuitDrawerConfig {
/// * ``bundle_cregs = true``
/// * ``merge_wires = true``
/// * ``fold = 0``
/// * ``barrier_label_len = 16``
///
/// @return A pointer to a null-terminated string containing the circuit representation.
/// You must use ``qk_str_free`` to release the allocated memory when done.
Expand All @@ -2467,7 +2472,7 @@ pub struct CircuitDrawerConfig {
/// qk_circuit_measure(circuit, 0, 0);
/// qk_circuit_measure(circuit, 1, 0);
///
/// QkCircuitDrawerConfig config = {false, true, 0};
/// QkCircuitDrawerConfig config = {false, true, 0, 16};
///
/// char *circ_str = qk_circuit_draw(circuit, &config);
///
Expand All @@ -2489,7 +2494,7 @@ pub unsafe extern "C" fn qk_circuit_draw(
// SAFETY: Per documentation, the pointer is non-null and aligned.
let circuit = unsafe { const_ptr_as_ref(circuit) };

let (bundle_cregs, merge_wires, fold) = if !config.is_null() {
let (bundle_cregs, merge_wires, fold, barrier_label_len) = if !config.is_null() {
// SAFETY: Per documentation, the pointer is to a valid QkCircuitDrawerConfig struct.
let config = unsafe { const_ptr_as_ref(config) };
(
Expand All @@ -2500,12 +2505,18 @@ pub unsafe extern "C" fn qk_circuit_draw(
} else {
None
},
if config.barrier_label_len != 0 {
config.barrier_label_len
} else {
DEFAULT_BARRIER_LABEL_LEN
},
)
} else {
(true, true, None)
(true, true, None, DEFAULT_BARRIER_LABEL_LEN)
};

let circuit_str = draw_circuit(circuit, bundle_cregs, merge_wires, fold).unwrap();
let circuit_str =
draw_circuit(circuit, bundle_cregs, merge_wires, fold, barrier_label_len).unwrap();

CString::new(circuit_str).unwrap().into_raw()
}
Expand Down
Loading