qlbm_utils
==========

.. py:module:: qlbm_utils


Functions
---------

.. autoapisummary::

   qlbm_utils.compute_memory_requirements
   qlbm_utils.allocate_registers
   qlbm_utils.compute_binary_representations
   qlbm_utils.map_indices_coordinates
   qlbm_utils.construct_identity_matrices
   qlbm_utils.lattice_to_vector


Module Contents
---------------

.. py:function:: compute_memory_requirements(m, M_0, include_AS=False, include_AR=False, include_BC=False, verbose=False)

   Compute number of qubits needed for each register of quantum circuit.



.. py:function:: allocate_registers(n_qubits, n_qubits_lattice, n_qubits_boundary, n_qubits_direction, n_qubits_switch, n_qubits_ancilla)

   Allocate registers of quantum circuit.



.. py:function:: compute_binary_representations(m, M, verbose=False)

   Compute binary representations of important values.



.. py:function:: map_indices_coordinates(N, coordinate_max_bin, verbose=False)

   Construct mappings from binary coordinate indices to coordinates.



.. py:function:: construct_identity_matrices(M)

   Construct useful identity matrices of different dimensions once.



.. py:function:: lattice_to_vector(lattice)

   Construct statevector representation of data on a lattice.