qgym.utils.gate_encoder module

This module contains the GateEncoder class which can be used for encoding gates to integers and back.

Usage:

>>> from qgym.utils import GateEncoder
>>> encoder = GateEncoder().learn_gates(["x", "y", "z", "cnot", "measure"])
>>> encoded_list = encoder.encode_gates(["x", "x", "measure", "z"])
>>> print(encoded_list)
[1, 1, 5, 3]
>>> encoder.decode_gates(encoded_list)
['x', 'x', 'measure', 'z']

class qgym.utils.gate_encoder.GateEncoder

Bases: object

Learns a set of gates and creates a mapping to integers and back.

__init__()

Initialize the GateEncoder.

__repr__()

Make a string representation without endline characters.

Return type:

str

decode_gates(encoded_gates)

Decode integer encoded gate names to the original gate names based on the gates seen in learn_gates.

Parameters:

• encoded_gates (int | Mapping[int, Any] | Sequence[Gate] | set[int] | list[int] | tuple[int, ...]) – Encoded gates that are to be decoded. The input type

• type. (determines the return)

Raises:

TypeError – When an unsupported type is given

Return type:

str | dict[str, Any] | list[Gate] | set[str] | list[str]

Returns:

Decoded version of encoded_gates. The output structure should resemble the input structure. So a Mapping will return a Dict, while a single int will return a str.

encode_gates(gates)

Encode the gate names (of type str) in gates to integers, based on the gates seen in learn_gates.

Parameters:

gates (str | Mapping[str, Any] | Sequence[Gate] | set[str] | list[str] | tuple[str, ...]) – Gates to encode. The input type determines the return type.

Raises:

TypeError – When an unsupported type is given.

Return type:

int | dict[int, Any] | list[Gate] | set[int] | list[int]

Returns: Integer encoded version of gates. The output structure should resemble

the input structure. So a Mapping will return a Dict, while a single str will return an int.

learn_gates(gates)

Learns the gates names from an Iterable and creates a mapping from unique gate names to integers and back.

Parameters:

gates (Iterable[str]) – Iterable containing the names of the gates that should be learned. The Iterable can contain duplicate names.

Return type:

GateEncoder

Returns:

Self.