constants.h ¶

enumerator QDMI_DEVICE_SESSION_PARAMETER_CUSTOM3¶

See also

enumerator QDMI_DEVICE_SESSION_PARAMETER_CUSTOM4¶

See also

enumerator QDMI_DEVICE_SESSION_PARAMETER_CUSTOM5¶

See also

enum QDMI_DEVICE_JOB_PARAMETER_T¶

Enum of the device job parameters that can be set via IQM_QDMI_device_job_set_parameter.

If not noted otherwise, parameters are optional and devices must not require them to be set.

Values:

enumerator QDMI_DEVICE_JOB_PARAMETER_PROGRAMFORMAT¶

QDMI_Program_Format The format of the program to be executed.

This parameter is required. The device must support the specified program format. If the device does not support the specified program format, the IQM_QDMI_device_job_set_parameter function must return QDMI_ERROR_NOTSUPPORTED.

enumerator QDMI_DEVICE_JOB_PARAMETER_PROGRAM¶

void* The program to be executed.

This parameter is required. The program must be in the format specified by the QDMI_DEVICE_JOB_PARAMETER_PROGRAMFORMAT parameter. If the program is invalid, the IQM_QDMI_device_job_set_parameter function must return QDMI_ERROR_INVALIDARGUMENT. If the program is valid, but the device cannot execute it, the IQM_QDMI_device_job_set_parameter function must return QDMI_ERROR_NOTSUPPORTED.

enumerator QDMI_DEVICE_JOB_PARAMETER_SHOTSNUM¶

size_t The number of shots to execute for a quantum circuit job.

If this parameter is not set, a device-specific default is used.

enumerator QDMI_DEVICE_JOB_PARAMETER_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_DEVICE_JOB_PARAMETER_CUSTOM1¶

This enum value is reserved for a custom parameter.

The device defines the meaning and the type of this parameter.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_DEVICE_JOB_PARAMETER_CUSTOM2¶

See also

enumerator QDMI_DEVICE_JOB_PARAMETER_CUSTOM3¶

See also

enumerator QDMI_DEVICE_JOB_PARAMETER_CUSTOM4¶

See also

enumerator QDMI_DEVICE_JOB_PARAMETER_CUSTOM5¶

See also

enum QDMI_DEVICE_JOB_PROPERTY_T¶

Enum of the device job properties that can be queried via IQM_QDMI_device_job_query_property as part of the device interface.

In particular, every parameter’s value that can be set via IQM_QDMI_device_job_set_parameter can be queried.

Values:

enumerator QDMI_DEVICE_JOB_PROPERTY_ID¶

char* (string) The job’s ID.

The ID must uniquely identify a job for the specific device. It should generally be universally unique (such as a UUID), to avoid conflicts with other devices’ job IDs. It may be used to recover a IQM_QDMI_Device_Job handle upon device failure. It may, for example, correspond to the job ID provided by the device’s API or may be generated by the QDMI Device implementation.

enumerator QDMI_DEVICE_JOB_PROPERTY_PROGRAMFORMAT¶: QDMI_Program_Format The format of the program to be executed.

Note

This property returns the value of the QDMI_DEVICE_JOB_PARAMETER_PROGRAMFORMAT parameter.

enumerator QDMI_DEVICE_JOB_PROPERTY_PROGRAM¶: void* The program to be executed.

Note

This property returns the value of the QDMI_DEVICE_JOB_PARAMETER_PROGRAM parameter.

enumerator QDMI_DEVICE_JOB_PROPERTY_SHOTSNUM¶: size_t The number of shots to execute for a quantum circuit job.

Note

This property returns the value of the QDMI_DEVICE_JOB_PARAMETER_SHOTSNUM parameter.

enumerator QDMI_DEVICE_JOB_PROPERTY_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_DEVICE_JOB_PROPERTY_CUSTOM1¶

This enum value is reserved for a custom parameter.

The device defines the meaning and the type of this parameter.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_DEVICE_JOB_PROPERTY_CUSTOM2¶

See also

enumerator QDMI_DEVICE_JOB_PROPERTY_CUSTOM3¶

See also

enumerator QDMI_DEVICE_JOB_PROPERTY_CUSTOM4¶

See also

enumerator QDMI_DEVICE_JOB_PROPERTY_CUSTOM5¶

See also

enum QDMI_DEVICE_PROPERTY_T¶

Enum of the device properties that can be queried via IQM_QDMI_device_session_query_device_property as part of the device interface and via QDMI_device_query_device_property as part of the client interface.

Values:

enumerator QDMI_DEVICE_PROPERTY_NAME¶: char* (string) The name of the device.

enumerator QDMI_DEVICE_PROPERTY_VERSION¶: char* (string) The version of the device.

enumerator QDMI_DEVICE_PROPERTY_STATUS¶: QDMI_Device_Status The status of the device.

enumerator QDMI_DEVICE_PROPERTY_LIBRARYVERSION¶: char* (string) The implemented version of QDMI.

enumerator QDMI_DEVICE_PROPERTY_QUBITSNUM¶: size_t The number of qubits in the device.

enumerator QDMI_DEVICE_PROPERTY_SITES¶

IQM_QDMI_Site* (IQM_QDMI_Site list) The sites of the device.

The returned IQM_QDMI_Site handles may be used to query site and operation properties. The list need not be sorted based on the QDMI_SITE_PROPERTY_INDEX.

: The list returned by this property contains all sites of the device, i.e., regular and zone sites (see QDMI_SITE_PROPERTY_ISZONE). To filter out regular or zone sites, use the function QDMI_device_query_site_property.

enumerator QDMI_DEVICE_PROPERTY_OPERATIONS¶

IQM_QDMI_Operation* (IQM_QDMI_Operation list) The operations supported by the device.

The returned IQM_QDMI_Operation handles may be used to query operation properties.

enumerator QDMI_DEVICE_PROPERTY_COUPLINGMAP¶

IQM_QDMI_Site* (IQM_QDMI_Site list) The coupling map of the device.

The returned list contains pairs of sites that are coupled. The pairs in the list are flattened such that the first site of the pair is at index 2n and the second site is at index 2n+1.

The sites returned in that list are represented as IQM_QDMI_Site handles. For example, consider a 3-site device with a coupling map (0, 1), (1, 2). Additionally, assume site_i is the handle for the i-th site. Then, {site_0, site_1, site_1, site_2} would be returned.

enumerator QDMI_DEVICE_PROPERTY_NEEDSCALIBRATION¶

size_t Whether the device needs calibration.

This flag indicates whether the device needs calibration. A value of zero indicates that the device does not need calibration, while any non-zero value indicates that the device needs calibration. It is up to the device to assign a specific meaning to the non-zero value.

If a device reports that it needs calibration, a calibration run can be triggered by submitting a job with the QDMI_Program_Format set to QDMI_PROGRAM_FORMAT_CALIBRATION.

enumerator QDMI_DEVICE_PROPERTY_PULSESUPPORT¶

QDMI_Device_Pulse_Support_Level Whether the device supports pulse-level control.

This property indicates the level of pulse-level control. If a device supports pulse-level control, it may provide additional functionality for pulse-level programming and execution.

enumerator QDMI_DEVICE_PROPERTY_LENGTHUNIT¶

char* (string) The length unit reported by the device.

The device implementation must report a known SI unit (e.g., “mm”, “um”, or “nm”) for this property. A client querying a length value must first scale it using QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR. The resulting value is then interpreted in the unit specified by this property.

Note

If the device reports any length values, this property must be set.

enumerator QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR¶

double A scale factor for all length values.

The device implementation reports this scale factor. A client must multiply any raw length value received from the device by this factor to obtain the physical length. The unit of the physical length is given by QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

If querying this property returns QDMI_ERROR_NOTSUPPORTED, a client should assume a default value of 1.0.

enumerator QDMI_DEVICE_PROPERTY_DURATIONUNIT¶

char* (string) The duration unit reported by the device.

The device implementation must report a known SI unit (e.g., “ms”, “us”, or “ns”) for this property. A client querying a duration value must first scale it using QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR. The resulting value is then interpreted in the unit specified by this property.

Note

If the device reports any duration values, this property must be set.

enumerator QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR¶

double A scale factor for all duration values.

The device implementation reports this scale factor. A client must multiply any raw duration value received from the device by this factor to obtain the physical duration. The unit of the physical duration is given by QDMI_DEVICE_PROPERTY_DURATIONUNIT.

Note

If querying this property returns QDMI_ERROR_NOTSUPPORTED, a client should assume a default value of 1.0.

enumerator QDMI_DEVICE_PROPERTY_MINATOMDISTANCE¶

uint64_t The raw, unscaled minimum required distance between qubits during quantum computation.

For neutral atom-based devices, qubits (atoms) can be repositioned dynamically. However, a minimum separation must be maintained to prevent collisions and loss of atoms. This property specifies the minimum atom distance.

See also

QDMI_DEVICE_PROPERTY_LENGTHUNIT QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR

: To obtain the physical minimum atom distance, a client must scale the raw value of this property. The physical minimum atom distance is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

Primarily relevant for neutral atom devices supporting dynamic atom arrangement.

enumerator QDMI_DEVICE_PROPERTY_SUPPORTEDPROGRAMFORMATS¶

QDMI_Program_Format* (QDMI_Program_Format list) The program formats supported by the device.

The returned list contains all program formats that the device supports for execution. A client can use this information to determine which program formats can be used when submitting jobs to the device.

enumerator QDMI_DEVICE_PROPERTY_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_DEVICE_PROPERTY_CUSTOM1¶

This enum value is reserved for a custom property.

The device defines the meaning and the type of this property.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_DEVICE_PROPERTY_CUSTOM2¶

See also

enumerator QDMI_DEVICE_PROPERTY_CUSTOM3¶

See also

enumerator QDMI_DEVICE_PROPERTY_CUSTOM4¶

See also

enumerator QDMI_DEVICE_PROPERTY_CUSTOM5¶

See also

enum QDMI_DEVICE_STATUS_T¶

Enum of different status the device can be in.

Values:

enumerator QDMI_DEVICE_STATUS_OFFLINE¶: The device is offline.

enumerator QDMI_DEVICE_STATUS_IDLE¶: The device is idle.

enumerator QDMI_DEVICE_STATUS_BUSY¶: The device is busy.

enumerator QDMI_DEVICE_STATUS_ERROR¶: The device is in an error state.

enumerator QDMI_DEVICE_STATUS_MAINTENANCE¶: The device is in maintenance.

enumerator QDMI_DEVICE_STATUS_CALIBRATION¶: The device is in calibration.

enumerator QDMI_DEVICE_STATUS_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enum QDMI_SITE_PROPERTY_T¶

Enum of the site properties that can be queried via IQM_QDMI_device_session_query_site_property as part of the device interface and via QDMI_device_query_site_property as part of the client interface.

Values:

enumerator QDMI_SITE_PROPERTY_INDEX¶

size_t The unique index (or ID) to identify the site in a program.

The index of a site is used to link the qubits used in a quantum program to the physical sites of the device that can be queried via this interface. Indices may be non-consecutive and need not start at 0. See QDMI_Program_Format for more information on how the site indices map to the qubits in a program.

This property must be available for all sites since it is used to: address the sites in a program.

enumerator QDMI_SITE_PROPERTY_T1¶

uint64_t The raw, unscaled T1 time of a site.

To obtain the physical T1 time, a client must scale the raw value of this property. The physical T1 time is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_DURATIONUNIT.

enumerator QDMI_SITE_PROPERTY_T2¶

uint64_t The raw, unscaled T2 time of a site.

To obtain the physical T2 time, a client must scale the raw value of this property. The physical T2 time is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_DURATIONUNIT.

enumerator QDMI_SITE_PROPERTY_NAME¶: char* (string) The name of a site, e.g., another identifier of the site given by the device.

enumerator QDMI_SITE_PROPERTY_XCOORDINATE¶

int64_t The raw, unscaled X-coordinate of the site.

The X-coordinate is measured relative to some unique origin of the device, i.e., the triple of X-, Y-, and Z-coordinate must be unique to the site.

: To obtain the physical X-coordinate of the site, a client must scale the raw value of this property. The physical X-coordinate of the site is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

This property is mainly required for neutral atom devices to report the location of sites.

enumerator QDMI_SITE_PROPERTY_YCOORDINATE¶

int64_t The raw, unscaled Y-coordinate of the site.

The Y-coordinate is measured relative to some unique origin of the device, i.e., the triple of X-, Y-, and Z-coordinate must be unique to the site.

: To obtain the physical Y-coordinate of the site, a client must scale the raw value of this property. The physical Y-coordinate of the site is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

This property is mainly required for neutral atom devices to report the location of sites.

enumerator QDMI_SITE_PROPERTY_ZCOORDINATE¶

int64_t The raw, unscaled Z-coordinate of the site.

The Z-coordinate is measured relative to some unique origin of the device, i.e., the triple of X-, Y-, and Z-coordinate must be unique to the site.

: To obtain the physical Z-coordinate of the site, a client must scale the raw value of this property. The physical Z-coordinate of the site is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

This property is mainly required for neutral atom devices to report the location of sites.

enumerator QDMI_SITE_PROPERTY_ISZONE¶

bool Whether the site is a zone.

A zone is a site that has a spatial extent, i.e., it is not just a point in space as a regular site. These kind of sites, namely zones, are required to adequately represent global operations that act on all qubits within a certain area, i.e., a zone.

Note

Zones are typically used in neutral atom devices, where the atoms are arranged in a 2D or 3D lattice, and operations can be applied to all atoms within a certain zone. This property defaults to false, i.e., if a device reports QDMI_ERROR_NOTSUPPORTED for this property, it is assumed that the site is a regular site and not a zone.

enumerator QDMI_SITE_PROPERTY_XEXTENT¶

uint64_t The raw, unscaled extent of a zone along the X-axis.

To obtain the physical extent of a zone along the X-axis, a client must scale the raw value of this property. The physical extent of a zone along the X-axis is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

See also

QDMI_DEVICE_PROPERTY_LENGTHUNIT QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR

Note

This property is mainly required for neutral atom devices to report the extent of zones, see QDMI_SITE_PROPERTY_ISZONE. If the site is not a zone, this property must return QDMI_ERROR_NOTSUPPORTED.

enumerator QDMI_SITE_PROPERTY_YEXTENT¶

uint64_t The raw, unscaled extent of a zone along the Y-axis.

To obtain the physical extent of a zone along the Y-axis, a client must scale the raw value of this property. The physical extent of a zone along the Y-axis is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

See also

QDMI_DEVICE_PROPERTY_LENGTHUNIT QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR

Note

This property is mainly required for neutral atom devices to report the extent of zones, see QDMI_SITE_PROPERTY_ISZONE. If the site is not a zone, this property must return QDMI_ERROR_NOTSUPPORTED.

enumerator QDMI_SITE_PROPERTY_ZEXTENT¶

uint64_t The raw, unscaled extent of a zone along the Z-axis.

To obtain the physical extent of a zone along the Z-axis, a client must scale the raw value of this property. The physical extent of a zone along the Z-axis is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

See also

QDMI_DEVICE_PROPERTY_LENGTHUNIT QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR

Note

This property is mainly required for neutral atom devices to report the extent of zones, see QDMI_SITE_PROPERTY_ISZONE. If the site is not a zone, this property must return QDMI_ERROR_NOTSUPPORTED.

enumerator QDMI_SITE_PROPERTY_MODULEINDEX¶

uint64_t an unsigned integer that uniquely identifies the module.

A module is a logical grouping of sites, e.g., one part on a superconducting chip or an array of sites in a neutral atom-based device.

enumerator QDMI_SITE_PROPERTY_SUBMODULEINDEX¶

uint64_t an unsigned integer uniquely identifying the submodule within a module.

A submodule is a repetitive substructure of sites within a module. E.g., for a module (QDMI_SITE_PROPERTY_MODULEINDEX), where the sites are arranged in pairs and the pairs are arranged in a grid, the submodule index would be the index of the pair within the module.

enumerator QDMI_SITE_PROPERTY_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_SITE_PROPERTY_CUSTOM1¶

This enum value is reserved for a custom property.

The device defines the meaning and the type of this property.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_SITE_PROPERTY_CUSTOM2¶

See also

enumerator QDMI_SITE_PROPERTY_CUSTOM3¶

See also

enumerator QDMI_SITE_PROPERTY_CUSTOM4¶

See also

enumerator QDMI_SITE_PROPERTY_CUSTOM5¶

See also

enum QDMI_OPERATION_PROPERTY_T¶

Enum of the operation properties that can be queried via IQM_QDMI_device_session_query_operation_property as part of the device interface and via QDMI_device_query_operation_property as part of the client interface.

Values:

enumerator QDMI_OPERATION_PROPERTY_NAME¶: char* (string) The string identifier of the operation.

enumerator QDMI_OPERATION_PROPERTY_QUBITSNUM¶: size_t The number of qubits involved in the operation.

enumerator QDMI_OPERATION_PROPERTY_PARAMETERSNUM¶: size_t The number of floating point parameters the operation takes.

enumerator QDMI_OPERATION_PROPERTY_DURATION¶

uint64_t The raw, unscaled duration of an operation.

To obtain the physical duration, a client must scale the raw value of this property. The physical duration is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_DURATIONUNIT.

enumerator QDMI_OPERATION_PROPERTY_FIDELITY¶: double The fidelity of an operation.

enumerator QDMI_OPERATION_PROPERTY_INTERACTIONRADIUS¶

uint64_t The raw, unscaled interaction radius of the operation.

The interaction radius is the maximum distance between two qubits that can be involved in the operation. It only applies to multi-qubit gates.

See also

QDMI_DEVICE_PROPERTY_LENGTHUNIT QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR

: To obtain the physical interaction radius, a client must scale the raw value of this property. The physical interaction radius is calculated as: raw_value * scale_factor, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

This property is mainly required for neutral atom devices where atoms representing qubits can be at arbitrary locations. Hence, it is infeasible to define a coupling map. Instead, the coupling of atoms is defined by the interaction radius of the operation.

enumerator QDMI_OPERATION_PROPERTY_BLOCKINGRADIUS¶

uint64_t The raw, unscaled blocking radius of the operation.

The blocking radius is the minimum distance between two qubits that should not be involved in the operation to avoid crosstalk. It only applies to multi-qubit gates.

: To obtain the physical blocking radius, a client must scale the raw value of this property. The physical blocking radius is calculated as: raw_value, where scale_factor is the value of the QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR property. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT.

Note

This property is mainly required for neutral atom devices where atoms representing qubits can be at arbitrary locations. To avoid crosstalk, the blocking radius of the operation must be respected when scheduling operations.

enumerator QDMI_OPERATION_PROPERTY_IDLINGFIDELITY¶

double Fidelity of qubits idling during a global operation.

This property measures the fidelity of qubits that are within the affected area of a global multi-qubit operation but do not actively participate (i.e., they lack an interaction partner within their radius). Even though these qubits undergo an identity operation, errors may still occur, resulting in lower fidelity compared to qubits that are simply idling and not exposed to the operation.

Note

This is especially relevant for neutral atom devices, where global operations (e.g., laser pulses) can impact all atoms in the array, including those not interacting.

enumerator QDMI_OPERATION_PROPERTY_ISZONED¶

bool Whether the operation is a zoned (global) operation.

A zoned (or global) operation is an operation that can be applied simultaneously to all qubits within a specific zone. If this property is true, the operation is considered zoned. If it is false or returns QDMI_ERROR_NOTSUPPORTED, the operation is considered local. The applicability of a zoned operation to specific zones is detailed in QDMI_OPERATION_PROPERTY_SITES.

Note

This property is primarily relevant for neutral atom devices, where a laser can illuminate an entire array of atoms representing qubits.

enumerator QDMI_OPERATION_PROPERTY_SITES¶

IQM_QDMI_Site* (list) The sites to which the operation is applicable.

For local operations (see QDMI_OPERATION_PROPERTY_ISZONED), this property returns a list of tuples. Each tuple contains sites from the list provided by QDMI_DEVICE_PROPERTY_SITES and represents a valid combination for the operation. The number of sites in each tuple matches the value of QDMI_OPERATION_PROPERTY_QUBITSNUM.
For global operations (see QDMI_OPERATION_PROPERTY_ISZONED), this property returns a list of zone sites, i.e., zones where the operation can be applied.

enumerator QDMI_OPERATION_PROPERTY_MEANSHUTTLINGSPEED¶

uint64_t The raw, unscaled mean shuttling speed of an operation.

To obtain the physical speed, a client must scale the raw value of this property. The physical speed is calculated as: raw_value * length_scale_factor / duration_scale_factor. The length_scale_factor is the value of QDMI_DEVICE_PROPERTY_LENGTHSCALEFACTOR and the duration_scale_factor is the value of QDMI_DEVICE_PROPERTY_DURATIONSCALEFACTOR. The resulting value is in units of QDMI_DEVICE_PROPERTY_LENGTHUNIT per QDMI_DEVICE_PROPERTY_DURATIONUNIT.

Note

This property is mainly required for neutral atom devices where atoms representing qubits can be moved to different sites.

enumerator QDMI_OPERATION_PROPERTY_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_OPERATION_PROPERTY_CUSTOM1¶

This enum value is reserved for a custom property.

The device defines the meaning and the type of this property.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_OPERATION_PROPERTY_CUSTOM2¶

See also

enumerator QDMI_OPERATION_PROPERTY_CUSTOM3¶

See also

enumerator QDMI_OPERATION_PROPERTY_CUSTOM4¶

See also

enumerator QDMI_OPERATION_PROPERTY_CUSTOM5¶

See also

enum QDMI_JOB_STATUS_T¶

Enum of the status a job can have.

See also client_job_interface for a description of the job’s lifecycle.

Values:

enumerator QDMI_JOB_STATUS_CREATED¶: The job was created and can be configured via QDMI_job_set_parameter.

enumerator QDMI_JOB_STATUS_SUBMITTED¶: The job was submitted.

enumerator QDMI_JOB_STATUS_QUEUED¶: The job was received, and is waiting to be executed.

enumerator QDMI_JOB_STATUS_RUNNING¶: The job is running, and the result is not yet available.

enumerator QDMI_JOB_STATUS_DONE¶: The job is done, and the result can be retrieved.

enumerator QDMI_JOB_STATUS_CANCELED¶: The job was canceled, and the result is not available.

enumerator QDMI_JOB_STATUS_FAILED¶: An error occurred in the job’s lifecycle.

enum QDMI_PROGRAM_FORMAT_T¶

Enum of formats that can be submitted to the device.

Values:

enumerator QDMI_PROGRAM_FORMAT_QASM2¶

char* (string) An OpenQASM 2.0 program.

A text-based representation of a quantum circuit in the OpenQASM 2.0 language. Devices that claim to support this format must accept programs conforming to the following rules:

The program contains exactly one quantum register named q.
The number of qubits in the quantum register q matches the number of sites in the device.
The program only contains gate identifiers that are reported by the QDMI_OPERATION_PROPERTY_NAME property of the device’s operations.

: Given a program following these rules, the operations in the program are expected to be performed on the physical sites of the device as queried via QDMI_DEVICE_PROPERTY_SITES. Specifically, an operation on q[i] is performed on the i-th site in the list of sites returned by the device.

Note

Devices may decide to support more general OpenQASM 2.0 programs that do not follow these rules, for example, using multiple qubit registers or arbitrary gates. However, in that case, no guarantees can be made about the mapping of qubits in the program to the physical sites of the device.

enumerator QDMI_PROGRAM_FORMAT_QASM3¶

char* (string) An OpenQASM 3 program.

A text-based representation of a quantum circuit in the OpenQASM 3 language. Devices that claim to support this format must accept programs conforming to the same rules as for QDMI_PROGRAM_FORMAT_QASM2.

: Besides the rules for OpenQASM 2.0 programs, OpenQASM 3 programs may be written using physical qubits, which are denoted by $[NUM], with [NUM] being a non-negative integer denoting the physical qubit’s index. If a program uses physical qubits, the operations in the program must be performed on the sites with indices corresponding to the physical qubits in the program.

Note

Devices may decide to support more general OpenQASM 3 programs that do not follow these rules, for example, using multiple qubit registers or arbitrary gates. However, in that case, no guarantees can be made about the mapping of qubits in the program to the physical sites of the device.

enumerator QDMI_PROGRAM_FORMAT_QIRBASESTRING¶

char* (string) A text-based QIR program complying to the QIR base profile.

A text-based representation of a quantum circuit in the Quantum Intermediate Representation (QIR) format; specifically, the QIR base profile. Devices that claim to support this format must accept programs that follow the rules for the QIR base profile and that only contain operations that are reported by the QDMI_OPERATION_PROPERTY_NAME property of the device’s operations (for example, @__quantum__qis__[NAME]__body, where [NAME] is the name of the operation).

: QIR has a similar distinction between dynamically allocated and static hardware qubits as QDMI_PROGRAM_FORMAT_QASM3. The same rules apply for the mapping of qubits in the program to the physical sites of the device. Specifically, if the program only allocates a single register named q with as many qubits as there are sites in the device, the operations in the program are expected to be performed on the physical sites of the device as queried via QDMI_DEVICE_PROPERTY_SITES. If the program uses static qubit addresses (for example, ptr inttoptr (i64 1 to ptr)), the operations in the program must be performed on the sites with indices corresponding to the static qubit addresses in the program.

Note

Devices may decide to support more general QIR programs that do not follow these rules, for example, using multiple qubit registers or arbitrary gates. However, in that case, no guarantees can be made about the mapping of qubits in the program to the physical sites of the device.

enumerator QDMI_PROGRAM_FORMAT_QIRBASEMODULE¶

void* A QIR binary complying to the QIR base profile.

A binary representation of a quantum circuit in the Quantum Intermediate Representation (QIR) format; specifically, the QIR base profile.

See also

QDMI_PROGRAM_FORMAT_QIRBASESTRING for more information on the QIR base profile and the expected behavior of devices supporting this format.

enumerator QDMI_PROGRAM_FORMAT_QIRADAPTIVESTRING¶

char* (string) A text-based QIR program complying to the QIR adaptive profile.

A text-based representation of a quantum circuit in the Quantum Intermediate Representation (QIR) format; specifically, the QIR adaptive profile.

See also

QDMI_PROGRAM_FORMAT_QIRBASESTRING for more information on the QIR base profile and the expected behavior of devices supporting this format.

enumerator QDMI_PROGRAM_FORMAT_QIRADAPTIVEMODULE¶

void* A QIR binary complying to the QIR adaptive profile.

A binary representation of a quantum circuit in the Quantum Intermediate Representation (QIR) format; specifically, the QIR adaptive profile.

See also

QDMI_PROGRAM_FORMAT_QIRBASESTRING for more information on the QIR base profile and the expected behavior of devices supporting this format.

enumerator QDMI_PROGRAM_FORMAT_CALIBRATION¶

void* A calibration program.

This program format is used to request the device to perform a calibration run. Triggering a calibration run does not require a program to be set via QDMI_DEVICE_JOB_PARAMETER_PROGRAM.

enumerator QDMI_PROGRAM_FORMAT_QPY¶

void* A QPY program.

A binary representation of a Qiskit QuantumCircuit in the QPY format.

See also

QDMI_PROGRAM_FORMAT_QASM3 for more information on the expected behavior of devices supporting this format.

enumerator QDMI_PROGRAM_FORMAT_IQMJSON¶

char* (string) A program in the IQM data transfer format.

A text-based, proprietary representation of a quantum circuit in the IQM data transfer format, encoded as a JSON string.

enumerator QDMI_PROGRAM_FORMAT_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_PROGRAM_FORMAT_CUSTOM1¶

This enum value is reserved for a custom program format.

The device defines the meaning and the type of this value.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_PROGRAM_FORMAT_CUSTOM2¶

See also

enumerator QDMI_PROGRAM_FORMAT_CUSTOM3¶

See also

enumerator QDMI_PROGRAM_FORMAT_CUSTOM4¶

See also

enumerator QDMI_PROGRAM_FORMAT_CUSTOM5¶

See also

enum QDMI_JOB_RESULT_T¶

Enum of the formats the results can be returned in.

Values:

enumerator QDMI_JOB_RESULT_SHOTS¶: char* (string) The results of the individual shots as a comma-separated list, for example, “0010,1101,0101,1100,1001,1100” for four qubits and six shots.

enumerator QDMI_JOB_RESULT_HIST_KEYS¶

char* (string) The keys for the histogram of the results.

The histogram of the measurement results is represented as a key-value mapping. This mapping is returned as a list of keys and an equal-length list of values. The corresponding partners of keys and values can be found at the same index in the lists.

This constant denotes the list of keys, QDMI_JOB_RESULT_HIST_VALUES denotes the list of values.

enumerator QDMI_JOB_RESULT_HIST_VALUES¶

size_t* (size_t list) The values for the histogram of the results.

See also

QDMI_JOB_RESULT_HIST_KEY

enumerator QDMI_JOB_RESULT_STATEVECTOR_DENSE¶

double* (double list) The state vector of the result.

The complex amplitudes are stored as a list of real and imaginary parts. The real part of the amplitude is at index 2n and the imaginary part is at index 2n+1. For example, the state vector of a 2-qubit system with amplitudes (0.5, 0.5), (0.5, -0.5), (-0.5, 0.5), (-0.5, -0.5) would be represented as {0.5, 0.5, 0.5, -0.5, -0.5, 0.5, -0.5, -0.5}.

enumerator QDMI_JOB_RESULT_PROBABILITIES_DENSE¶

double* (double list) The probabilities of the result.

The probabilities are stored as a list of real numbers. The probability of the state with index n is at index n in the list. For example, the probabilities of a 2-qubit system with states 00, 01, 10, 11 would be represented as {0.25, 0.25, 0.25, 0.25}.

enumerator QDMI_JOB_RESULT_STATEVECTOR_SPARSE_KEYS¶

char* (string) The keys for the sparse state vector of the result.

The sparse state vector is represented as a key-value mapping. This mapping is returned as a list of keys and an equal-length list of values. The corresponding partners of keys and values can be found at the same index in the lists.

enumerator QDMI_JOB_RESULT_STATEVECTOR_SPARSE_VALUES¶

double* (double list) The values for the sparse state vector of the result.

The complex amplitudes are stored in the same way as the dense state vector, but only for the non-zero amplitudes.

enumerator QDMI_JOB_RESULT_PROBABILITIES_SPARSE_KEYS¶

char* (string) The keys for the sparse probabilities of the result.

The sparse probabilities are represented as a key-value mapping. This mapping is returned as a list of keys and an equal-length list of values. The corresponding partners of keys and values can be found at the same index in the lists.

enumerator QDMI_JOB_RESULT_PROBABILITIES_SPARSE_VALUES¶

double* (double list) The values for the sparse probabilities of the result.

The probabilities are stored in the same way as the dense probabilities, but only for the non-zero probabilities.

enumerator QDMI_JOB_RESULT_MAX¶

The maximum value of the enum.

It can be used by devices for bounds checking and validation of function parameters.

Attention: This value must remain the last regular member of the enum besides the custom members and must be updated when new members are added.

enumerator QDMI_JOB_RESULT_CUSTOM1¶

This enum value is reserved for a custom result.

The device defines the meaning and the type of this result.

Attention: The value of this enum member must not be changed to maintain binary compatibility.

enumerator QDMI_JOB_RESULT_CUSTOM2¶

See also

enumerator QDMI_JOB_RESULT_CUSTOM3¶

See also

enumerator QDMI_JOB_RESULT_CUSTOM4¶

See also

enumerator QDMI_JOB_RESULT_CUSTOM5¶

See also