types.h File Reference

Description

Defines all types used within QDMI across the QDMI Client Interface and the QDMI Device Interface.

Go to the source code of this file.

Typedefs
typedef struct QDMI_Site_impl_d *	QDMI_Site
	A handle for a site.
typedef struct QDMI_Operation_impl_d *	QDMI_Operation
	A handle for an operation.
typedef struct QDMI_Pulse_Parameter_impl_d *	QDMI_Pulse_Parameter
	A handle for a pulse parameter.
typedef struct QDMI_Pulse_Waveform_impl_d *	QDMI_Pulse_Waveform
	A handle for a pulse waveform.
typedef struct QDMI_Pulse_Implementation_impl_d *	QDMI_Pulse_Implementation
	A handle for a pulse implementation.

Typedef Documentation

QDMI_Site

typedef struct QDMI_Site_impl_d* QDMI_Site

A handle for a site.

An opaque pointer to an implementation of the QDMI site concept. A site is a place that can potentially hold a qubit. In case of superconducting qubits, sites can be used synonymously with qubits. In case of neutral atoms, sites represent individual traps that can confine atoms. Those atoms are then used as qubits. To this end, sites are generalizations of qubits that denote locations where qubits can be placed on a device. Each implementation of the QDMI Device Interface defines the actual implementation of the concept.

A simple example of an implementation is a struct that merely contains the site ID, which can be used to identify the site.

struct QDMI_Site_impl_d {
  size_t id;
};

QDMI_Operation

typedef struct QDMI_Operation_impl_d* QDMI_Operation

A handle for an operation.

An opaque pointer to an implementation of the QDMI operation concept. An operation generally represents any instruction that can be executed on a device. This includes gates, measurements, classical control flow elements, movement of qubits, pulse-level instructions, etc. Each implementation of the QDMI Device Interface defines the actual implementation of the concept.

A simple example of an implementation is a struct that merely contains the name of the operation, which can be used to identify the operation.

struct QDMI_Operation_impl_d {
  std::string name;
};

QDMI_Pulse_Parameter

typedef struct QDMI_Pulse_Parameter_impl_d* QDMI_Pulse_Parameter

A handle for a pulse parameter.

An opaque pointer to an implementation of the QDMI pulse parameter concept. A pulse parameter is a variable that can be adjusted to modify the behavior of a pulse. This includes parameters such as amplitude, and duration. Each implementation of the QDMI DeviceInterface" defines the actual implementation of the concept.

QDMI_Pulse_Waveform

typedef struct QDMI_Pulse_Waveform_impl_d* QDMI_Pulse_Waveform

A handle for a pulse waveform.

An opaque pointer to a QDMI pulse waveform concept. A pulse waveform is a representation of the shape of a pulse in time. Each implementation of the QDMI DeviceInterface" defines the actual implementation of the concept.

QDMI_Pulse_Implementation

typedef struct QDMI_Pulse_Implementation_impl_d* QDMI_Pulse_Implementation

A handle for a pulse implementation.

An opaque pointer to a pulse implementation of a QDMI operation. A pulse implementation is a specific way of implementing a pulse on a device, which may include details such as the waveform used, the parameters of the pulse. Each implementation of the QDMI DeviceInterface" defines the actual implementation of the concept.