Struct roqoqo_qasm::Backend

pub struct Backend { /* private fields */ }

QASM backend to qoqo

This backend to roqoqo produces QASM output which can be exported.

This backend takes a roqoqo circuit and returns a QASM String or writes a QASM file containing the translated circuit. The circuit itself is translated using the roqoqo-qasm interface. In this backend, the initialization sets up the relevant parameters and the run function calls the QASM interface and writes the QASM file, which is saved to be used by the user on whatever platform they see fit. QASM input is widely supported on various quantum computing platforms.

Implementations

impl Backend

pub fn new( qubit_register_name: Option<String>, qasm_version: Option<String> ) -> Result<Self, RoqoqoBackendError>

Creates new QASM backend.

Arguments

• qubit_register_name - The number of qubits in the backend.
• qasm_version - The version of OpenQASM (2.0 or 3.0) to use.

pub fn circuit_iterator_to_qasm_str<'a>( &self, circuit: impl Iterator<Item = &'a Operation> ) -> Result<String, RoqoqoBackendError>

Translates an iterator over operations to a valid QASM string.

Arguments

• circuit - The iterator over [roqoqo::Operation] items that is translated

Returns

• Ok(String) - The valid QASM string
• RoqoqoBackendError::OperationNotInBackend - An operation is not available on the backend

pub fn circuit_iterator_to_qasm_file<'a>( &self, circuit: impl Iterator<Item = &'a Operation>, folder_name: &Path, filename: &Path, overwrite: bool ) -> Result<(), RoqoqoBackendError>

Translates an iterator over operations to a QASM file.

Arguments

• circuit - The iterator over [roqoqo::Operation] items that is translated
• folder_name - The name of the folder that is prepended to all filenames.
• filename - The name of the file the QASM text is saved to.
• overwrite - Whether to overwrite file if it already exists.

Returns

• Ok(()) - The qasm file was correctly written
• RoqoqoBackendError::FileAlreadyExists - The file at this location already exists

pub fn circuit_to_qasm_str( &self, circuit: &Circuit ) -> Result<String, RoqoqoBackendError>

Translates a Circuit to a valid QASM string.

Arguments

• circuit - The Circuit items that is translated

Returns

• Ok(String) - The valid QASM string
• RoqoqoBackendError::OperationNotInBackend - An operation is not available on the backend

pub fn circuit_to_qasm_file( &self, circuit: &Circuit, folder_name: &Path, filename: &Path, overwrite: bool ) -> Result<(), RoqoqoBackendError>

Translates a Circuit to a QASM file.

Arguments

• circuit - The Circuit that is translated
• folder_name - The name of the folder that is prepended to all filenames.
• filename - The name of the file the QASM text is saved to.
• overwrite - Whether to overwrite file if it already exists.

Returns

• Ok(()) - The qasm file was correctly written
• RoqoqoBackendError::FileAlreadyExists - The file at this location already exists

pub fn file_to_circuit(&self, file: File) -> Result<Circuit, RoqoqoBackendError>

Translates a QASM file into a qoqo Circuit instance.

Arguments

• file - The ‘.qasm’ file to translate.

Returns

• Ok(Circuit) - The translated qoqo Circuit.
• RoqoqoBackendError::GenericError - Error encountered while parsing.

pub fn string_to_circuit( &self, input: &str ) -> Result<Circuit, RoqoqoBackendError>

Translates a QASM string into a qoqo Circuit instance.

Arguments

• input - The QASM string to translate.

Returns

• Ok(Circuit) - The translated qoqo Circuit.
• RoqoqoBackendError::GenericError - Error encountered while parsing.

Trait Implementations

impl Clone for Backend

fn clone(&self) -> Backend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backend

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

Formats the value using the given formatter.

impl PartialEq for Backend

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Backend

impl StructuralPartialEq for Backend