From a71ebdaf8592d7bf664166df9d1a34863b8b5f1e Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 20 Sep 2024 11:36:01 -0400 Subject: [PATCH] Handle footnotes in API docs (#1987) Closes https://github.com/Qiskit/documentation/issues/1978. --- .../qiskit.aqua.components.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.28/qpy.mdx | 6 ++-- .../0.29/qiskit.algorithms.optimizers.NFT.mdx | 2 +- .../qiskit.aqua.components.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.29/qpy.mdx | 6 ++-- .../0.30/qiskit.algorithms.optimizers.NFT.mdx | 2 +- .../qiskit.aqua.components.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.30/qpy.mdx | 6 ++-- .../0.31/qiskit.algorithms.optimizers.NFT.mdx | 2 +- .../qiskit.aqua.components.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.31/qpy.mdx | 6 ++-- .../0.32/qiskit.algorithms.optimizers.NFT.mdx | 2 +- .../qiskit.aqua.components.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.32/qpy.mdx | 6 ++-- .../0.33/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.33/qpy.mdx | 8 +++--- .../0.35/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.35/qpy.mdx | 8 +++--- .../0.36/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.36/qpy.mdx | 8 +++--- .../0.37/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.37/qpy.mdx | 8 +++--- .../0.38/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.38/qpy.mdx | 8 +++--- .../0.39/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.39/qpy.mdx | 8 +++--- .../0.40/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.40/qpy.mdx | 8 +++--- .../0.41/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.41/qpy.mdx | 8 +++--- .../0.42/qiskit.algorithms.optimizers.NFT.mdx | 2 +- docs/api/qiskit/0.42/qpy.mdx | 8 +++--- .../0.43/qiskit.algorithms.optimizers.NFT.mdx | 4 ++- docs/api/qiskit/0.43/qpy.mdx | 14 +++++++--- .../0.44/qiskit.algorithms.optimizers.NFT.mdx | 4 ++- docs/api/qiskit/0.44/qpy.mdx | 14 +++++++--- .../0.45/qiskit.algorithms.optimizers.NFT.mdx | 4 ++- docs/api/qiskit/0.45/qpy.mdx | 14 +++++++--- .../0.46/qiskit.algorithms.optimizers.NFT.mdx | 4 ++- docs/api/qiskit/0.46/qpy.mdx | 14 +++++++--- docs/api/qiskit/1.0/qpy.mdx | 14 +++++++--- docs/api/qiskit/1.1/qpy.mdx | 14 +++++++--- docs/api/qiskit/dev/qpy.mdx | 14 +++++++--- docs/api/qiskit/qpy.mdx | 14 +++++++--- docs/api/qiskit/release-notes/1.1.mdx | 4 ++- scripts/js/lib/api/processHtml.test.ts | 15 ++++++++++ scripts/js/lib/api/processHtml.ts | 14 ++++++++++ scripts/js/lib/links/ignores.ts | 28 +------------------ 48 files changed, 194 insertions(+), 133 deletions(-) diff --git a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx index e0c837d860..a018c57a17 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.components.optimizers.NFT.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.28/qpy.mdx b/docs/api/qiskit/0.28/qpy.mdx index d72f2a7498..df4a37e28c 100644 --- a/docs/api/qiskit/0.28/qpy.mdx +++ b/docs/api/qiskit/0.28/qpy.mdx @@ -37,7 +37,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -172,7 +172,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a `Paramter`) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a `Paramter`) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER @@ -218,7 +218,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. +this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. **[1](#id1)** diff --git a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx index 0d16ef5573..3fb43ed0c9 100644 --- a/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.29/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx index e2fef891fa..963bfd93d6 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.components.optimizers.NFT.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.29/qpy.mdx b/docs/api/qiskit/0.29/qpy.mdx index 0a36f51f3c..68de1aa564 100644 --- a/docs/api/qiskit/0.29/qpy.mdx +++ b/docs/api/qiskit/0.29/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -200,7 +200,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER @@ -248,7 +248,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. +this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. **[1](#id1)** diff --git a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx index 0d16ef5573..3fb43ed0c9 100644 --- a/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.30/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx index e2fef891fa..963bfd93d6 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.components.optimizers.NFT.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.30/qpy.mdx b/docs/api/qiskit/0.30/qpy.mdx index 0a36f51f3c..68de1aa564 100644 --- a/docs/api/qiskit/0.30/qpy.mdx +++ b/docs/api/qiskit/0.30/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -200,7 +200,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER @@ -248,7 +248,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. +this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. **[1](#id1)** diff --git a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx index 0d16ef5573..3fb43ed0c9 100644 --- a/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.31/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx index e2fef891fa..963bfd93d6 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.components.optimizers.NFT.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.31/qpy.mdx b/docs/api/qiskit/0.31/qpy.mdx index 0a36f51f3c..68de1aa564 100644 --- a/docs/api/qiskit/0.31/qpy.mdx +++ b/docs/api/qiskit/0.31/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -200,7 +200,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER @@ -248,7 +248,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. +this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. **[1](#id1)** diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx index 0d16ef5573..3fb43ed0c9 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx index e2fef891fa..963bfd93d6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.aqua.components.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.32/qpy.mdx b/docs/api/qiskit/0.32/qpy.mdx index 0a36f51f3c..68de1aa564 100644 --- a/docs/api/qiskit/0.32/qpy.mdx +++ b/docs/api/qiskit/0.32/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -200,7 +200,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER @@ -248,7 +248,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. +this matches the internal C representation of Python’s complex type. [3](#f3) Finally, if type is `i` it represents an integer which is an `int64_t`. **[1](#id1)** diff --git a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx index 49c15c5320..e079a19afe 100644 --- a/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.33/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.33/qpy.mdx b/docs/api/qiskit/0.33/qpy.mdx index bb4db3791b..81e38b94d5 100644 --- a/docs/api/qiskit/0.33/qpy.mdx +++ b/docs/api/qiskit/0.33/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -109,7 +109,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#param-vector). @@ -316,7 +316,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#param-expr) struct (on QPY format [Version 3](#version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#param-expr) struct (on QPY format [Version 3](#version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#param-vector) struct. @@ -372,7 +372,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id1)** diff --git a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx index 733bf5f2d0..7e5dbf5c4d 100644 --- a/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.35/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.35/qpy.mdx b/docs/api/qiskit/0.35/qpy.mdx index 8ce1009cef..5f1ea925a2 100644 --- a/docs/api/qiskit/0.35/qpy.mdx +++ b/docs/api/qiskit/0.35/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -159,7 +159,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -372,7 +372,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -428,7 +428,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id1)** diff --git a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx index 733bf5f2d0..7e5dbf5c4d 100644 --- a/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.36/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.36/qpy.mdx b/docs/api/qiskit/0.36/qpy.mdx index 8ce1009cef..5f1ea925a2 100644 --- a/docs/api/qiskit/0.36/qpy.mdx +++ b/docs/api/qiskit/0.36/qpy.mdx @@ -65,7 +65,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -159,7 +159,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -372,7 +372,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -428,7 +428,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id1)** diff --git a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx index f36be0910a..dc997a5881 100644 --- a/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.37/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.37/qpy.mdx b/docs/api/qiskit/0.37/qpy.mdx index 747976fe9f..ba938d2607 100644 --- a/docs/api/qiskit/0.37/qpy.mdx +++ b/docs/api/qiskit/0.37/qpy.mdx @@ -67,7 +67,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -388,7 +388,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -605,7 +605,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -661,7 +661,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx index f36be0910a..dc997a5881 100644 --- a/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.38/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.38/qpy.mdx b/docs/api/qiskit/0.38/qpy.mdx index 747976fe9f..ba938d2607 100644 --- a/docs/api/qiskit/0.38/qpy.mdx +++ b/docs/api/qiskit/0.38/qpy.mdx @@ -67,7 +67,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -388,7 +388,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -605,7 +605,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -661,7 +661,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx index eb945fc61b..0205c1deb2 100644 --- a/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.39/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.39/qpy.mdx b/docs/api/qiskit/0.39/qpy.mdx index 747976fe9f..ba938d2607 100644 --- a/docs/api/qiskit/0.39/qpy.mdx +++ b/docs/api/qiskit/0.39/qpy.mdx @@ -67,7 +67,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -388,7 +388,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -605,7 +605,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -661,7 +661,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx index 8a02c6f680..121eef49e3 100644 --- a/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.40/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.40/qpy.mdx b/docs/api/qiskit/0.40/qpy.mdx index 5322d8b0ec..e5e1856e82 100644 --- a/docs/api/qiskit/0.40/qpy.mdx +++ b/docs/api/qiskit/0.40/qpy.mdx @@ -82,7 +82,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -425,7 +425,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -642,7 +642,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -698,7 +698,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx index 8a02c6f680..121eef49e3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.41/qpy.mdx b/docs/api/qiskit/0.41/qpy.mdx index 1ded55d4a8..bd92b64427 100644 --- a/docs/api/qiskit/0.41/qpy.mdx +++ b/docs/api/qiskit/0.41/qpy.mdx @@ -82,7 +82,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -425,7 +425,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -642,7 +642,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -698,7 +698,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx index 8a02c6f680..121eef49e3 100644 --- a/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.42/qiskit.algorithms.optimizers.NFT.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [1](#id2). **References** diff --git a/docs/api/qiskit/0.42/qpy.mdx b/docs/api/qiskit/0.42/qpy.mdx index 1ded55d4a8..bd92b64427 100644 --- a/docs/api/qiskit/0.42/qpy.mdx +++ b/docs/api/qiskit/0.42/qpy.mdx @@ -82,7 +82,7 @@ struct { } ``` -All values use network byte order [1](#f1) (big endian) for cross platform compatibility. +All values use network byte order [1](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -425,7 +425,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [2](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -642,7 +642,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -698,7 +698,7 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [3](#f3) +this matches the internal C representation of Python’s complex type. [3](#f3) **[1](#id2)** diff --git a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx index cbda3ac733..387595405f 100644 --- a/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.43/qiskit.algorithms.optimizers.NFT.mdx @@ -28,10 +28,12 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). **References** + + \[[1](#id1)] K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization for quantum-classical hybrid algorithms. arXiv preprint arXiv:1903.12166. diff --git a/docs/api/qiskit/0.43/qpy.mdx b/docs/api/qiskit/0.43/qpy.mdx index ae9323a3b1..ca919a1894 100644 --- a/docs/api/qiskit/0.43/qpy.mdx +++ b/docs/api/qiskit/0.43/qpy.mdx @@ -84,7 +84,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -533,7 +533,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -758,7 +758,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -816,16 +816,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id3),[2](#id5)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id7)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx index ed40fe7977..fabcfc36f2 100644 --- a/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.44/qiskit.algorithms.optimizers.NFT.mdx @@ -28,10 +28,12 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). **References** + + \[[1](#id1)] K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization for quantum-classical hybrid algorithms. arXiv preprint arXiv:1903.12166. diff --git a/docs/api/qiskit/0.44/qpy.mdx b/docs/api/qiskit/0.44/qpy.mdx index 354d7d89b7..7ce99449ad 100644 --- a/docs/api/qiskit/0.44/qpy.mdx +++ b/docs/api/qiskit/0.44/qpy.mdx @@ -187,7 +187,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -729,7 +729,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -954,7 +954,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1012,16 +1012,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id3),[2](#id5)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id7)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx index 68a4aea59f..ad541d408c 100644 --- a/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.45/qiskit.algorithms.optimizers.NFT.mdx @@ -28,10 +28,12 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). **References** + + \[[1](#id1)] K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization for quantum-classical hybrid algorithms. arXiv preprint arXiv:1903.12166. diff --git a/docs/api/qiskit/0.45/qpy.mdx b/docs/api/qiskit/0.45/qpy.mdx index aa06388451..d17a566168 100644 --- a/docs/api/qiskit/0.45/qpy.mdx +++ b/docs/api/qiskit/0.45/qpy.mdx @@ -197,7 +197,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -783,7 +783,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1008,7 +1008,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1066,16 +1066,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id4),[2](#id6)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id8)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx index 7456cdbb34..81dcf6a6dc 100644 --- a/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx +++ b/docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx @@ -28,10 +28,12 @@ python_api_name: qiskit.algorithms.optimizers.NFT **Notes** - In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). + In this optimization method, the optimization function have to satisfy three conditions written in [\[1\]](#id2). **References** + + \[[1](#id1)] K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization for quantum-classical hybrid algorithms. arXiv preprint arXiv:1903.12166. diff --git a/docs/api/qiskit/0.46/qpy.mdx b/docs/api/qiskit/0.46/qpy.mdx index c2f062439a..fcce9f8f3f 100644 --- a/docs/api/qiskit/0.46/qpy.mdx +++ b/docs/api/qiskit/0.46/qpy.mdx @@ -197,7 +197,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -783,7 +783,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1006,7 +1006,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1064,16 +1064,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id4),[2](#id6)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id8)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/1.0/qpy.mdx b/docs/api/qiskit/1.0/qpy.mdx index 2cc8ae9b9c..856e945abf 100644 --- a/docs/api/qiskit/1.0/qpy.mdx +++ b/docs/api/qiskit/1.0/qpy.mdx @@ -237,7 +237,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -846,7 +846,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1071,7 +1071,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1129,16 +1129,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id4),[2](#id6)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id8)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/1.1/qpy.mdx b/docs/api/qiskit/1.1/qpy.mdx index e2d26b5025..5e88696181 100644 --- a/docs/api/qiskit/1.1/qpy.mdx +++ b/docs/api/qiskit/1.1/qpy.mdx @@ -295,7 +295,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -979,7 +979,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1202,7 +1202,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1260,16 +1260,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id3),[2](#id5)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id7)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/dev/qpy.mdx b/docs/api/qiskit/dev/qpy.mdx index 6239f8b8e6..a8ca406eea 100644 --- a/docs/api/qiskit/dev/qpy.mdx +++ b/docs/api/qiskit/dev/qpy.mdx @@ -295,7 +295,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -979,7 +979,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1202,7 +1202,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1260,16 +1260,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id3),[2](#id5)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id7)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/qpy.mdx b/docs/api/qiskit/qpy.mdx index 8065191d9b..211a076db0 100644 --- a/docs/api/qiskit/qpy.mdx +++ b/docs/api/qiskit/qpy.mdx @@ -295,7 +295,7 @@ struct { } ``` -All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. +All values use network byte order [\[1\]](#f1) (big endian) for cross platform compatibility. The file header is immediately followed by the circuit payloads. Each individual circuit is composed of the following parts: @@ -979,7 +979,7 @@ struct { } ``` -which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). +which is immediately followed by `pauli_op_size` bytes which are .npy format [\[2\]](#f2) data which represents the [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). Version 3 of the QPY format also defines a struct format to represent a `ParameterVectorElement` as a distinct subclass from a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). This adds a new parameter type char `'v'` to represent a `ParameterVectorElement` which is now supported as a type string value for an INSTRUCTION\_PARAM. The payload for these parameters are defined below as [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector). @@ -1202,7 +1202,7 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#qpy-param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a [PARAMETER](#qpy-param-struct) struct, `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a [PARAMETER\_EXPR](#qpy-param-expr) struct (on QPY format [Version 3](#qpy-version-3) the format is tweak slightly see: [PARAMETER\_EXPR](#qpy-param-expr-v3)), `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [\[2\]](#f2) data, and in QPY [Version 3](#qpy-version-3) `'v'` represents a `ParameterVectorElement` which is represented by a [PARAMETER\_VECTOR\_ELEMENT](#qpy-param-vector) struct. @@ -1260,16 +1260,22 @@ struct { } ``` -this matches the internal C representation of Python’s complex type. [\[3\]](#f3) +this matches the internal C representation of Python’s complex type. [\[3\]](#f3) + + \[[1](#id2)] [https://tools.ietf.org/html/rfc1700](https://tools.ietf.org/html/rfc1700) + + \[2] ([1](#id3),[2](#id5)) [https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html) + + \[[3](#id7)] [https://docs.python.org/3/c-api/complex.html#c.Py\_complex](https://docs.python.org/3/c-api/complex.html#c.Py_complex) diff --git a/docs/api/qiskit/release-notes/1.1.mdx b/docs/api/qiskit/release-notes/1.1.mdx index b4d9269e17..bbf079683a 100644 --- a/docs/api/qiskit/release-notes/1.1.mdx +++ b/docs/api/qiskit/release-notes/1.1.mdx @@ -910,7 +910,9 @@ The Qiskit 1.1.0 release is a minor feature release that includes a myriad of ne ### Other Notes -* Support for the arm64 macOS platform has been promoted from Tier 3 to Tier 1. Previously the platform was at Tier 3 because there was no available CI environment for testing Qiskit on the platform. Now that Github has made an arm64 macOS environment available to open source projects [\[1\]](#id9) we’re testing the platform along with the other Tier 1 supported platforms. +* Support for the arm64 macOS platform has been promoted from Tier 3 to Tier 1. Previously the platform was at Tier 3 because there was no available CI environment for testing Qiskit on the platform. Now that Github has made an arm64 macOS environment available to open source projects [\[1\]](#id9) we’re testing the platform along with the other Tier 1 supported platforms. + + \[[1](#id8)] diff --git a/scripts/js/lib/api/processHtml.test.ts b/scripts/js/lib/api/processHtml.test.ts index 87dbb36eb3..a00989a66b 100644 --- a/scripts/js/lib/api/processHtml.test.ts +++ b/scripts/js/lib/api/processHtml.test.ts @@ -26,6 +26,7 @@ import { replaceViewcodeLinksWithGitHub, convertRubricsToHeaders, processMembersAndSetMeta, + handleFootnotes, } from "./processHtml.js"; import { Metadata } from "./Metadata.js"; import { CheerioDoc } from "../testUtils.js"; @@ -352,6 +353,20 @@ test("convertRubricsToHeaders()", () => {

Methods

`); }); +test("handleFootnotes()", () => { + const doc = CheerioDoc.load(` +

All values use [1] (big endian) for compatibility.

+ `); + handleFootnotes(doc.$, doc.$main); + doc.expectHtml(` +

All values use [1] (big endian) for compatibility.

+ `); +}); + test.describe("maybeSetModuleMetadata()", () => { test("not a module", () => { const html = `

Hello

`; diff --git a/scripts/js/lib/api/processHtml.ts b/scripts/js/lib/api/processHtml.ts index af9a1edece..52c1357e1c 100644 --- a/scripts/js/lib/api/processHtml.ts +++ b/scripts/js/lib/api/processHtml.ts @@ -67,6 +67,7 @@ export async function processHtml(options: { convertRubricsToHeaders($, $main); processSimpleFieldLists($, $main); removeColonSpans($main); + handleFootnotes($, $main); preserveMathBlockWhitespace($, $main); const meta: Metadata = {}; @@ -273,6 +274,19 @@ export function removeColonSpans($main: Cheerio): void { $main.find(".colon").remove(); } +export function handleFootnotes($: CheerioAPI, $main: Cheerio): void { + $main + .find(".footnote, .footnote-reference") + .toArray() + .forEach((footnote) => { + const $footnote = $(footnote); + const id = $footnote.attr("id"); + if (id) { + $footnote.before(``); + } + }); +} + export async function processMembersAndSetMeta( $: CheerioAPI, $main: Cheerio, diff --git a/scripts/js/lib/links/ignores.ts b/scripts/js/lib/links/ignores.ts index 9ab9b38b01..18101dcf1c 100644 --- a/scripts/js/lib/links/ignores.ts +++ b/scripts/js/lib/links/ignores.ts @@ -65,24 +65,6 @@ function mergeFilesToIgnores(...mappings: FilesToIgnores[]): FilesToIgnores { return result; } -const _QISKIT_QPY_IGNORES = Object.fromEntries( - ["", "dev/", "0.46/", "1.0/", "1.1/", "1.2/"].map((vers) => [ - `docs/api/qiskit/${vers}qpy.mdx`, - [ - "#f1", - "#f2", - "#f3", - "#id2", - "#id3", - "#id4", - "#id5", - "#id6", - "#id7", - "#id8", - ], - ]), -); - function _runtimeObjectsInv(): FilesToIgnores { const legacy = Object.fromEntries( ["0.16/", "0.17/", "0.18/", "0.19/", "0.20/", "0.21/", "0.22/"].map( @@ -266,15 +248,7 @@ const FILES_TO_IGNORES__EXPECTED: FilesToIgnores = mergeFilesToIgnores( _runtimeObjectsInv(), ); -const FILES_TO_IGNORES__SHOULD_FIX: FilesToIgnores = mergeFilesToIgnores( - _QISKIT_QPY_IGNORES, - { - "docs/api/qiskit/0.46/qiskit.algorithms.optimizers.NFT.mdx": [ - "#id1", - "#id2", - ], - }, -); +const FILES_TO_IGNORES__SHOULD_FIX: FilesToIgnores = {}; export const FILES_TO_IGNORES: FilesToIgnores = mergeFilesToIgnores( FILES_TO_IGNORES__EXPECTED,