qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/qpy/binary_io/value.py

@@ -0,0 +1,1025 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2021, 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Binary IO for any value objects, such as numbers, string, parameters."""
+
+from __future__ import annotations
+
+import collections.abc
+import io
+import struct
+import uuid
+
+import numpy as np
+import symengine
+
+
+from qiskit.circuit import CASE_DEFAULT, Clbit, ClassicalRegister
+from qiskit.circuit.classical import expr, types
+from qiskit.circuit.parameter import Parameter
+from qiskit.circuit.parameterexpression import (
+    ParameterExpression,
+    op_code_to_method,
+    _OPCode,
+    _SUBS,
+)
+from qiskit.circuit.parametervector import ParameterVector, ParameterVectorElement
+from qiskit.qpy import common, formats, exceptions, type_keys
+
+
+def _write_parameter(file_obj, obj):
+    name_bytes = obj.name.encode(common.ENCODE)
+    file_obj.write(struct.pack(formats.PARAMETER_PACK, len(name_bytes), obj.uuid.bytes))
+    file_obj.write(name_bytes)
+
+
+def _write_parameter_vec(file_obj, obj):
+    name_bytes = obj._vector._name.encode(common.ENCODE)
+    file_obj.write(
+        struct.pack(
+            formats.PARAMETER_VECTOR_ELEMENT_PACK,
+            len(name_bytes),
+            len(obj._vector),
+            obj.uuid.bytes,
+            obj._index,
+        )
+    )
+    file_obj.write(name_bytes)
+
+
+def _encode_replay_entry(inst, file_obj, version, r_side=False):
+    inst_type = None
+    inst_data = None
+    if inst is None:
+        inst_type = "n"
+        inst_data = b"\x00"
+    elif isinstance(inst, Parameter):
+        inst_type = "p"
+        inst_data = inst.uuid.bytes
+    elif isinstance(inst, complex):
+        inst_type = "c"
+        inst_data = struct.pack("!dd", inst.real, inst.imag)
+    elif isinstance(inst, float):
+        inst_type = "f"
+        inst_data = struct.pack("!Qd", 0, inst)
+    elif isinstance(inst, int):
+        inst_type = "i"
+        inst_data = struct.pack("!Qq", 0, inst)
+    elif isinstance(inst, ParameterExpression):
+        if not r_side:
+            entry = struct.pack(
+                formats.PARAM_EXPR_ELEM_V13_PACK,
+                255,
+                "s".encode("utf8"),
+                b"\x00",
+                "n".encode("utf8"),
+                b"\x00",
+            )
+        else:
+            entry = struct.pack(
+                formats.PARAM_EXPR_ELEM_V13_PACK,
+                255,
+                "n".encode("utf8"),
+                b"\x00",
+                "s".encode("utf8"),
+                b"\x00",
+            )
+        file_obj.write(entry)
+        _write_parameter_expression_v13(file_obj, inst, version)
+        if not r_side:
+            entry = struct.pack(
+                formats.PARAM_EXPR_ELEM_V13_PACK,
+                255,
+                "e".encode("utf8"),
+                b"\x00",
+                "n".encode("utf8"),
+                b"\x00",
+            )
+        else:
+            entry = struct.pack(
+                formats.PARAM_EXPR_ELEM_V13_PACK,
+                255,
+                "n".encode("utf8"),
+                b"\x00",
+                "e".encode("utf8"),
+                b"\x00",
+            )
+        file_obj.write(entry)
+        inst_type = "n"
+        inst_data = b"\x00"
+    else:
+        raise exceptions.QpyError("Invalid parameter expression type")
+    return inst_type, inst_data
+
+
+def _encode_replay_subs(subs, file_obj, version):
+    with io.BytesIO() as mapping_buf:
+        subs_dict = {k.name: v for k, v in subs.binds.items()}
+        common.write_mapping(
+            mapping_buf, mapping=subs_dict, serializer=dumps_value, version=version
+        )
+        data = mapping_buf.getvalue()
+    entry = struct.pack(
+        formats.PARAM_EXPR_ELEM_V13_PACK,
+        subs.op,
+        "u".encode("utf8"),
+        struct.pack("!QQ", len(data), 0),
+        "n".encode("utf8"),
+        b"\x00",
+    )
+    file_obj.write(entry)
+    file_obj.write(data)
+    return subs.binds
+
+
+def _write_parameter_expression_v13(file_obj, obj, version):
+    symbol_map = {}
+    for inst in obj._qpy_replay:
+        if isinstance(inst, _SUBS):
+            symbol_map.update(_encode_replay_subs(inst, file_obj, version))
+            continue
+        lhs_type, lhs = _encode_replay_entry(inst.lhs, file_obj, version)
+        rhs_type, rhs = _encode_replay_entry(inst.rhs, file_obj, version, True)
+        entry = struct.pack(
+            formats.PARAM_EXPR_ELEM_V13_PACK,
+            inst.op,
+            lhs_type.encode("utf8"),
+            lhs,
+            rhs_type.encode("utf8"),
+            rhs,
+        )
+        file_obj.write(entry)
+    return symbol_map
+
+
+def _write_parameter_expression(file_obj, obj, use_symengine, *, version):
+    extra_symbols = None
+    if version < 13:
+        if use_symengine:
+            expr_bytes = obj._symbol_expr.__reduce__()[1][0]
+        else:
+            from sympy import srepr, sympify
+
+            expr_bytes = srepr(sympify(obj._symbol_expr)).encode(common.ENCODE)
+    else:
+        with io.BytesIO() as buf:
+            extra_symbols = _write_parameter_expression_v13(buf, obj, version)
+            expr_bytes = buf.getvalue()
+    symbol_table_len = len(obj._parameter_symbols)
+    if extra_symbols:
+        symbol_table_len += 2 * len(extra_symbols)
+    param_expr_header_raw = struct.pack(
+        formats.PARAMETER_EXPR_PACK, symbol_table_len, len(expr_bytes)
+    )
+    file_obj.write(param_expr_header_raw)
+    file_obj.write(expr_bytes)
+    for symbol, value in obj._parameter_symbols.items():
+        symbol_key = type_keys.Value.assign(symbol)
+
+        # serialize key
+        if symbol_key == type_keys.Value.PARAMETER_VECTOR:
+            symbol_data = common.data_to_binary(symbol, _write_parameter_vec)
+        else:
+            symbol_data = common.data_to_binary(symbol, _write_parameter)
+
+        # serialize value
+        if value == symbol._symbol_expr:
+            value_key = symbol_key
+            value_data = bytes()
+        else:
+            value_key, value_data = dumps_value(value, version=version, use_symengine=use_symengine)
+
+        elem_header = struct.pack(
+            formats.PARAM_EXPR_MAP_ELEM_V3_PACK,
+            symbol_key,
+            value_key,
+            len(value_data),
+        )
+        file_obj.write(elem_header)
+        file_obj.write(symbol_data)
+        file_obj.write(value_data)
+    if extra_symbols:
+        for symbol in extra_symbols:
+            symbol_key = type_keys.Value.assign(symbol)
+            # serialize key
+            if symbol_key == type_keys.Value.PARAMETER_VECTOR:
+                symbol_data = common.data_to_binary(symbol, _write_parameter_vec)
+            else:
+                symbol_data = common.data_to_binary(symbol, _write_parameter)
+            # serialize value
+            value_key, value_data = dumps_value(
+                symbol, version=version, use_symengine=use_symengine
+            )
+
+            elem_header = struct.pack(
+                formats.PARAM_EXPR_MAP_ELEM_V3_PACK,
+                symbol_key,
+                value_key,
+                len(value_data),
+            )
+            file_obj.write(elem_header)
+            file_obj.write(symbol_data)
+            file_obj.write(value_data)
+        for symbol in extra_symbols.values():
+            symbol_key = type_keys.Value.assign(symbol)
+            # serialize key
+            if symbol_key == type_keys.Value.PARAMETER_VECTOR:
+                symbol_data = common.data_to_binary(symbol, _write_parameter_vec)
+            else:
+                symbol_data = common.data_to_binary(symbol, _write_parameter)
+            # serialize value
+            value_key, value_data = dumps_value(
+                symbol, version=version, use_symengine=use_symengine
+            )
+
+            elem_header = struct.pack(
+                formats.PARAM_EXPR_MAP_ELEM_V3_PACK,
+                symbol_key,
+                value_key,
+                len(value_data),
+            )
+            file_obj.write(elem_header)
+            file_obj.write(symbol_data)
+            file_obj.write(value_data)
+
+
+class _ExprWriter(expr.ExprVisitor[None]):
+    __slots__ = ("file_obj", "clbit_indices", "standalone_var_indices", "version")
+
+    def __init__(self, file_obj, clbit_indices, standalone_var_indices, version):
+        self.file_obj = file_obj
+        self.clbit_indices = clbit_indices
+        self.standalone_var_indices = standalone_var_indices
+        self.version = version
+
+    def visit_generic(self, node, /):
+        raise exceptions.QpyError(f"unhandled Expr object '{node}'")
+
+    def visit_var(self, node, /):
+        self.file_obj.write(type_keys.Expression.VAR)
+        _write_expr_type(self.file_obj, node.type)
+        if node.standalone:
+            self.file_obj.write(type_keys.ExprVar.UUID)
+            self.file_obj.write(
+                struct.pack(
+                    formats.EXPR_VAR_UUID_PACK,
+                    *formats.EXPR_VAR_UUID(self.standalone_var_indices[node]),
+                )
+            )
+        elif isinstance(node.var, Clbit):
+            self.file_obj.write(type_keys.ExprVar.CLBIT)
+            self.file_obj.write(
+                struct.pack(
+                    formats.EXPR_VAR_CLBIT_PACK,
+                    *formats.EXPR_VAR_CLBIT(self.clbit_indices[node.var]),
+                )
+            )
+        elif isinstance(node.var, ClassicalRegister):
+            self.file_obj.write(type_keys.ExprVar.REGISTER)
+            self.file_obj.write(
+                struct.pack(
+                    formats.EXPR_VAR_REGISTER_PACK, *formats.EXPR_VAR_REGISTER(len(node.var.name))
+                )
+            )
+            self.file_obj.write(node.var.name.encode(common.ENCODE))
+        else:
+            raise exceptions.QpyError(f"unhandled Var object '{node.var}'")
+
+    def visit_value(self, node, /):
+        self.file_obj.write(type_keys.Expression.VALUE)
+        _write_expr_type(self.file_obj, node.type)
+        if node.value is True or node.value is False:
+            self.file_obj.write(type_keys.ExprValue.BOOL)
+            self.file_obj.write(
+                struct.pack(formats.EXPR_VALUE_BOOL_PACK, *formats.EXPR_VALUE_BOOL(node.value))
+            )
+        elif isinstance(node.value, int):
+            self.file_obj.write(type_keys.ExprValue.INT)
+            if node.value == 0:
+                num_bytes = 0
+                buffer = b""
+            else:
+                # This wastes a byte for `-(2 ** (8*n - 1))` for natural `n`, but they'll still
+                # decode fine so it's not worth another special case.  They'll encode to
+                # b"\xff\x80\x00\x00...", but we could encode them to b"\x80\x00\x00...".
+                num_bytes = (node.value.bit_length() // 8) + 1
+                buffer = node.value.to_bytes(num_bytes, "big", signed=True)
+            self.file_obj.write(
+                struct.pack(formats.EXPR_VALUE_INT_PACK, *formats.EXPR_VALUE_INT(num_bytes))
+            )
+            self.file_obj.write(buffer)
+        else:
+            raise exceptions.QpyError(f"unhandled Value object '{node.value}'")
+
+    def visit_cast(self, node, /):
+        self.file_obj.write(type_keys.Expression.CAST)
+        _write_expr_type(self.file_obj, node.type)
+        self.file_obj.write(
+            struct.pack(formats.EXPRESSION_CAST_PACK, *formats.EXPRESSION_CAST(node.implicit))
+        )
+        node.operand.accept(self)
+
+    def visit_unary(self, node, /):
+        self.file_obj.write(type_keys.Expression.UNARY)
+        _write_expr_type(self.file_obj, node.type)
+        self.file_obj.write(
+            struct.pack(formats.EXPRESSION_UNARY_PACK, *formats.EXPRESSION_UNARY(node.op.value))
+        )
+        node.operand.accept(self)
+
+    def visit_binary(self, node, /):
+        self.file_obj.write(type_keys.Expression.BINARY)
+        _write_expr_type(self.file_obj, node.type)
+        self.file_obj.write(
+            struct.pack(formats.EXPRESSION_BINARY_PACK, *formats.EXPRESSION_BINARY(node.op.value))
+        )
+        node.left.accept(self)
+        node.right.accept(self)
+
+    def visit_index(self, node, /):
+        if self.version < 12:
+            raise exceptions.UnsupportedFeatureForVersion(
+                "the 'Index' expression", required=12, target=self.version
+            )
+        self.file_obj.write(type_keys.Expression.INDEX)
+        _write_expr_type(self.file_obj, node.type)
+        node.target.accept(self)
+        node.index.accept(self)
+
+
+def _write_expr(
+    file_obj,
+    node: expr.Expr,
+    clbit_indices: collections.abc.Mapping[Clbit, int],
+    standalone_var_indices: collections.abc.Mapping[expr.Var, int],
+    version: int,
+):
+    node.accept(_ExprWriter(file_obj, clbit_indices, standalone_var_indices, version))
+
+
+def _write_expr_type(file_obj, type_: types.Type):
+    if type_.kind is types.Bool:
+        file_obj.write(type_keys.ExprType.BOOL)
+    elif type_.kind is types.Uint:
+        file_obj.write(type_keys.ExprType.UINT)
+        file_obj.write(
+            struct.pack(formats.EXPR_TYPE_UINT_PACK, *formats.EXPR_TYPE_UINT(type_.width))
+        )
+    else:
+        raise exceptions.QpyError(f"unhandled Type object '{type_};")
+
+
+def _read_parameter(file_obj):
+    data = formats.PARAMETER(
+        *struct.unpack(formats.PARAMETER_PACK, file_obj.read(formats.PARAMETER_SIZE))
+    )
+    param_uuid = uuid.UUID(bytes=data.uuid)
+    name = file_obj.read(data.name_size).decode(common.ENCODE)
+    return Parameter(name, uuid=param_uuid)
+
+
+def _read_parameter_vec(file_obj, vectors):
+    data = formats.PARAMETER_VECTOR_ELEMENT(
+        *struct.unpack(
+            formats.PARAMETER_VECTOR_ELEMENT_PACK,
+            file_obj.read(formats.PARAMETER_VECTOR_ELEMENT_SIZE),
+        ),
+    )
+    param_uuid = uuid.UUID(bytes=data.uuid)
+    name = file_obj.read(data.vector_name_size).decode(common.ENCODE)
+    if name not in vectors:
+        vectors[name] = (ParameterVector(name, data.vector_size), set())
+    vector = vectors[name][0]
+    if vector[data.index].uuid != param_uuid:
+        vectors[name][1].add(data.index)
+        vector._params[data.index] = ParameterVectorElement(vector, data.index, uuid=param_uuid)
+    return vector[data.index]
+
+
+def _read_parameter_expression(file_obj):
+    data = formats.PARAMETER_EXPR(
+        *struct.unpack(formats.PARAMETER_EXPR_PACK, file_obj.read(formats.PARAMETER_EXPR_SIZE))
+    )
+    from sympy.parsing.sympy_parser import parse_expr
+
+    expr_ = symengine.sympify(parse_expr(file_obj.read(data.expr_size).decode(common.ENCODE)))
+    symbol_map = {}
+    for _ in range(data.map_elements):
+        elem_data = formats.PARAM_EXPR_MAP_ELEM(
+            *struct.unpack(
+                formats.PARAM_EXPR_MAP_ELEM_PACK,
+                file_obj.read(formats.PARAM_EXPR_MAP_ELEM_SIZE),
+            )
+        )
+        symbol = _read_parameter(file_obj)
+
+        elem_key = type_keys.Value(elem_data.type)
+        binary_data = file_obj.read(elem_data.size)
+        if elem_key == type_keys.Value.INTEGER:
+            value = struct.unpack("!q", binary_data)
+        elif elem_key == type_keys.Value.FLOAT:
+            value = struct.unpack("!d", binary_data)
+        elif elem_key == type_keys.Value.COMPLEX:
+            value = complex(*struct.unpack(formats.COMPLEX_PACK, binary_data))
+        elif elem_key == type_keys.Value.PARAMETER:
+            value = symbol._symbol_expr
+        elif elem_key == type_keys.Value.PARAMETER_EXPRESSION:
+            value = common.data_from_binary(binary_data, _read_parameter_expression)
+        else:
+            raise exceptions.QpyError(f"Invalid parameter expression map type: {elem_key}")
+        symbol_map[symbol] = value
+
+    return ParameterExpression(symbol_map, expr_)
+
+
+def _read_parameter_expression_v3(file_obj, vectors, use_symengine):
+    data = formats.PARAMETER_EXPR(
+        *struct.unpack(formats.PARAMETER_EXPR_PACK, file_obj.read(formats.PARAMETER_EXPR_SIZE))
+    )
+
+    payload = file_obj.read(data.expr_size)
+    if use_symengine:
+        expr_ = common.load_symengine_payload(payload)
+    else:
+        from sympy.parsing.sympy_parser import parse_expr
+
+        expr_ = symengine.sympify(parse_expr(payload.decode(common.ENCODE)))
+
+    symbol_map = {}
+    for _ in range(data.map_elements):
+        elem_data = formats.PARAM_EXPR_MAP_ELEM_V3(
+            *struct.unpack(
+                formats.PARAM_EXPR_MAP_ELEM_V3_PACK,
+                file_obj.read(formats.PARAM_EXPR_MAP_ELEM_V3_SIZE),
+            )
+        )
+        symbol_key = type_keys.Value(elem_data.symbol_type)
+
+        if symbol_key == type_keys.Value.PARAMETER:
+            symbol = _read_parameter(file_obj)
+        elif symbol_key == type_keys.Value.PARAMETER_VECTOR:
+            symbol = _read_parameter_vec(file_obj, vectors)
+        else:
+            raise exceptions.QpyError(f"Invalid parameter expression map type: {symbol_key}")
+
+        elem_key = type_keys.Value(elem_data.type)
+        binary_data = file_obj.read(elem_data.size)
+        if elem_key == type_keys.Value.INTEGER:
+            value = struct.unpack("!q", binary_data)
+        elif elem_key == type_keys.Value.FLOAT:
+            value = struct.unpack("!d", binary_data)
+        elif elem_key == type_keys.Value.COMPLEX:
+            value = complex(*struct.unpack(formats.COMPLEX_PACK, binary_data))
+        elif elem_key in (type_keys.Value.PARAMETER, type_keys.Value.PARAMETER_VECTOR):
+            value = symbol._symbol_expr
+        elif elem_key == type_keys.Value.PARAMETER_EXPRESSION:
+            value = common.data_from_binary(
+                binary_data,
+                _read_parameter_expression_v3,
+                vectors=vectors,
+                use_symengine=use_symengine,
+            )
+        else:
+            raise exceptions.QpyError(f"Invalid parameter expression map type: {elem_key}")
+        symbol_map[symbol] = value
+
+    return ParameterExpression(symbol_map, expr_)
+
+
+def _read_parameter_expression_v13(file_obj, vectors, version):
+    data = formats.PARAMETER_EXPR(
+        *struct.unpack(formats.PARAMETER_EXPR_PACK, file_obj.read(formats.PARAMETER_EXPR_SIZE))
+    )
+
+    payload = file_obj.read(data.expr_size)
+
+    symbol_map = {}
+    for _ in range(data.map_elements):
+        elem_data = formats.PARAM_EXPR_MAP_ELEM_V3(
+            *struct.unpack(
+                formats.PARAM_EXPR_MAP_ELEM_V3_PACK,
+                file_obj.read(formats.PARAM_EXPR_MAP_ELEM_V3_SIZE),
+            )
+        )
+        symbol_key = type_keys.Value(elem_data.symbol_type)
+
+        if symbol_key == type_keys.Value.PARAMETER:
+            symbol = _read_parameter(file_obj)
+        elif symbol_key == type_keys.Value.PARAMETER_VECTOR:
+            symbol = _read_parameter_vec(file_obj, vectors)
+        else:
+            raise exceptions.QpyError(f"Invalid parameter expression map type: {symbol_key}")
+
+        elem_key = type_keys.Value(elem_data.type)
+        binary_data = file_obj.read(elem_data.size)
+        if elem_key == type_keys.Value.INTEGER:
+            value = struct.unpack("!q", binary_data)
+        elif elem_key == type_keys.Value.FLOAT:
+            value = struct.unpack("!d", binary_data)
+        elif elem_key == type_keys.Value.COMPLEX:
+            value = complex(*struct.unpack(formats.COMPLEX_PACK, binary_data))
+        elif elem_key in (type_keys.Value.PARAMETER, type_keys.Value.PARAMETER_VECTOR):
+            value = symbol._symbol_expr
+        elif elem_key == type_keys.Value.PARAMETER_EXPRESSION:
+            value = common.data_from_binary(
+                binary_data,
+                _read_parameter_expression_v13,
+                vectors=vectors,
+            )
+        else:
+            raise exceptions.QpyError(f"Invalid parameter expression map type: {elem_key}")
+        symbol_map[symbol] = value
+    with io.BytesIO(payload) as buf:
+        return _read_parameter_expr_v13(buf, symbol_map, version, vectors)
+
+
+def _read_parameter_expr_v13(buf, symbol_map, version, vectors):
+    param_uuid_map = {symbol.uuid: symbol for symbol in symbol_map if isinstance(symbol, Parameter)}
+    name_map = {str(v): k for k, v in symbol_map.items()}
+    data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+    stack = []
+    while data:
+        expression_data = formats.PARAM_EXPR_ELEM_V13._make(
+            struct.unpack(formats.PARAM_EXPR_ELEM_V13_PACK, data)
+        )
+        # LHS
+        if expression_data.LHS_TYPE == b"p":
+            stack.append(param_uuid_map[uuid.UUID(bytes=expression_data.LHS)])
+        elif expression_data.LHS_TYPE == b"f":
+            stack.append(struct.unpack("!Qd", expression_data.LHS)[1])
+        elif expression_data.LHS_TYPE == b"n":
+            pass
+        elif expression_data.LHS_TYPE == b"c":
+            stack.append(complex(*struct.unpack("!dd", expression_data.LHS)))
+        elif expression_data.LHS_TYPE == b"i":
+            stack.append(struct.unpack("!Qq", expression_data.LHS)[1])
+        elif expression_data.LHS_TYPE == b"s":
+            data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+            continue
+        elif expression_data.LHS_TYPE == b"e":
+            data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+            continue
+        elif expression_data.LHS_TYPE == b"u":
+            size = struct.unpack_from("!QQ", expression_data.LHS)[0]
+            subs_map_data = buf.read(size)
+            with io.BytesIO(subs_map_data) as mapping_buf:
+                mapping = common.read_mapping(
+                    mapping_buf, deserializer=loads_value, version=version, vectors=vectors
+                )
+            stack.append({name_map[k]: v for k, v in mapping.items()})
+        else:
+            raise exceptions.QpyError(
+                "Unknown ParameterExpression operation type {expression_data.LHS_TYPE}"
+            )
+        # RHS
+        if expression_data.RHS_TYPE == b"p":
+            stack.append(param_uuid_map[uuid.UUID(bytes=expression_data.RHS)])
+        elif expression_data.RHS_TYPE == b"f":
+            stack.append(struct.unpack("!Qd", expression_data.RHS)[1])
+        elif expression_data.RHS_TYPE == b"n":
+            pass
+        elif expression_data.RHS_TYPE == b"c":
+            stack.append(complex(*struct.unpack("!dd", expression_data.RHS)))
+        elif expression_data.RHS_TYPE == b"i":
+            stack.append(struct.unpack("!Qq", expression_data.RHS)[1])
+        elif expression_data.RHS_TYPE == b"s":
+            data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+            continue
+        elif expression_data.RHS_TYPE == b"e":
+            data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+            continue
+        else:
+            raise exceptions.QpyError(
+                f"Unknown ParameterExpression operation type {expression_data.RHS_TYPE}"
+            )
+        if expression_data.OP_CODE == 255:
+            continue
+        method_str = op_code_to_method(_OPCode(expression_data.OP_CODE))
+        if expression_data.OP_CODE in {0, 1, 2, 3, 4, 13, 15, 18, 19, 20}:
+            rhs = stack.pop()
+            lhs = stack.pop()
+            # Reverse ops for commutative ops, which are add, mul (0 and 2 respectively)
+            # op codes 13 and 15 can never be reversed and 18, 19, 20
+            # are the reversed versions of non-commuative operations
+            # so 1, 3, 4 and 18, 19, 20 handle this explicitly.
+            if (
+                not isinstance(lhs, ParameterExpression)
+                and isinstance(rhs, ParameterExpression)
+                and expression_data.OP_CODE in {0, 2}
+            ):
+                if expression_data.OP_CODE == 0:
+                    method_str = "__radd__"
+                elif expression_data.OP_CODE == 2:
+                    method_str = "__rmul__"
+                stack.append(getattr(rhs, method_str)(lhs))
+            else:
+                stack.append(getattr(lhs, method_str)(rhs))
+        else:
+            lhs = stack.pop()
+            stack.append(getattr(lhs, method_str)())
+        data = buf.read(formats.PARAM_EXPR_ELEM_V13_SIZE)
+    return stack.pop()
+
+
+def _read_expr(
+    file_obj,
+    clbits: collections.abc.Sequence[Clbit],
+    cregs: collections.abc.Mapping[str, ClassicalRegister],
+    standalone_vars: collections.abc.Sequence[expr.Var],
+) -> expr.Expr:
+    # pylint: disable=too-many-return-statements
+    type_key = file_obj.read(formats.EXPRESSION_DISCRIMINATOR_SIZE)
+    type_ = _read_expr_type(file_obj)
+    if type_key == type_keys.Expression.VAR:
+        var_type_key = file_obj.read(formats.EXPR_VAR_DISCRIMINATOR_SIZE)
+        if var_type_key == type_keys.ExprVar.UUID:
+            payload = formats.EXPR_VAR_UUID._make(
+                struct.unpack(formats.EXPR_VAR_UUID_PACK, file_obj.read(formats.EXPR_VAR_UUID_SIZE))
+            )
+            return standalone_vars[payload.var_index]
+        if var_type_key == type_keys.ExprVar.CLBIT:
+            payload = formats.EXPR_VAR_CLBIT._make(
+                struct.unpack(
+                    formats.EXPR_VAR_CLBIT_PACK, file_obj.read(formats.EXPR_VAR_CLBIT_SIZE)
+                )
+            )
+            return expr.Var(clbits[payload.index], type_)
+        if var_type_key == type_keys.ExprVar.REGISTER:
+            payload = formats.EXPR_VAR_REGISTER._make(
+                struct.unpack(
+                    formats.EXPR_VAR_REGISTER_PACK, file_obj.read(formats.EXPR_VAR_REGISTER_SIZE)
+                )
+            )
+            name = file_obj.read(payload.reg_name_size).decode(common.ENCODE)
+            return expr.Var(cregs[name], type_)
+        raise exceptions.QpyError("Invalid classical-expression Var key '{var_type_key}'")
+    if type_key == type_keys.Expression.VALUE:
+        value_type_key = file_obj.read(formats.EXPR_VALUE_DISCRIMINATOR_SIZE)
+        if value_type_key == type_keys.ExprValue.BOOL:
+            payload = formats.EXPR_VALUE_BOOL._make(
+                struct.unpack(
+                    formats.EXPR_VALUE_BOOL_PACK, file_obj.read(formats.EXPR_VALUE_BOOL_SIZE)
+                )
+            )
+            return expr.Value(payload.value, type_)
+        if value_type_key == type_keys.ExprValue.INT:
+            payload = formats.EXPR_VALUE_INT._make(
+                struct.unpack(
+                    formats.EXPR_VALUE_INT_PACK, file_obj.read(formats.EXPR_VALUE_INT_SIZE)
+                )
+            )
+            return expr.Value(
+                int.from_bytes(file_obj.read(payload.num_bytes), "big", signed=True), type_
+            )
+        raise exceptions.QpyError("Invalid classical-expression Value key '{value_type_key}'")
+    if type_key == type_keys.Expression.CAST:
+        payload = formats.EXPRESSION_CAST._make(
+            struct.unpack(formats.EXPRESSION_CAST_PACK, file_obj.read(formats.EXPRESSION_CAST_SIZE))
+        )
+        return expr.Cast(
+            _read_expr(file_obj, clbits, cregs, standalone_vars), type_, implicit=payload.implicit
+        )
+    if type_key == type_keys.Expression.UNARY:
+        payload = formats.EXPRESSION_UNARY._make(
+            struct.unpack(
+                formats.EXPRESSION_UNARY_PACK, file_obj.read(formats.EXPRESSION_UNARY_SIZE)
+            )
+        )
+        return expr.Unary(
+            expr.Unary.Op(payload.opcode),
+            _read_expr(file_obj, clbits, cregs, standalone_vars),
+            type_,
+        )
+    if type_key == type_keys.Expression.BINARY:
+        payload = formats.EXPRESSION_BINARY._make(
+            struct.unpack(
+                formats.EXPRESSION_BINARY_PACK, file_obj.read(formats.EXPRESSION_BINARY_SIZE)
+            )
+        )
+        return expr.Binary(
+            expr.Binary.Op(payload.opcode),
+            _read_expr(file_obj, clbits, cregs, standalone_vars),
+            _read_expr(file_obj, clbits, cregs, standalone_vars),
+            type_,
+        )
+    if type_key == type_keys.Expression.INDEX:
+        return expr.Index(
+            _read_expr(file_obj, clbits, cregs, standalone_vars),
+            _read_expr(file_obj, clbits, cregs, standalone_vars),
+            type_,
+        )
+    raise exceptions.QpyError(f"Invalid classical-expression Expr key '{type_key}'")
+
+
+def _read_expr_type(file_obj) -> types.Type:
+    type_key = file_obj.read(formats.EXPR_TYPE_DISCRIMINATOR_SIZE)
+    if type_key == type_keys.ExprType.BOOL:
+        return types.Bool()
+    if type_key == type_keys.ExprType.UINT:
+        elem = formats.EXPR_TYPE_UINT._make(
+            struct.unpack(formats.EXPR_TYPE_UINT_PACK, file_obj.read(formats.EXPR_TYPE_UINT_SIZE))
+        )
+        return types.Uint(elem.width)
+    raise exceptions.QpyError(f"Invalid classical-expression Type key '{type_key}'")
+
+
+def read_standalone_vars(file_obj, num_vars):
+    """Read the ``num_vars`` standalone variable declarations from the file.
+
+    Args:
+        file_obj (File): a file-like object to read from.
+        num_vars (int): the number of variables to read.
+
+    Returns:
+        tuple[dict, list]: the first item is a mapping of the ``ExprVarDeclaration`` type keys to
+        the variables defined by that type key, and the second is the total order of variable
+        declarations.
+    """
+    read_vars = {
+        type_keys.ExprVarDeclaration.INPUT: [],
+        type_keys.ExprVarDeclaration.CAPTURE: [],
+        type_keys.ExprVarDeclaration.LOCAL: [],
+    }
+    var_order = []
+    for _ in range(num_vars):
+        data = formats.EXPR_VAR_DECLARATION._make(
+            struct.unpack(
+                formats.EXPR_VAR_DECLARATION_PACK,
+                file_obj.read(formats.EXPR_VAR_DECLARATION_SIZE),
+            )
+        )
+        type_ = _read_expr_type(file_obj)
+        name = file_obj.read(data.name_size).decode(common.ENCODE)
+        var = expr.Var(uuid.UUID(bytes=data.uuid_bytes), type_, name=name)
+        read_vars[data.usage].append(var)
+        var_order.append(var)
+    return read_vars, var_order
+
+
+def _write_standalone_var(file_obj, var, type_key):
+    name = var.name.encode(common.ENCODE)
+    file_obj.write(
+        struct.pack(
+            formats.EXPR_VAR_DECLARATION_PACK,
+            *formats.EXPR_VAR_DECLARATION(var.var.bytes, type_key, len(name)),
+        )
+    )
+    _write_expr_type(file_obj, var.type)
+    file_obj.write(name)
+
+
+def write_standalone_vars(file_obj, circuit):
+    """Write the standalone variables out from a circuit.
+
+    Args:
+        file_obj (File): the file-like object to write to.
+        circuit (QuantumCircuit): the circuit to take the variables from.
+
+    Returns:
+        dict[expr.Var, int]: a mapping of the variables written to the index that they were written
+        at.
+    """
+    index = 0
+    out = {}
+    for var in circuit.iter_input_vars():
+        _write_standalone_var(file_obj, var, type_keys.ExprVarDeclaration.INPUT)
+        out[var] = index
+        index += 1
+    for var in circuit.iter_captured_vars():
+        _write_standalone_var(file_obj, var, type_keys.ExprVarDeclaration.CAPTURE)
+        out[var] = index
+        index += 1
+    for var in circuit.iter_declared_vars():
+        _write_standalone_var(file_obj, var, type_keys.ExprVarDeclaration.LOCAL)
+        out[var] = index
+        index += 1
+    return out
+
+
+def dumps_value(
+    obj,
+    *,
+    version,
+    index_map=None,
+    use_symengine=False,
+    standalone_var_indices=None,
+):
+    """Serialize input value object.
+
+    Args:
+        obj (any): Arbitrary value object to serialize.
+        version (int): the target QPY version for the dump.
+        index_map (dict): Dictionary with two keys, "q" and "c".  Each key has a value that is a
+            dictionary mapping :class:`.Qubit` or :class:`.Clbit` instances (respectively) to their
+            integer indices.
+        use_symengine (bool): If True, symbolic objects will be serialized using symengine's
+            native mechanism. This is a faster serialization alternative, but not supported in all
+            platforms. Please check that your target platform is supported by the symengine library
+            before setting this option, as it will be required by qpy to deserialize the payload.
+        standalone_var_indices (dict): Dictionary that maps standalone :class:`.expr.Var` entries to
+            the index that should be used to refer to them.
+
+    Returns:
+        tuple: TypeKey and binary data.
+
+    Raises:
+        QpyError: Serializer for given format is not ready.
+    """
+    type_key = type_keys.Value.assign(obj)
+
+    if type_key == type_keys.Value.INTEGER:
+        binary_data = struct.pack("!q", obj)
+    elif type_key == type_keys.Value.FLOAT:
+        binary_data = struct.pack("!d", obj)
+    elif type_key == type_keys.Value.COMPLEX:
+        binary_data = struct.pack(formats.COMPLEX_PACK, obj.real, obj.imag)
+    elif type_key == type_keys.Value.NUMPY_OBJ:
+        binary_data = common.data_to_binary(obj, np.save)
+    elif type_key == type_keys.Value.STRING:
+        binary_data = obj.encode(common.ENCODE)
+    elif type_key in (type_keys.Value.NULL, type_keys.Value.CASE_DEFAULT):
+        binary_data = b""
+    elif type_key == type_keys.Value.PARAMETER_VECTOR:
+        binary_data = common.data_to_binary(obj, _write_parameter_vec)
+    elif type_key == type_keys.Value.PARAMETER:
+        binary_data = common.data_to_binary(obj, _write_parameter)
+    elif type_key == type_keys.Value.PARAMETER_EXPRESSION:
+        binary_data = common.data_to_binary(
+            obj, _write_parameter_expression, use_symengine=use_symengine, version=version
+        )
+    elif type_key == type_keys.Value.EXPRESSION:
+        clbit_indices = {} if index_map is None else index_map["c"]
+        standalone_var_indices = {} if standalone_var_indices is None else standalone_var_indices
+        binary_data = common.data_to_binary(
+            obj,
+            _write_expr,
+            clbit_indices=clbit_indices,
+            standalone_var_indices=standalone_var_indices,
+            version=version,
+        )
+    else:
+        raise exceptions.QpyError(f"Serialization for {type_key} is not implemented in value I/O.")
+
+    return type_key, binary_data
+
+
+def write_value(
+    file_obj, obj, *, version, index_map=None, use_symengine=False, standalone_var_indices=None
+):
+    """Write a value to the file like object.
+
+    Args:
+        file_obj (File): A file like object to write data.
+        obj (any): Value to write.
+        version (int): the target QPY version for the dump.
+        index_map (dict): Dictionary with two keys, "q" and "c".  Each key has a value that is a
+            dictionary mapping :class:`.Qubit` or :class:`.Clbit` instances (respectively) to their
+            integer indices.
+        use_symengine (bool): If True, symbolic objects will be serialized using symengine's
+            native mechanism. This is a faster serialization alternative, but not supported in all
+            platforms. Please check that your target platform is supported by the symengine library
+            before setting this option, as it will be required by qpy to deserialize the payload.
+        standalone_var_indices (dict): Dictionary that maps standalone :class:`.expr.Var` entries to
+            the index that should be used to refer to them.
+    """
+    type_key, data = dumps_value(
+        obj,
+        version=version,
+        index_map=index_map,
+        use_symengine=use_symengine,
+        standalone_var_indices=standalone_var_indices,
+    )
+    common.write_generic_typed_data(file_obj, type_key, data)
+
+
+def loads_value(
+    type_key,
+    binary_data,
+    version,
+    vectors,
+    *,
+    clbits=(),
+    cregs=None,
+    use_symengine=False,
+    standalone_vars=(),
+):
+    """Deserialize input binary data to value object.
+
+    Args:
+        type_key (ValueTypeKey): Type enum information.
+        binary_data (bytes): Data to deserialize.
+        version (int): QPY version.
+        vectors (dict): ParameterVector in current scope.
+        clbits (Sequence[Clbit]): Clbits in the current scope.
+        cregs (Mapping[str, ClassicalRegister]): Classical registers in the current scope.
+        use_symengine (bool): If True, symbolic objects will be de-serialized using symengine's
+            native mechanism. This is a faster serialization alternative, but not supported in all
+            platforms. Please check that your target platform is supported by the symengine library
+            before setting this option, as it will be required by qpy to deserialize the payload.
+        standalone_vars (Sequence[Var]): standalone :class:`.expr.Var` nodes in the order that they
+            were declared by the circuit header.
+
+    Returns:
+        any: Deserialized value object.
+
+    Raises:
+        QpyError: Serializer for given format is not ready.
+    """
+    # pylint: disable=too-many-return-statements
+
+    if isinstance(type_key, bytes):
+        type_key = type_keys.Value(type_key)
+
+    if type_key == type_keys.Value.INTEGER:
+        return struct.unpack("!q", binary_data)[0]
+    if type_key == type_keys.Value.FLOAT:
+        return struct.unpack("!d", binary_data)[0]
+    if type_key == type_keys.Value.COMPLEX:
+        return complex(*struct.unpack(formats.COMPLEX_PACK, binary_data))
+    if type_key == type_keys.Value.NUMPY_OBJ:
+        return common.data_from_binary(binary_data, np.load)
+    if type_key == type_keys.Value.STRING:
+        return binary_data.decode(common.ENCODE)
+    if type_key == type_keys.Value.NULL:
+        return None
+    if type_key == type_keys.Value.CASE_DEFAULT:
+        return CASE_DEFAULT
+    if type_key == type_keys.Value.PARAMETER_VECTOR:
+        return common.data_from_binary(binary_data, _read_parameter_vec, vectors=vectors)
+    if type_key == type_keys.Value.PARAMETER:
+        return common.data_from_binary(binary_data, _read_parameter)
+    if type_key == type_keys.Value.PARAMETER_EXPRESSION:
+        if version < 3:
+            return common.data_from_binary(binary_data, _read_parameter_expression)
+        elif version < 13:
+            return common.data_from_binary(
+                binary_data,
+                _read_parameter_expression_v3,
+                vectors=vectors,
+                use_symengine=use_symengine,
+            )
+        else:
+            return common.data_from_binary(
+                binary_data, _read_parameter_expression_v13, vectors=vectors, version=version
+            )
+    if type_key == type_keys.Value.EXPRESSION:
+        return common.data_from_binary(
+            binary_data,
+            _read_expr,
+            clbits=clbits,
+            cregs=cregs or {},
+            standalone_vars=standalone_vars,
+        )
+
+    raise exceptions.QpyError(f"Serialization for {type_key} is not implemented in value I/O.")
+
+
+def read_value(
+    file_obj,
+    version,
+    vectors,
+    *,
+    clbits=(),
+    cregs=None,
+    use_symengine=False,
+    standalone_vars=(),
+):
+    """Read a value from the file like object.
+
+    Args:
+        file_obj (File): A file like object to write data.
+        version (int): QPY version.
+        vectors (dict): ParameterVector in current scope.
+        clbits (Sequence[Clbit]): Clbits in the current scope.
+        cregs (Mapping[str, ClassicalRegister]): Classical registers in the current scope.
+        use_symengine (bool): If True, symbolic objects will be de-serialized using symengine's
+            native mechanism. This is a faster serialization alternative, but not supported in all
+            platforms. Please check that your target platform is supported by the symengine library
+            before setting this option, as it will be required by qpy to deserialize the payload.
+        standalone_vars (Sequence[expr.Var]): standalone variables in the order they were defined in
+            the QPY payload.
+
+    Returns:
+        any: Deserialized value object.
+    """
+    type_key, data = common.read_generic_typed_data(file_obj)
+
+    return loads_value(
+        type_key,
+        data,
+        version,
+        vectors,
+        clbits=clbits,
+        cregs=cregs,
+        use_symengine=use_symengine,
+        standalone_vars=standalone_vars,
+    )