Skip to content

Commit ae60a0c

Browse files
arnaucasauarnaucasau
authored
Generate Qiskit 1.4.3 (#3111)
This PR generates the docs for qiskit 1.4.3 (historical) ``` npm run gen-api -- -p qiskit -v 1.4.3 --historical ```
1 parent 479402a commit ae60a0c

File tree

47 files changed

+95
-68
lines changed

Some content is hidden

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

47 files changed

+95
-68
lines changed

‎docs/api/qiskit/1.4/_package.json

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

‎docs/api/qiskit/1.4/converters.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ python_api_name: qiskit.converters
138138

139139
### dag\_to\_circuit
140140

141-
<Function id="qiskit.converters.dag_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/converters/dag_to_circuit.py#L19-L80" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
141+
<Function id="qiskit.converters.dag_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/converters/dag_to_circuit.py#L19-L79" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
142142
Build a `QuantumCircuit` object from a `DAGCircuit`.
143143

144144
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.C3SXGate.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate
88

99
# C3SXGate
1010

11-
<Class id="qiskit.circuit.library.C3SXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L578-L684" signature="qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
11+
<Class id="qiskit.circuit.library.C3SXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L577-L683" signature="qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
1212
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
1313

1414
The 3-qubit controlled sqrt-X gate.

‎docs/api/qiskit/1.4/qiskit.circuit.library.C3XGate.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate
88

99
# C3XGate
1010

11-
<Class id="qiskit.circuit.library.C3XGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L687-L846" signature="qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
11+
<Class id="qiskit.circuit.library.C3XGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L686-L845" signature="qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
1212
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
1313

1414
The X gate controlled on 3 qubits.
@@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.C3XGate
170170

171171
### control
172172

173-
<Function id="qiskit.circuit.library.C3XGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L793-L829" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
173+
<Function id="qiskit.circuit.library.C3XGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L792-L828" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
174174
Controlled version of this gate.
175175

176176
**Parameters**
@@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.C3XGate
191191

192192
### inverse
193193

194-
<Function id="qiskit.circuit.library.C3XGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L831-L843" signature="inverse(annotated=False)">
194+
<Function id="qiskit.circuit.library.C3XGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L830-L842" signature="inverse(annotated=False)">
195195
Invert this gate. The C3X is its own inverse.
196196

197197
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.C4XGate.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate
88

99
# C4XGate
1010

11-
<Class id="qiskit.circuit.library.C4XGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L950-L1092" signature="qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
11+
<Class id="qiskit.circuit.library.C4XGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L949-L1091" signature="qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
1212
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
1313

1414
The 4-qubit controlled X gate.
@@ -175,7 +175,7 @@ python_api_name: qiskit.circuit.library.C4XGate
175175

176176
### control
177177

178-
<Function id="qiskit.circuit.library.C4XGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1039-L1075" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
178+
<Function id="qiskit.circuit.library.C4XGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1038-L1074" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
179179
Controlled version of this gate.
180180

181181
**Parameters**
@@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.library.C4XGate
196196

197197
### inverse
198198

199-
<Function id="qiskit.circuit.library.C4XGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1077-L1089" signature="inverse(annotated=False)">
199+
<Function id="qiskit.circuit.library.C4XGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1076-L1088" signature="inverse(annotated=False)">
200200
Invert this gate. The C4X is its own inverse.
201201

202202
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.CCXGate.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ python_api_name: qiskit.circuit.library.CCXGate
88

99
# CCXGate
1010

11-
<Class id="qiskit.circuit.library.CCXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L304-L498" signature="qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
11+
<Class id="qiskit.circuit.library.CCXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L304-L497" signature="qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)" modifiers="class">
1212
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
1313

1414
CCX gate, also known as Toffoli gate.
1515

16-
Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`ccx()`](qiskit.circuit.QuantumCircuit#ccx "qiskit.circuit.QuantumCircuit.ccx") and `toffoli()` methods.
16+
Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`ccx()`](qiskit.circuit.QuantumCircuit#ccx "qiskit.circuit.QuantumCircuit.ccx") method.
1717

1818
**Circuit symbol:**
1919

@@ -226,7 +226,7 @@ $$
226226

227227
### control
228228

229-
<Function id="qiskit.circuit.library.CCXGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L445-L481" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
229+
<Function id="qiskit.circuit.library.CCXGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L444-L480" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
230230
Controlled version of this gate.
231231

232232
**Parameters**
@@ -247,7 +247,7 @@ $$
247247

248248
### inverse
249249

250-
<Function id="qiskit.circuit.library.CCXGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L483-L495" signature="inverse(annotated=False)">
250+
<Function id="qiskit.circuit.library.CCXGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L482-L494" signature="inverse(annotated=False)">
251251
Return an inverted CCX gate (also a CCX).
252252

253253
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.MCXGate.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate
88

99
# MCXGate
1010

11-
<Class id="qiskit.circuit.library.MCXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1095-L1244" signature="qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
11+
<Class id="qiskit.circuit.library.MCXGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1094-L1243" signature="qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
1212
Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate")
1313

1414
The general, multi-controlled X gate.
@@ -182,7 +182,7 @@ python_api_name: qiskit.circuit.library.MCXGate
182182

183183
### control
184184

185-
<Function id="qiskit.circuit.library.MCXGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1214-L1244" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
185+
<Function id="qiskit.circuit.library.MCXGate.control" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1213-L1243" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
186186
Return a multi-controlled-X gate with more control lines.
187187

188188
**Parameters**
@@ -203,7 +203,7 @@ python_api_name: qiskit.circuit.library.MCXGate
203203

204204
### get\_num\_ancilla\_qubits
205205

206-
<Function id="qiskit.circuit.library.MCXGate.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1173-L1199" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')" modifiers="static">
206+
<Function id="qiskit.circuit.library.MCXGate.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1172-L1198" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')" modifiers="static">
207207
Get the number of required ancilla qubits without instantiating the class.
208208

209209
This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization.
@@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCXGate
224224

225225
### inverse
226226

227-
<Function id="qiskit.circuit.library.MCXGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1159-L1171" signature="inverse(annotated=False)">
227+
<Function id="qiskit.circuit.library.MCXGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1158-L1170" signature="inverse(annotated=False)">
228228
Invert this gate. The MCX is its own inverse.
229229

230230
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.MCXGrayCode.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode
88

99
# MCXGrayCode
1010

11-
<Class id="qiskit.circuit.library.MCXGrayCode" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1247-L1325" signature="qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
11+
<Class id="qiskit.circuit.library.MCXGrayCode" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1246-L1324" signature="qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
1212
Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate")
1313

1414
Implement the multi-controlled X gate using the Gray code.
@@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode
184184

185185
### inverse
186186

187-
<Function id="qiskit.circuit.library.MCXGrayCode.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1305-L1317" signature="inverse(annotated=False)">
187+
<Function id="qiskit.circuit.library.MCXGrayCode.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1304-L1316" signature="inverse(annotated=False)">
188188
Invert this gate. The MCX is its own inverse.
189189

190190
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.MCXRecursive.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive
88

99
# MCXRecursive
1010

11-
<Class id="qiskit.circuit.library.MCXRecursive" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1328-L1398" signature="qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
11+
<Class id="qiskit.circuit.library.MCXRecursive" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1327-L1397" signature="qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)" modifiers="class">
1212
Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate")
1313

1414
Implement the multi-controlled X gate using recursion.
@@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive
191191

192192
### get\_num\_ancilla\_qubits
193193

194-
<Function id="qiskit.circuit.library.MCXRecursive.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1372-L1375" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')" modifiers="static">
194+
<Function id="qiskit.circuit.library.MCXRecursive.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1371-L1374" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')" modifiers="static">
195195
Get the number of required ancilla qubits.
196196

197197
**Parameters**
@@ -202,7 +202,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive
202202

203203
### inverse
204204

205-
<Function id="qiskit.circuit.library.MCXRecursive.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1377-L1389" signature="inverse(annotated=False)">
205+
<Function id="qiskit.circuit.library.MCXRecursive.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1376-L1388" signature="inverse(annotated=False)">
206206
Invert this gate. The MCX is its own inverse.
207207

208208
**Parameters**

‎docs/api/qiskit/1.4/qiskit.circuit.library.MCXVChain.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain
88

99
# MCXVChain
1010

11-
<Class id="qiskit.circuit.library.MCXVChain" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1401-L1529" signature="qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None, relative_phase=False, action_only=False)" modifiers="class">
11+
<Class id="qiskit.circuit.library.MCXVChain" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1400-L1528" signature="qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None, relative_phase=False, action_only=False)" modifiers="class">
1212
Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate")
1313

1414
Implement the multi-controlled X gate using a V-chain of CX gates.
@@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.library.MCXVChain
185185

186186
### get\_num\_ancilla\_qubits
187187

188-
<Function id="qiskit.circuit.library.MCXVChain.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1505-L1508" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')" modifiers="static">
188+
<Function id="qiskit.circuit.library.MCXVChain.get_num_ancilla_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1504-L1507" signature="get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')" modifiers="static">
189189
Get the number of required ancilla qubits.
190190

191191
**Parameters**
@@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.library.MCXVChain
196196

197197
### inverse
198198

199-
<Function id="qiskit.circuit.library.MCXVChain.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1485-L1503" signature="inverse(annotated=False)">
199+
<Function id="qiskit.circuit.library.MCXVChain.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/standard_gates/x.py#L1484-L1502" signature="inverse(annotated=False)">
200200
Invert this gate. The MCX is its own inverse.
201201

202202
**Parameters**

0 commit comments

Comments
 (0)