Skip to content

Commit dd936d6

Browse files
arnaucasauarnaucasau
authored
Generate Qiskit 2.2.3 API docs (#4159)
The API docs were generated by: ``` npm run gen-api -- -p qiskit -v 2.2.3 npm run gen-api -- -p qiskit-c -v 2.2.3 ``` It also updates our API generation script to support the new C types that the C API is using. The changes can be found in 6ca5100. After it, I regenerated all the C API historical versions to bring possible changes and to verify we didn't introduce any bug.
1 parent a963195 commit dd936d6

File tree

516 files changed

+4753
-8693
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

516 files changed

+4753
-8693
lines changed

‎docs/api/qiskit-c/2.1/qk-complex-64.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_
3232

3333
## Functions
3434

35-
**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)**
35+
### qk\_complex64\_to\_native
3636

37-
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.
37+
<Function id="qk_complex64_to_native" signature="static CMPLX_DOUBLE qk_complex64_to_native(QkComplex64 *value)">
38+
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.
39+
</Function>
3840

3941
### Example
4042

@@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple
5759
5860
A native representation of the complex number.
5961
60-
**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)**
62+
#### qk\_complex64\_from\_native
6163
62-
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.
64+
<Function id="qk_complex64_from_native" signature="static QkComplex64 qk_complex64_from_native(CMPLX_DOUBLE *value)">
65+
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.
66+
</Function>
6367
6468
<span id="id1" />
6569

‎docs/api/qiskit-c/_package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"name": "qiskit-c",
3-
"version": "2.2.1"
3+
"version": "2.2.3"
44
}

‎docs/api/qiskit-c/qk-bit-term.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ The numeric structure of these is that they are all four-bit values of which the
111111

112112
**Parameters**
113113

114-
**bit\_term** – The bit term.
114+
* **bit\_term** – The bit term.
115115

116116
**Returns**
117117

‎docs/api/qiskit-c/qk-circuit.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ The circuit C API currently only supports creating circuits that contain operati
274274

275275
**Parameters**
276276

277-
**circuit** – A pointer to the circuit to copy.
277+
* **circuit** – A pointer to the circuit to copy.
278278

279279
**Returns**
280280

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

306306
**Parameters**
307307

308-
**circuit** – A pointer to the circuit.
308+
* **circuit** – A pointer to the circuit.
309309

310310
**Returns**
311311

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

337337
**Parameters**
338338

339-
**circuit** – A pointer to the circuit.
339+
* **circuit** – A pointer to the circuit.
340340

341341
**Returns**
342342

@@ -367,7 +367,7 @@ The circuit C API currently only supports creating circuits that contain operati
367367
368368
**Parameters**
369369
370-
**circuit** – A pointer to the circuit to free.
370+
* **circuit** – A pointer to the circuit to free.
371371
</Function>
372372
373373
### qk\_circuit\_gate
@@ -422,7 +422,7 @@ The circuit C API currently only supports creating circuits that contain operati
422422

423423
**Parameters**
424424

425-
**gate** – The `QkGate` to get the number of qubits for.
425+
* **gate** – The `QkGate` to get the number of qubits for.
426426

427427
**Returns**
428428

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

445445
**Parameters**
446446

447-
**gate** – The `QkGate` to get the number of qubits for.
447+
* **gate** – The `QkGate` to get the number of qubits for.
448448

449449
**Returns**
450450

@@ -625,7 +625,7 @@ The circuit C API currently only supports creating circuits that contain operati
625625
626626
**Parameters**
627627
628-
**circuit** – A pointer to the circuit to get the counts for.
628+
* **circuit** – A pointer to the circuit to get the counts for.
629629
630630
**Returns**
631631
@@ -658,7 +658,7 @@ The circuit C API currently only supports creating circuits that contain operati
658658

659659
**Parameters**
660660

661-
**circuit** – A pointer to the circuit to get the total number of instructions for.
661+
* **circuit** – A pointer to the circuit to get the total number of instructions for.
662662

663663
**Returns**
664664

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

735735
**Parameters**
736736

737-
**inst** – A pointer to the instruction to free.
737+
* **inst** – A pointer to the instruction to free.
738738
</Function>
739739

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

753753
**Parameters**
754754

755-
**op\_counts** – The returned op count list from `qk_circuit_count_ops`.
755+
* **op\_counts** – The returned op count list from `qk_circuit_count_ops`.
756756
</Function>
757757

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

775775
**Parameters**
776776

777-
**circuit** – The C-space `QkCircuit` pointer.
777+
* **circuit** – The C-space `QkCircuit` pointer.
778778

779779
**Returns**
780780

‎docs/api/qiskit-c/qk-classical-register.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ While circuits track registers, the registers themselves impart almost no behavi
6060

6161
**Parameters**
6262

63-
**reg** – A pointer to the register to free.
63+
* **reg** – A pointer to the register to free.
6464
</Function>
6565

6666
### qk\_classical\_register\_new

‎docs/api/qiskit-c/qk-complex-64.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_
3232

3333
## Functions
3434

35-
**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)**
35+
### qk\_complex64\_to\_native
3636

37-
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.
37+
<Function id="qk_complex64_to_native" signature="static CMPLX_DOUBLE qk_complex64_to_native(QkComplex64 *value)">
38+
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.
39+
</Function>
3840

3941
### Example
4042

@@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple
5759
5860
A native representation of the complex number.
5961
60-
**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)**
62+
#### qk\_complex64\_from\_native
6163
62-
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.
64+
<Function id="qk_complex64_from_native" signature="static QkComplex64 qk_complex64_from_native(CMPLX_DOUBLE *value)">
65+
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.
66+
</Function>
6367
6468
<span id="id1" />
6569

‎docs/api/qiskit-c/qk-obs-term.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ This is a group of functions for interacting with an opaque (Rust-space) SparseT
9292
9393
**Parameters**
9494
95-
**term** – A pointer to the term.
95+
* **term** – A pointer to the term.
9696
9797
**Returns**
9898

‎docs/api/qiskit-c/qk-obs.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ for (size_t i = 0; i < num_terms; i++) {
154154

155155
**Parameters**
156156

157-
**num\_qubits** – The number of qubits the observable is defined on.
157+
* **num\_qubits** – The number of qubits the observable is defined on.
158158

159159
**Returns**
160160

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

177177
**Parameters**
178178

179-
**num\_qubits** – The number of qubits the observable is defined on.
179+
* **num\_qubits** – The number of qubits the observable is defined on.
180180

181181
**Returns**
182182

@@ -259,7 +259,7 @@ for (size_t i = 0; i < num_terms; i++) {
259259
260260
**Parameters**
261261
262-
**obs** – A pointer to the observable to free.
262+
* **obs** – A pointer to the observable to free.
263263
</Function>
264264
265265
### qk\_obs\_add\_term
@@ -369,7 +369,7 @@ for (size_t i = 0; i < num_terms; i++) {
369369

370370
**Parameters**
371371

372-
**obs** – A pointer to the observable.
372+
* **obs** – A pointer to the observable.
373373

374374
**Returns**
375375

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

401401
**Parameters**
402402

403-
**obs** – A pointer to the observable.
403+
* **obs** – A pointer to the observable.
404404

405405
**Returns**
406406

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

432432
**Parameters**
433433

434-
**obs** – A pointer to the observable.
434+
* **obs** – A pointer to the observable.
435435

436436
**Returns**
437437

@@ -469,7 +469,7 @@ for (size_t i = 0; i < num_terms; i++) {
469469
470470
**Parameters**
471471
472-
**obs** – A pointer to the observable.
472+
* **obs** – A pointer to the observable.
473473
474474
**Returns**
475475
@@ -521,7 +521,7 @@ for (size_t i = 0; i < num_terms; i++) {
521521
522522
**Parameters**
523523
524-
**obs** – A pointer to the observable.
524+
* **obs** – A pointer to the observable.
525525
526526
**Returns**
527527
@@ -567,7 +567,7 @@ for (size_t i = 0; i < num_terms; i++) {
567567

568568
**Parameters**
569569

570-
**obs** – A pointer to the observable.
570+
* **obs** – A pointer to the observable.
571571

572572
**Returns**
573573

@@ -615,7 +615,7 @@ for (size_t i = 0; i < num_terms; i++) {
615615
616616
**Parameters**
617617
618-
**obs** – A pointer to the observable.
618+
* **obs** – A pointer to the observable.
619619
620620
**Returns**
621621
@@ -889,7 +889,7 @@ for (size_t i = 0; i < num_terms; i++) {
889889

890890
**Parameters**
891891

892-
**obs** – A pointer to the observable.
892+
* **obs** – A pointer to the observable.
893893

894894
**Returns**
895895

@@ -960,7 +960,7 @@ for (size_t i = 0; i < num_terms; i++) {
960960
961961
**Parameters**
962962
963-
**obs** – A pointer to the `QkObs` to get the string for.
963+
* **obs** – A pointer to the `QkObs` to get the string for.
964964
965965
**Returns**
966966
@@ -982,7 +982,7 @@ for (size_t i = 0; i < num_terms; i++) {
982982
983983
**Parameters**
984984
985-
**string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`.
985+
* **string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`.
986986
</Function>
987987
988988
### qk\_obs\_to\_python
@@ -1002,7 +1002,7 @@ for (size_t i = 0; i < num_terms; i++) {
10021002
10031003
**Parameters**
10041004
1005-
**obs** – The C-space `QkObs` pointer.
1005+
* **obs** – The C-space `QkObs` pointer.
10061006
10071007
**Returns**
10081008

‎docs/api/qiskit-c/qk-quantum-register.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,6 @@ While circuits track registers, the registers themselves impart almost no behavi
9191
9292
**Parameters**
9393
94-
**reg** – A pointer to the register to free.
94+
* **reg** – A pointer to the register to free.
9595
</Function>
9696

‎docs/api/qiskit-c/qk-target-entry.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
4848

4949
**Parameters**
5050

51-
**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.
51+
* **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.
5252

5353
**Returns**
5454

@@ -172,7 +172,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
172172

173173
**Parameters**
174174

175-
**entry** – The pointer to the mapping object.
175+
* **entry** – The pointer to the mapping object.
176176

177177
**Returns**
178178

@@ -207,7 +207,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
207207
208208
**Parameters**
209209
210-
**entry** – The pointer to the mapping object to be freed.
210+
* **entry** – The pointer to the mapping object to be freed.
211211
</Function>
212212
213213
### qk\_target\_entry\_add\_property

0 commit comments

Comments
 (0)