Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/api/qiskit/capi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ Additionally, this module contains [`ctypes`](https://docs.python.org/3/library/

### qiskit.capi.LIB

<Attribute id="qiskit.capi.LIB" attributeTypeHint="ctypes.PyDLL" attributeTypeHintHref="https://docs.python.org/3/library/ctypes.html">
<Attribute id="qiskit.capi.LIB">
Type: [`ctypes.PyDLL`](https://docs.python.org/3/library/ctypes.html#ctypes.PyDLL)

A [`ctypes`](https://docs.python.org/3/library/ctypes.html#module-ctypes) wrapper around the library containing the Qiskit C API.

This is provided for completeness, though you can access all the functions, structs and enumerations directly from the [`qiskit.capi`](#module-qiskit.capi "qiskit.capi") module object.
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/circuit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,9 @@ The [`SwitchCaseOp`](/docs/api/qiskit/qiskit.circuit.SwitchCaseOp "qiskit.circui

#### qiskit.circuit.CASE\_DEFAULT

<Attribute id="qiskit.circuit.CASE_DEFAULT" attributeValue="<default case>">
<Attribute id="qiskit.circuit.CASE_DEFAULT">
Default value: `<default case>`

A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object.
</Attribute>

Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qasm3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t

##### SWITCH\_CASE\_V1

<Attribute id="qiskit.qasm3.ExperimentalFeatures.SWITCH_CASE_V1" attributeValue="1">
<Attribute id="qiskit.qasm3.ExperimentalFeatures.SWITCH_CASE_V1">
Default value: `1`

Support exporting switch-case statements as proposed by [https://github.com/openqasm/openqasm/pull/463](https://github.com/openqasm/openqasm/pull/463) at [commit bfa787aa3078](https://github.com/openqasm/openqasm/pull/463/commits/bfa787aa3078).

These have the output format:
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.Annotation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ python_api_name: qiskit.circuit.Annotation

### namespace

<Attribute id="qiskit.circuit.Annotation.namespace" attributeValue="''" />
<Attribute id="qiskit.circuit.Annotation.namespace">
Default value: `''`
</Attribute>
</Class>

4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ python_api_name: qiskit.circuit.QuantumCircuit

### name

<Attribute id="qiskit.circuit.QuantumCircuit.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.QuantumCircuit.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.AND.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ python_api_name: qiskit.circuit.library.AND

### name

<Attribute id="qiskit.circuit.library.AND.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.AND.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder

### name

<Attribute id="qiskit.circuit.library.CDKMRippleCarryAdder.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.CDKMRippleCarryAdder.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.Diagonal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ python_api_name: qiskit.circuit.library.Diagonal

### name

<Attribute id="qiskit.circuit.library.Diagonal.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.Diagonal.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder

### name

<Attribute id="qiskit.circuit.library.DraperQFTAdder.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.DraperQFTAdder.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ python_api_name: qiskit.circuit.library.EfficientSU2

### name

<Attribute id="qiskit.circuit.library.EfficientSU2.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.EfficientSU2.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz

### name

<Attribute id="qiskit.circuit.library.EvolvedOperatorAnsatz.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.EvolvedOperatorAnsatz.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.ExactReciprocal.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.ExactReciprocal.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.ExcitationPreserving.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.ExcitationPreserving.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.FourierChecking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ python_api_name: qiskit.circuit.library.FourierChecking

### name

<Attribute id="qiskit.circuit.library.FourierChecking.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.FourierChecking.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations

### name

<Attribute id="qiskit.circuit.library.FunctionalPauliRotations.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.FunctionalPauliRotations.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GMS.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GMS.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GMS.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GR.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GR.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GR.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GRX.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GRX.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GRX.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GRY.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GRY.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GRY.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GRZ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GRZ.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GRZ.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GraphState.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GraphState.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GraphState.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.GroverOperator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.GroverOperator.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.GroverOperator.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier

### name

<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.HRSCumulativeMultiplier.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.HiddenLinearFunction.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.HiddenLinearFunction.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.IQP.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ python_api_name: qiskit.circuit.library.IQP

### name

<Attribute id="qiskit.circuit.library.IQP.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.IQP.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.InnerProduct.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.InnerProduct.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.InnerProduct.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.IntegerComparator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.IntegerComparator.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.IntegerComparator.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.LinearAmplitudeFunction.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.LinearAmplitudeFunction.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.LinearPauliRotations.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.LinearPauliRotations.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.MCMT.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ python_api_name: qiskit.circuit.library.MCMT

### name

<Attribute id="qiskit.circuit.library.MCMT.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.MCMT.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ python_api_name: qiskit.circuit.library.MCMTVChain

### name

<Attribute id="qiskit.circuit.library.MCMTVChain.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.MCMTVChain.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.NLocal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,9 @@ python_api_name: qiskit.circuit.library.NLocal

### name

<Attribute id="qiskit.circuit.library.NLocal.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.NLocal.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.OR.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ python_api_name: qiskit.circuit.library.OR

### name

<Attribute id="qiskit.circuit.library.OR.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.OR.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,9 @@ $$

### name

<Attribute id="qiskit.circuit.library.PauliFeatureMap.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.PauliFeatureMap.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign

### name

<Attribute id="qiskit.circuit.library.PauliTwoDesign.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.PauliTwoDesign.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
4 changes: 3 additions & 1 deletion docs/api/qiskit/qiskit.circuit.library.Permutation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ python_api_name: qiskit.circuit.library.Permutation

### name

<Attribute id="qiskit.circuit.library.Permutation.name" attributeTypeHint="str" attributeTypeHintHref="https://docs.python.org/3/library/stdtypes.html">
<Attribute id="qiskit.circuit.library.Permutation.name">
Type: [`str`](https://docs.python.org/3/library/stdtypes.html#str)

A human-readable name for the circuit.

**Example**
Expand Down
Loading
Loading