Added data utilities

mypy.ini

@@ -0,0 +1,17 @@
+# Global options:
+
+[mypy]
+plugins = numpy.typing.mypy_plugin
+warn_return_any = True
+warn_unused_configs = True
+
+# Per-module options:
+
+[mypy-mycode.foo.*]
+disallow_untyped_defs = True
+
+[mypy-mycode.bar]
+warn_return_any = False
+
+[mypy-somelibrary]
+ignore_missing_imports = True

quantum_perceptron/tests/test_utils.py

@@ -0,0 +1,58 @@
+import pytest
+import numpy as np
+
+from quantum_perceptron.utils.data_utils import (
+    get_vector_from_int,
+    get_num_bits,
+    get_possible_state_strings
+)
+
+
+@pytest.mark.parametrize("data, expected_result", [
+    (12, 4),
+    (8, 4),
+    (7, 3),
+    (0, 1),
+    (-5, False),
+])
+def test_get_num_bits(data, expected_result):
+    if isinstance(expected_result, bool) and not expected_result:
+        with pytest.raises(ValueError):
+            get_num_bits(data)
+    else:
+        assert expected_result == get_num_bits(data)
+
+
+@pytest.mark.parametrize("data, expected_result", [
+    (12, np.array([-1, -1, 1, 1])),
+    (1, np.array([1, 1, 1, -1])),
+    (0, np.array([1, 1, 1, 1])),
+    (-5, False)
+])
+def test_get_vector_from_int(data, expected_result):
+    if isinstance(expected_result, bool) and not expected_result:
+        with pytest.raises(ValueError):
+            get_vector_from_int(data)
+    else:
+        np.array_equal(
+            expected_result,
+            get_vector_from_int(data)
+        )
+
+
+@pytest.mark.parametrize("num_bits, expected_result", [
+    (1, np.array(['0', '1'])),
+    (2, np.array(['00', '01', '10', '11'])),
+    (3, np.array(['000', '001', '010', '011', '100', '101', '110', '111'])),
+    (-5, False),
+    (0, False)
+])
+def test_get_possible_state_strings(num_bits, expected_result):
+    if isinstance(expected_result, bool) and not expected_result:
+        with pytest.raises(ValueError):
+            get_possible_state_strings(num_bits)
+    else:
+        np.array_equal(
+            expected_result,
+            get_possible_state_strings(num_bits)
+        )

quantum_perceptron/utils/data_utils.py

@@ -0,0 +1,75 @@
+import numpy as np
+import numpy.typing as npt
+
+
+def assert_negative(data: int):
+    """
+    General method to prevent negative values of integers.
+    """
+    if data < 0:
+        raise ValueError("Currently we do not support negative data values.")
+
+
+def get_bin_int(data: int) -> str:
+    """
+    Get binary representation of integer.
+    """
+    assert_negative(data)
+    return bin(data)[2:]
+
+
+def get_num_bits(data: int) -> int:
+    """
+    Get number of bits in an integer.
+    """
+    assert_negative(data)
+    return len(get_bin_int(data))
+
+
+def get_vector_from_int(data: int) -> np.ndarray:
+    """
+    This method returns the vector where each element is (-1)^b_i where b_i is
+    the bit value at index i.
+
+    Args:
+      data: `int` representing data value
+        (correspponding toinput or weight vector)
+
+    Returns: Vector in  form of `np.ndarray`.
+    """
+    assert_negative(data)
+
+    bin_data = get_bin_int(data)
+    num_qubits = get_num_bits(data)
+    data_vector = np.empty(num_qubits)
+
+    for i, bit in enumerate(bin_data):
+        data_vector[i] = np.power(-1, int(bit))
+
+    return data_vector
+
+
+def get_possible_state_strings(num_bits: int) -> np.ndarray:
+    """
+    Get all the state bit strings corresponding to given number of bits.
+    For example for 2 bits, we get ['00', '01', '10', '11'].
+    Note that we are only allowing bits < 10 as of now.
+
+    Args:
+      num_bits: `int` representing number of bits
+
+    Returns: `np.ndarray` containing all states of `num_bits` bits.
+    """
+    assert_negative(num_bits)
+    if num_bits == 0:
+        raise ValueError("Number of bits cannot be 0")
+    if num_bits >= 10:
+        raise ValueError("We are not currently supporting bits >= 10")
+
+    total_states = np.power(2, num_bits)
+    states = np.empty(total_states, dtype="<U10")
+    state_template = "{:0" + str(num_bits) + "b}"
+    for i in range(total_states):
+        states[i] = state_template.format(i)
+
+    return states

requirements.txt

@@ -0,0 +1,5 @@
+numpy
+qiskit
+pycodestyle
+pytest
+mypy

run_tests.sh

@@ -0,0 +1,8 @@
+echo "#### RUNNING MYPY TESTS ####"
+PYTHONDONTWRITEBYTECODE=1 mypy quantum_perceptron/
+
+echo "#### RUNNING PYCODESTYLE TESTS ####"
+pycodestyle quantum_perceptron/
+
+echo "#### RUNNING PYTEST TESTS ####"
+PYTHONDONTWRITEBYTECODE=1 python -m pytest -p no:cacheprovider