Skip to content

Commit 190ab7a

Browse files
Update API dev docs (#4138)
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 14a3fb0 commit 190ab7a

File tree

59 files changed

+349
-215
lines changed

Some content is hidden

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

59 files changed

+349
-215
lines changed

docs/api/qiskit-c/dev/_toc.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,6 @@
6565
"title": "QkTranspiler",
6666
"url": "/docs/api/qiskit-c/dev/qk-transpiler"
6767
},
68-
{
69-
"title": "QkVF2LayoutResult",
70-
"url": "/docs/api/qiskit-c/dev/qk-vf-2-layout-result"
71-
},
7268
{
7369
"title": "Transpiler Passes",
7470
"url": "/docs/api/qiskit-c/dev/qk-transpiler-passes"
@@ -77,6 +73,10 @@
7773
"title": "Versioning",
7874
"url": "/docs/api/qiskit-c/dev/version"
7975
},
76+
{
77+
"title": "VF2 compiler-pass objects",
78+
"url": "/docs/api/qiskit-c/dev/qk-vf-2-layout"
79+
},
8080
{
8181
"title": "Release notes",
8282
"url": "/docs/api/qiskit/release-notes"

docs/api/qiskit-c/dev/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Using the transpiler from the C API is intended to only cover circuits created s
4444
* [QkTargetEntry](qk-target-entry)
4545
* [QkTranspileLayout](qk-transpile-layout)
4646
* [Transpiler Passes](qk-transpiler-passes)
47-
* [QkVF2LayoutResult](qk-vf-2-layout-result)
47+
* [VF2 compiler-pass objects](qk-vf-2-layout)
4848
* [QkSabreLayoutOptions](qk-sabre-layout-options)
4949

5050
## Utilities

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
3838
<Function id="qk_target_entry_new" signature="QkTargetEntry *qk_target_entry_new(QkGate operation)">
3939
Creates an entry to the `QkTarget` based on a `QkGate` instance.
4040
41-
<span id="group__QkTargetEntry_1autotoc_md217" />
41+
<span id="group__QkTargetEntry_1autotoc_md222" />
4242
4343
#### Example
4444
@@ -60,7 +60,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
6060
<Function id="qk_target_entry_new_measure" signature="QkTargetEntry *qk_target_entry_new_measure(void)">
6161
Creates a new entry for adding a measurement instruction to a `QkTarget`.
6262

63-
<span id="group__QkTargetEntry_1autotoc_md218" />
63+
<span id="group__QkTargetEntry_1autotoc_md223" />
6464

6565
#### Example
6666

@@ -88,7 +88,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
8888
<Function id="qk_target_entry_new_reset" signature="QkTargetEntry *qk_target_entry_new_reset(void)">
8989
Creates a new entry for adding a reset instruction to a `QkTarget`.
9090
91-
<span id="group__QkTargetEntry_1autotoc_md219" />
91+
<span id="group__QkTargetEntry_1autotoc_md224" />
9292
9393
#### Example
9494
@@ -116,7 +116,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
116116
<Function id="qk_target_entry_new_fixed" signature="QkTargetEntry *qk_target_entry_new_fixed(QkGate operation, double *params)">
117117
Creates an entry in the `QkTarget` based on a `QkGate` instance with no parameters.
118118

119-
<span id="group__QkTargetEntry_1autotoc_md220" />
119+
<span id="group__QkTargetEntry_1autotoc_md225" />
120120

121121
#### Example
122122

@@ -125,11 +125,11 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
125125
QkTargetEntry *entry = qk_target_entry_new_fixed(QkGate_CRX, crx_params);
126126
```
127127
128-
<span id="group__QkTargetEntry_1autotoc_md221" />
128+
<span id="group__QkTargetEntry_1autotoc_md226" />
129129
130130
#### Safety
131131
132-
<span id="group__QkTargetEntry_1autotoc_md221" />
132+
<span id="group__QkTargetEntry_1autotoc_md226" />
133133
134134
The `params` type is expected to be a pointer to an array of `double` where the length matches the expectations of the `QkGate`. If the array is insufficiently long the behavior of this function is undefined as this will read outside the bounds of the array. It can be a null pointer if there are no params for a given gate. You can check `qk_gate_num_params` to determine how many qubits are required for a given gate.
135135
@@ -152,7 +152,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
152152
<Function id="qk_target_entry_num_properties" signature="size_t qk_target_entry_num_properties(const QkTargetEntry *entry)">
153153
Retrieves the number of properties stored in the target entry.
154154
155-
<span id="group__QkTargetEntry_1autotoc_md222" />
155+
<span id="group__QkTargetEntry_1autotoc_md227" />
156156
157157
#### Example
158158
@@ -162,11 +162,11 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
162162
size_t props_size = qk_target_entry_num_properties(entry);
163163
```
164164

165-
<span id="group__QkTargetEntry_1autotoc_md223" />
165+
<span id="group__QkTargetEntry_1autotoc_md228" />
166166

167167
#### Safety
168168

169-
<span id="group__QkTargetEntry_1autotoc_md223" />
169+
<span id="group__QkTargetEntry_1autotoc_md228" />
170170

171171
The behavior is undefined if `entry` is not a valid, non-null pointer to a `QkTargetEntry` object.
172172

@@ -184,7 +184,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
184184
<Function id="qk_target_entry_free" signature="void qk_target_entry_free(QkTargetEntry *entry)">
185185
Frees the entry.
186186

187-
<span id="group__QkTargetEntry_1autotoc_md224" />
187+
<span id="group__QkTargetEntry_1autotoc_md229" />
188188

189189
#### Example
190190

@@ -193,11 +193,11 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
193193
qk_target_entry_free(entry);
194194
```
195195
196-
<span id="group__QkTargetEntry_1autotoc_md225" />
196+
<span id="group__QkTargetEntry_1autotoc_md230" />
197197
198198
#### Safety
199199
200-
<span id="group__QkTargetEntry_1autotoc_md225" />
200+
<span id="group__QkTargetEntry_1autotoc_md230" />
201201
202202
The behavior is undefined if `entry` is not a valid, non-null pointer to a `QkTargetEntry` object.
203203
@@ -215,7 +215,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
215215
<Function id="qk_target_entry_add_property" signature="QkExitCode qk_target_entry_add_property(QkTargetEntry *entry, uint32_t *qargs, uint32_t num_qubits, double duration, double error)">
216216
Adds an instruction property instance based on its assigned qargs.
217217
218-
<span id="group__QkTargetEntry_1autotoc_md226" />
218+
<span id="group__QkTargetEntry_1autotoc_md231" />
219219
220220
#### Example
221221
@@ -225,11 +225,11 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003);
225225
qk_target_entry_add_property(entry, qargs, 2, 0.0, 0.1);
226226
```
227227

228-
<span id="group__QkTargetEntry_1autotoc_md227" />
228+
<span id="group__QkTargetEntry_1autotoc_md232" />
229229

230230
#### Safety
231231

232-
<span id="group__QkTargetEntry_1autotoc_md227" />
232+
<span id="group__QkTargetEntry_1autotoc_md232" />
233233

234234
The behavior is undefined if `entry` is not a valid, non-null pointer to a `QkTargetEntry` object.
235235

0 commit comments

Comments
 (0)