general_superstaq.validation
============================

.. py:module:: general_superstaq.validation


Functions
---------

.. autoapisummary::

   general_superstaq.validation.validate_bitmap
   general_superstaq.validation.validate_integer_param
   general_superstaq.validation.validate_noise_type
   general_superstaq.validation.validate_qubo
   general_superstaq.validation.validate_target


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

.. py:function:: validate_bitmap(bitmap: numpy.typing.ArrayLike) -> None

   Checks that `bitmap` is in an array format acceptable by the Atom picture API.

   :param bitmap: The array-like object to validate.

   :raises TypeError: If `bitmap` is not a two-dimensional array.
   :raises TypeError: If `bitmap` is not a square two-dimensional array.
   :raises ValueError: If `bitmap` contains any values outside of {0, 1, 2}.


.. py:function:: validate_integer_param(integer_param: object, min_val: int = 1) -> None

   Validates that `integer_param` is an integer and positive (or above a minimum value).

   :param integer_param: The input parameter to validate.
   :param min_val: Optional parameter to validate if `integer_param` is greater than `min_val`.

   :raises TypeError: If `integer_param` is not an integer.
   :raises ValueError: If `integer_param` is less than `min_val`.


.. py:function:: validate_noise_type(noise: dict[str, object], n_qubits: int) -> None

   Validates that an ACES noise model is valid.

   :param noise: A noise model parameter.
   :param n_qubits: Number of qubits the noise model is applied to.

   :raises ValueError: If `noise` is not valid.


.. py:function:: validate_qubo(qubo: object) -> None

   Validates that the input can be converted into a valid QUBO.

   :param qubo: The input value to validate.

   :raises TypeError: If `qubo` is not a dict-like object.
   :raises TypeError: If the keys of `qubo` are of an invalid type.
   :raises ValueError: If `qubo` contains cubic or further higher degree terms.
   :raises TypeError: If the values in `qubo` are not real numbers.


.. py:function:: validate_target(target: str) -> None

   Checks that `target` conforms to a valid Superstaq format and device type.

   :param target: A string containing the name of a target device.

   :raises ValueError: If `target` has an invalid format or device type.