Bases: StateEncoder
Prepare a computational-basis state \(\lvert k\rangle\).
An integer \(k\) in \(0 .. 2^n - 1\) becomes the one-hot vector with a 1
at index \(k\). A length-\(n\) sequence of bits \(b_0, b_1, \ldots, b_{n-1}\)
uses the same layout as tensor: \(b_0\) is
the most significant qubit, and
\[
k = \sum_{i=0}^{n-1} b_i \, 2^{n-1-i}.
\]
So [1, 0] on two qubits is \(\lvert 10\rangle\), index 2.
Parameters:
-
num_qubits
(int)
–
Number of qubits \(n\). Must be a non-negative integer.
Examples:
from shadowsim.encoding import ComputationalBasisEncoding
encoder = ComputationalBasisEncoding(2)
print(encoder.encode(2).to_numpy())
print(encoder.encode([1, 0]).to_numpy())
[0.+0.j 0.+0.j 1.+0.j 0.+0.j]
[0.+0.j 0.+0.j 1.+0.j 0.+0.j]
Source code in shadowsim/encoding/computational_basis.py
| class ComputationalBasisEncoding(StateEncoder):
r"""Prepare a computational-basis state \(\lvert k\rangle\).
An integer \(k\) in \(0 .. 2^n - 1\) becomes the one-hot vector with a 1
at index \(k\). A length-\(n\) sequence of bits \(b_0, b_1, \ldots, b_{n-1}\)
uses the same layout as ``tensor``: \(b_0\) is
the most significant qubit, and
\[
k = \sum_{i=0}^{n-1} b_i \, 2^{n-1-i}.
\]
So ``[1, 0]`` on two qubits is \(\lvert 10\rangle\), index 2.
Args:
num_qubits: Number of qubits \(n\). Must be a non-negative integer.
Examples:
```python exec="1" source="above" result="text"
from shadowsim.encoding import ComputationalBasisEncoding
encoder = ComputationalBasisEncoding(2)
print(encoder.encode(2).to_numpy())
print(encoder.encode([1, 0]).to_numpy())
```
"""
def __init__(self, num_qubits: int) -> None:
"""Store the number of qubits this encoding prepares."""
assert num_qubits >= 0, "num_qubits must be non-negative"
assert isinstance(num_qubits, int), "num_qubits must be an integer"
self._num_qubits = num_qubits
def encode(self, data: npt.ArrayLike) -> State:
r"""Return the computational-basis state for an index or a bit string.
Args:
data: Integer index \(k\), or a length-``num_qubits`` sequence of
bits 0 and 1. The first bit is the most significant qubit.
Returns:
One-hot state \(\lvert k\rangle\).
Raises:
ValueError: If ``data`` is not an in-range index or a valid bit string.
"""
index = _basis_index(self._num_qubits, data)
vector = np.zeros(2**self._num_qubits, dtype=np.complex128)
vector[index] = 1.0
return State(vector, self._num_qubits)
|
__init__
__init__(num_qubits: int) -> None
Store the number of qubits this encoding prepares.
Source code in shadowsim/encoding/computational_basis.py
| def __init__(self, num_qubits: int) -> None:
"""Store the number of qubits this encoding prepares."""
assert num_qubits >= 0, "num_qubits must be non-negative"
assert isinstance(num_qubits, int), "num_qubits must be an integer"
self._num_qubits = num_qubits
|
encode
encode(data: ArrayLike) -> State
Return the computational-basis state for an index or a bit string.
Parameters:
-
data
(ArrayLike)
–
Integer index \(k\), or a length-num_qubits sequence of
bits 0 and 1. The first bit is the most significant qubit.
Returns:
-
State
–
One-hot state \(\lvert k\rangle\).
Raises:
-
ValueError
–
If data is not an in-range index or a valid bit string.
Source code in shadowsim/encoding/computational_basis.py
| def encode(self, data: npt.ArrayLike) -> State:
r"""Return the computational-basis state for an index or a bit string.
Args:
data: Integer index \(k\), or a length-``num_qubits`` sequence of
bits 0 and 1. The first bit is the most significant qubit.
Returns:
One-hot state \(\lvert k\rangle\).
Raises:
ValueError: If ``data`` is not an in-range index or a valid bit string.
"""
index = _basis_index(self._num_qubits, data)
vector = np.zeros(2**self._num_qubits, dtype=np.complex128)
vector[index] = 1.0
return State(vector, self._num_qubits)
|