|
| QrmiQuantumResource * | qrmi_resource_new (const char *resource_id, QrmiResourceType resource_type) |
| QrmiQuantumResource * | qrmi_resource_new_from_config (const char *resource_id, QrmiResourceType resource_type, const QrmiConfigMap *config) |
| QrmiReturnCode | qrmi_resource_free (QrmiQuantumResource *ptr) |
| QrmiReturnCode | qrmi_resource_is_accessible (QrmiQuantumResource *qrmi, bool *outp) |
| QrmiReturnCode | qrmi_resource_status (QrmiQuantumResource *qrmi, QrmiResourceStatus **outp) |
| QrmiReturnCode | qrmi_resource_id (QrmiQuantumResource *qrmi, char **outp) |
| QrmiReturnCode | qrmi_resource_type (QrmiQuantumResource *qrmi, QrmiResourceType *outp) |
| QrmiReturnCode | qrmi_resource_acquire (QrmiQuantumResource *qrmi, char **acquisition_token) |
| QrmiReturnCode | qrmi_resource_release (QrmiQuantumResource *qrmi, const char *acquisition_token) |
| QrmiReturnCode | qrmi_resource_task_start (QrmiQuantumResource *qrmi, const QrmiPayload *payload, char **task_id) |
| QrmiReturnCode | qrmi_resource_task_stop (QrmiQuantumResource *qrmi, const char *task_id) |
| QrmiReturnCode | qrmi_resource_task_status (QrmiQuantumResource *qrmi, const char *task_id, QrmiTaskStatus *status) |
| QrmiReturnCode | qrmi_resource_task_result (QrmiQuantumResource *qrmi, const char *task_id, char **outp) |
| QrmiReturnCode | qrmi_resource_task_logs (QrmiQuantumResource *qrmi, const char *task_id, char **outp) |
| QrmiReturnCode | qrmi_resource_target (QrmiQuantumResource *qrmi, char **outp) |
| QrmiReturnCode | qrmi_resource_metadata (QrmiQuantumResource *qrmi, QrmiResourceMetadata **outp) |
Functions used when accessing Quantum resource from the QRMI C API.
◆ qrmi_resource_acquire()
Acquires quantum resource.
Safety
Example
char *acquisition_token;
printf("acquisition token = %s\n", acquisition_token);
}
else {
printf("qrmi_resource_acquire failed.");
}
QrmiReturnCode qrmi_resource_acquire(QrmiQuantumResource *qrmi, char **acquisition_token)
QrmiReturnCode
Definition qrmi.h:55
@ QRMI_RETURN_CODE_SUCCESS
Definition qrmi.h:59
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_free()
Frees the memory space pointed to by ptr, which must have been returned by a previous call to qrmi_resource_new(). Otherwise, or if ptr has already been freed, segmentation fault occurs. If ptr is NULL, returns < 0.
Safety
Example
if (qrmi != NULL) {
}
QrmiQuantumResource * qrmi_resource_new(const char *resource_id, QrmiResourceType resource_type)
QrmiReturnCode qrmi_resource_free(QrmiQuantumResource *ptr)
@ QRMI_RESOURCE_TYPE_IBM_QUANTUM_SYSTEM
Definition qrmi.h:129
struct QrmiQuantumResource QrmiQuantumResource
Definition qrmi.h:227
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_id()
Returns resource identifier.
Safety
◆ qrmi_resource_is_accessible()
Returns true if device is accessible, otherwise false.
- Deprecated
- Use qrmi_resource_status() instead. This function will be removed in a future release.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- The memory pointed to by outp must have enough room to store boolean value.
Example
bool is_accessible = false;
if (is_accessible == false) {
printf("%s cannot be accessed.\n", argv[1]);
}
} else {
printf("qrmi_resource_is_accessible() failed.\n");
}
QrmiReturnCode qrmi_resource_is_accessible(QrmiQuantumResource *qrmi, bool *outp)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_metadata()
Returns a resource metadata
Safety
Example
QrmiReturnCode qrmi_resource_metadata(QrmiQuantumResource *qrmi, QrmiResourceMetadata **outp)
struct QrmiResourceMetadata QrmiResourceMetadata
Definition qrmi.h:232
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_new()
◆ qrmi_resource_new_from_config()
Constructs a QrmiQuantumResource from a config map.
Created QrmiQuantumResource instance needs to be removed by qrmi_resource_free() call if no longer needed.
Safety
- config must be a valid pointer to a QrmiConfigMap struct.
- The memory pointed to by resource_id must contain a valid nul terminator.
- The nul terminator must be within isize::MAX from resource_id
Example
{(char *)"qrmi_warden_url", (char *)"http://localhost:8006"},
{(char *)"qrmi_job_id", (char *)"1"},
{(char *)"qrmi_job_uid", (char *)"1000"},
};
&config);
QrmiQuantumResource * qrmi_resource_new_from_config(const char *resource_id, QrmiResourceType resource_type, const QrmiConfigMap *config)
@ QRMI_RESOURCE_TYPE_PASQAL_LOCAL
Definition qrmi.h:142
QrmiEnvironmentVariables QrmiConfigMap
Definition qrmi.h:305
QrmiKeyValue * variables
Definition qrmi.h:273
size_t length
Definition qrmi.h:277
- Parameters
-
| (resource_id) | [in] A resource identifier, i.e. backend name |
| (resource_type) | [in] QrmiResourceType variant |
| (config) | [in] Pointer to QrmiConfigMap holding the config map |
- Returns
- a QrmiQuantumResource handle if succeeded, otherwise NULL. Must call qrmi_resource_free() to free if no longer used.
- Version
- 0.25.0
◆ qrmi_resource_release()
Releases quantum resource.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- acquisition_token must contain the nul terminator.
- The nul terminator must be within isize::MAX from acquisition_token
Example
char *acquisition_token = NULL;
printf("Failed to release a quantum resource\n");
}
}
QrmiReturnCode qrmi_resource_release(QrmiQuantumResource *qrmi, const char *acquisition_token)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_status()
Returns the status of the specified resource.
Safety
}
QrmiReturnCode qrmi_resource_status(QrmiQuantumResource *qrmi, QrmiResourceStatus **outp)
struct QrmiResourceStatus QrmiResourceStatus
Definition qrmi.h:242
QrmiReturnCode qrmi_resource_status_free(QrmiResourceStatus *ptr)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.25.0
◆ qrmi_resource_target()
Returns a Target for the specified device. Vendor specific serialized data. This might contain the constraints(instructions, properties and timing information etc.) of a particular device to allow compilers to compile an input circuit to something that works and is optimized for a device. In IBM implementation, it contains JSON representations of BackendConfiguration and BackendProperties so that we are able to create a Target object by calling qiskit_ibm_runtime.utils.backend_converter.convert_to_target or uquivalent functions.
Safety
Example
char *target = NULL;
printf("target = %s\n", target);
}
QrmiReturnCode qrmi_resource_target(QrmiQuantumResource *qrmi, char **outp)
QrmiReturnCode qrmi_string_free(char *ptr)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.1.0
◆ qrmi_resource_task_logs()
Returns the log messages of a task.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- outp must be non-null.
- The memory pointed to by task_id must contain a valid nul terminator.
- The nul terminator must be within isize::MAX from task_id
Example
char *logs = NULL;
printf("%s\n", logs);
}
QrmiReturnCode qrmi_resource_task_logs(QrmiQuantumResource *qrmi, const char *task_id, char **outp)
QrmiReturnCode qrmi_resource_task_status(QrmiQuantumResource *qrmi, const char *task_id, QrmiTaskStatus *status)
@ QRMI_TASK_STATUS_COMPLETED
Definition qrmi.h:189
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.1.0
◆ qrmi_resource_task_result()
Returns the result of a task.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- outp must be non-null.
- The memory pointed to by task_id must contain a valid nul terminator.
- The nul terminator must be within isize::MAX from task_id
Example
char *result = NULL;
printf("%s\n", result);
}
QrmiReturnCode qrmi_resource_task_result(QrmiQuantumResource *qrmi, const char *task_id, char **outp)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.1.0
◆ qrmi_resource_task_start()
Starts a task.
Safety
Example
char *job_id = NULL;
const char* input = "your Qiskit estimator primitive input";
printf("Job ID: %s\n", job_id);
}
else {
printf("failed to start a task.\n");
}
QrmiReturnCode qrmi_resource_task_start(QrmiQuantumResource *qrmi, const QrmiPayload *payload, char **task_id)
@ QRMI_PAYLOAD_QISKIT_PRIMITIVE
Definition qrmi.h:325
char * program_id
Definition qrmi.h:353
char * input
Definition qrmi.h:349
QrmiPayload_Tag tag
Definition qrmi.h:446
QrmiPayload_QiskitPrimitive_Body QISKIT_PRIMITIVE
Definition qrmi.h:448
Any failure code other than QrmiReturnCode::QRMI_RETURN_CODE_ERROR means that no task was created: QRMI or the vendor's API refused the request. QrmiReturnCode::QRMI_RETURN_CODE_ERROR leaves that unknown (e.g. a lost response), so the task may exist.
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_task_status()
Returns the status of the specified task.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- The memory pointed to by task_id must contain a valid nul terminator.
- The memory pointed to by status must have enough room to store QrmiTaskStatus value.
- The nul terminator must be within isize::MAX from task_id
Example
while (1) {
break;
}
sleep(1);
}
QrmiTaskStatus
Definition qrmi.h:177
@ QRMI_TASK_STATUS_RUNNING
Definition qrmi.h:185
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_task_stop()
Stops a task.
Safety
- qrmi must have been returned by a previous call to qrmi_resource_new().
- The memory pointed to by task_id must contain a valid nul terminator at the end of the string.
- The nul terminator must be within isize::MAX from task_id
Example
printf("Failed to stop a task\n");
}
QrmiReturnCode qrmi_resource_task_stop(QrmiQuantumResource *qrmi, const char *task_id)
- Parameters
-
- Returns
- QrmiReturnCode::QRMI_RETURN_CODE_SUCCESS if succeeded.
- Version
- 0.6.0
◆ qrmi_resource_type()
Returns resource type.
Safety