|
Quantum Resource Management Interface (QRMI) C API
|
Functions | |
| QrmiResourceProvider * | qrmi_provider_new (QrmiResourceType resource_type, const QrmiEnvironmentVariables *environments) |
| QrmiReturnCode | qrmi_provider_free (QrmiResourceProvider *ptr) |
| QrmiReturnCode | qrmi_provider_resources (QrmiResourceProvider *provider, const char *filters, QrmiQuantumResources *resources_out) |
| QrmiReturnCode | qrmi_provider_resources_free (QrmiQuantumResources *resources) |
| QrmiReturnCode | qrmi_provider_least_busy (QrmiResourceProvider *provider, const char *filters, QrmiQuantumResource **resource_out) |
Functions used to dynamically discover quantum resources from a vendor endpoint via the QRMI C API.
| QrmiReturnCode qrmi_provider_free | ( | QrmiResourceProvider * | ptr | ) |
Frees the memory space pointed to by ptr, which must have been returned by a previous call to qrmi_provider_new(). If ptr is NULL, returns NullPointerError.
| (ptr) | [in] A QrmiResourceProvider handle to be freed |
| QrmiReturnCode qrmi_provider_least_busy | ( | QrmiResourceProvider * | provider, |
| const char * | filters, | ||
| QrmiQuantumResource ** | resource_out ) |
Returns the least busy available quantum resource, optionally filtered.
Equivalent to calling qrmi_provider_resources() and taking the first element. If no resources match the filter, *resource_out is set to NULL and the function returns QRMI_RETURN_CODE_SUCCESS.
The returned QrmiQuantumResource handle must be freed with qrmi_resource_free() when no longer needed.
| (provider) | [in] A QrmiResourceProvider handle |
| (filters) | [in] Filter string, or NULL for no filtering |
| (resource_out) | [out] Least busy QrmiQuantumResource handle, or NULL if none found |
| QrmiResourceProvider * qrmi_provider_new | ( | QrmiResourceType | resource_type, |
| const QrmiEnvironmentVariables * | environments ) |
Returns a QrmiResourceProvider handle for the specified resource type and environment.
Created handle must be released with qrmi_provider_free() when no longer needed.
Currently supported resource types:
| (resource_type) | [in] QrmiResourceType variant |
| (environments) | [in] Pointer to QrmiEnvironmentVariables |
| QrmiReturnCode qrmi_provider_resources | ( | QrmiResourceProvider * | provider, |
| const char * | filters, | ||
| QrmiQuantumResources * | resources_out ) |
Returns a list of available quantum resources, optionally filtered.
Results are expected to be sorted in least-busy order.
The caller is responsible for freeing the returned struct with qrmi_provider_resources_free(). Individual handles inside the struct must NOT be freed separately.
key=value pairs joined by &. Supported filters(constraints) are defined by each resource provider's implementation.
| (provider) | [in] A QrmiResourceProvider handle |
| (filters) | [in] Filter string, or NULL for no filtering |
| (resources_out) | [out] Pointer to a QrmiQuantumResources struct to populate |
| QrmiReturnCode qrmi_provider_resources_free | ( | QrmiQuantumResources * | resources | ) |
Frees a QrmiQuantumResources struct populated by qrmi_provider_resources().
This frees both the individual QrmiQuantumResource handles and the internal array. After calling this, the struct's fields are zeroed. Do NOT call qrmi_resource_free() on individual elements after calling this.
| (resources) | [in] Pointer to a QrmiQuantumResources struct to free |