Skip to content

Generate Qiskit 2.2.3 API docs #4159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arnaucasau merged 5 commits into from
Nov 7, 2025
Merged

Generate Qiskit 2.2.3 API docs #4159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c64c3c7
Generate Python API 2.2.3
arnaucasau Oct 30, 2025
85ea84b
Generate C API 2.2.3
arnaucasau Oct 30, 2025
6ca5100
Add support for C API types in the API generation script + add ignores
arnaucasau Nov 7, 2025
40962c7
Generate historical Qiskit C APIs
arnaucasau Nov 7, 2025
f109a37
Regenerate Qiskit C API latest version (v2.2.3)
arnaucasau Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 8 additions & 4 deletions docs/api/qiskit-c/2.1/qk-complex-64.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_

## Functions

**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)**
### qk\_complex64\_to\_native

Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
<Function id="qk_complex64_to_native" signature="static CMPLX_DOUBLE qk_complex64_to_native(QkComplex64 *value)">
Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
</Function>

### Example

Expand All @@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple

A native representation of the complex number.

**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)**
#### qk\_complex64\_from\_native

Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
<Function id="qk_complex64_from_native" signature="static QkComplex64 qk_complex64_from_native(CMPLX_DOUBLE *value)">
Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
</Function>

<span id="id1" />

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/_package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "qiskit-c",
"version": "2.2.1"
"version": "2.2.3"
}
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/qk-bit-term.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The numeric structure of these is that they are all four-bit values of which the

**Parameters**

**bit\_term** – The bit term.
* **bit\_term** – The bit term.

**Returns**

Expand Down
22 changes: 11 additions & 11 deletions docs/api/qiskit-c/qk-circuit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit to copy.
* **circuit** – A pointer to the circuit to copy.

**Returns**

Expand Down Expand Up @@ -305,7 +305,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit.
* **circuit** – A pointer to the circuit.

**Returns**

Expand Down Expand Up @@ -336,7 +336,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit.
* **circuit** – A pointer to the circuit.

**Returns**

Expand Down Expand Up @@ -367,7 +367,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit to free.
* **circuit** – A pointer to the circuit to free.
</Function>

### qk\_circuit\_gate
Expand Down Expand Up @@ -422,7 +422,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**gate** – The `QkGate` to get the number of qubits for.
* **gate** – The `QkGate` to get the number of qubits for.

**Returns**

Expand All @@ -444,7 +444,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**gate** – The `QkGate` to get the number of qubits for.
* **gate** – The `QkGate` to get the number of qubits for.

**Returns**

Expand Down Expand Up @@ -625,7 +625,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit to get the counts for.
* **circuit** – A pointer to the circuit to get the counts for.

**Returns**

Expand Down Expand Up @@ -658,7 +658,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – A pointer to the circuit to get the total number of instructions for.
* **circuit** – A pointer to the circuit to get the total number of instructions for.

**Returns**

Expand Down Expand Up @@ -734,7 +734,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**inst** – A pointer to the instruction to free.
* **inst** – A pointer to the instruction to free.
</Function>

### qk\_opcounts\_clear
Expand All @@ -752,7 +752,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**op\_counts** – The returned op count list from `qk_circuit_count_ops`.
* **op\_counts** – The returned op count list from `qk_circuit_count_ops`.
</Function>

### qk\_circuit\_to\_python
Expand All @@ -774,7 +774,7 @@ The circuit C API currently only supports creating circuits that contain operati

**Parameters**

**circuit** – The C-space `QkCircuit` pointer.
* **circuit** – The C-space `QkCircuit` pointer.

**Returns**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/qk-classical-register.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ While circuits track registers, the registers themselves impart almost no behavi

**Parameters**

**reg** – A pointer to the register to free.
* **reg** – A pointer to the register to free.
</Function>

### qk\_classical\_register\_new
Expand Down
12 changes: 8 additions & 4 deletions docs/api/qiskit-c/qk-complex-64.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_

## Functions

**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)**
### qk\_complex64\_to\_native

Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
<Function id="qk_complex64_to_native" signature="static CMPLX_DOUBLE qk_complex64_to_native(QkComplex64 *value)">
Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
</Function>

### Example

Expand All @@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple

A native representation of the complex number.

**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)**
#### qk\_complex64\_from\_native

Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
<Function id="qk_complex64_from_native" signature="static QkComplex64 qk_complex64_from_native(CMPLX_DOUBLE *value)">
Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details.
</Function>

<span id="id1" />

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/qk-obs-term.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This is a group of functions for interacting with an opaque (Rust-space) SparseT

**Parameters**

**term** – A pointer to the term.
* **term** – A pointer to the term.

**Returns**

Expand Down
28 changes: 14 additions & 14 deletions docs/api/qiskit-c/qk-obs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**num\_qubits** – The number of qubits the observable is defined on.
* **num\_qubits** – The number of qubits the observable is defined on.

**Returns**

Expand All @@ -176,7 +176,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**num\_qubits** – The number of qubits the observable is defined on.
* **num\_qubits** – The number of qubits the observable is defined on.

**Returns**

Expand Down Expand Up @@ -259,7 +259,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable to free.
* **obs** – A pointer to the observable to free.
</Function>

### qk\_obs\_add\_term
Expand Down Expand Up @@ -369,7 +369,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -400,7 +400,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -431,7 +431,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -469,7 +469,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -521,7 +521,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -567,7 +567,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -615,7 +615,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -889,7 +889,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the observable.
* **obs** – A pointer to the observable.

**Returns**

Expand Down Expand Up @@ -960,7 +960,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – A pointer to the `QkObs` to get the string for.
* **obs** – A pointer to the `QkObs` to get the string for.

**Returns**

Expand All @@ -982,7 +982,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`.
* **string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`.
</Function>

### qk\_obs\_to\_python
Expand All @@ -1002,7 +1002,7 @@ for (size_t i = 0; i < num_terms; i++) {

**Parameters**

**obs** – The C-space `QkObs` pointer.
* **obs** – The C-space `QkObs` pointer.

**Returns**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/qk-quantum-register.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@ While circuits track registers, the registers themselves impart almost no behavi

**Parameters**

**reg** – A pointer to the register to free.
* **reg** – A pointer to the register to free.
</Function>

6 changes: 3 additions & 3 deletions docs/api/qiskit-c/qk-target-entry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);

**Parameters**

**operation** – The `QkGate` whose properties this target entry defines. If the `QkGate` takes parameters (which can be checked with `qk_gate_num_params`) it will be added as a an instruction on the target which accepts any parameter value. If the gate only accepts a fixed parameter value you can use `qk_target_entry_new_fixed` instead.
* **operation** – The `QkGate` whose properties this target entry defines. If the `QkGate` takes parameters (which can be checked with `qk_gate_num_params`) it will be added as a an instruction on the target which accepts any parameter value. If the gate only accepts a fixed parameter value you can use `qk_target_entry_new_fixed` instead.

**Returns**

Expand Down Expand Up @@ -172,7 +172,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);

**Parameters**

**entry** – The pointer to the mapping object.
* **entry** – The pointer to the mapping object.

**Returns**

Expand Down Expand Up @@ -207,7 +207,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);

**Parameters**

**entry** – The pointer to the mapping object to be freed.
* **entry** – The pointer to the mapping object to be freed.
</Function>

### qk\_target\_entry\_add\_property
Expand Down
Loading