Quantum gate models for IR integration

.github/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### New features since last release
 
+* Quantum gate models have been added to the `jet` Python package. [(#16)](https://github.com/XanaduAI/jet/pull/16)
+
 * Python bindings are now available for the `TaskBasedCpuContractor` class. [(#19)](https://github.com/XanaduAI/jet/pull/19)
 
 * Python bindings now include a factory method which accepts a `dtype` parameter. [(#18)](https://github.com/XanaduAI/jet/pull/18)
@@ -22,7 +24,7 @@
 
 * Tensor transposes are now significantly faster when all the dimensions are powers of two. [(#12)](https://github.com/XanaduAI/jet/pull/12)
 
-* Use camel case for type aliases [(#17)](https://github.com/XanaduAI/jet/pull/17)
+* Use camel case for type aliases. [(#17)](https://github.com/XanaduAI/jet/pull/17)
 
 * Exceptions are now favoured in place of `std::terminate` with `Exception` being the new base type for all exceptions thrown by Jet. [(#3)](https://github.com/XanaduAI/jet/pull/3)
 

python/Makefile

@@ -33,11 +33,11 @@ setup: $(.VENV_DIR)/touch
 .PHONY: format
 format: $(.VENV_DIR)/requirements.txt.touch
 ifdef check
-	$(.VENV_BIN)/black -l 100 --check tests
-	$(.VENV_BIN)/isort --profile black --check-only tests
+	$(.VENV_BIN)/black -l 100 --check jet tests
+	$(.VENV_BIN)/isort --profile black --check-only jet tests
 else
-	$(.VENV_BIN)/black -l 100 tests
-	$(.VENV_BIN)/isort --profile black tests
+	$(.VENV_BIN)/black -l 100 jet tests
+	$(.VENV_BIN)/isort --profile black jet tests
 endif
 
 

python/jet/__init__.py

@@ -1,83 +1,9 @@
-from typing import Union
-
-import numpy as np
-
 # The existence of a Python binding is proof of its intention to be exposed.
 from .bindings import *
 
-
-def TaskBasedCpuContractor(
-    *args, **kwargs
-) -> Union[TaskBasedCpuContractorC64, TaskBasedCpuContractorC128]:
-    """Constructs a task-based CPU contractor with the specified data type. If a
-    `dtype` keyword argument is not provided, a TaskBasedCpuContractorC128
-    instance will be returned.
-    """
-    dtype = kwargs.pop("dtype", "complex128")
-    if np.dtype(dtype) == np.complex64:
-        return TaskBasedCpuContractorC64(*args, **kwargs)
-    elif np.dtype(dtype) == np.complex128:
-        return TaskBasedCpuContractorC128(*args, **kwargs)
-    else:
-        raise TypeError(f"Data type '{dtype}' is not supported.")
-
-
-def Tensor(*args, **kwargs) -> Union[TensorC64, TensorC128]:
-    """Constructs a tensor with the specified data type. If a `dtype` keyword
-    argument is not provided, a TensorC128 instance will be returned.
-    """
-    dtype = kwargs.pop("dtype", "complex128")
-    if np.dtype(dtype) == np.complex64:
-        return TensorC64(*args, **kwargs)
-    elif np.dtype(dtype) == np.complex128:
-        return TensorC128(*args, **kwargs)
-    else:
-        raise TypeError(f"Data type '{dtype}' is not supported.")
-
-
-def TensorNetwork(*args, **kwargs) -> Union[TensorNetworkC64, TensorNetworkC128]:
-    """Constructs a tensor network with the specified data type. If a `dtype`
-    keyword argument is not provided, a TensorNetworkC128 instance will be
-    returned.
-    """
-    dtype = kwargs.pop("dtype", "complex128")
-    if np.dtype(dtype) == np.complex64:
-        return TensorNetworkC64(*args, **kwargs)
-    elif np.dtype(dtype) == np.complex128:
-        return TensorNetworkC128(*args, **kwargs)
-    else:
-        raise TypeError(f"Data type '{dtype}' is not supported.")
-
-
-def TensorNetworkFile(*args, **kwargs) -> Union[TensorNetworkFileC64, TensorNetworkFileC128]:
-    """Constructs a tensor network file with the specified data type. If a
-    `dtype` keyword argument is not provided, a TensorNetworkFileC128 instance
-    will be returned.
-    """
-    dtype = kwargs.pop("dtype", "complex128")
-    if np.dtype(dtype) == np.complex64:
-        return TensorNetworkFileC64(*args, **kwargs)
-    elif np.dtype(dtype) == np.complex128:
-        return TensorNetworkFileC128(*args, **kwargs)
-    else:
-        raise TypeError(f"Data type '{dtype}' is not supported.")
-
-
-def TensorNetworkSerializer(
-    *args, **kwargs
-) -> Union[TensorNetworkSerializerC64, TensorNetworkSerializerC128]:
-    """Constructs a tensor network serializer with the specified data type. If a
-    `dtype` keyword argument is not provided, a TensorNetworkSerializerC128
-    instance will be returned.
-    """
-    dtype = kwargs.pop("dtype", "complex128")
-    if np.dtype(dtype) == np.complex64:
-        return TensorNetworkSerializerC64(*args, **kwargs)
-    elif np.dtype(dtype) == np.complex128:
-        return TensorNetworkSerializerC128(*args, **kwargs)
-    else:
-        raise TypeError(f"Data type '{dtype}' is not supported.")
-
+# The rest of the modules control their exports using `__all__`.
+from .factory import *
+from .gate import *
 
 # Grab the current Jet version from the C++ headers.
 __version__ = version()

python/jet/factory.py

@@ -0,0 +1,105 @@
+from typing import Union
+
+import numpy as np
+
+from .bindings import (
+    TaskBasedCpuContractorC64,
+    TaskBasedCpuContractorC128,
+    TensorC64,
+    TensorC128,
+    TensorNetworkC64,
+    TensorNetworkC128,
+    TensorNetworkFileC64,
+    TensorNetworkFileC128,
+    TensorNetworkSerializerC64,
+    TensorNetworkSerializerC128,
+)
+
+__all__ = [
+    "TaskBasedCpuContractorType",
+    "TensorType",
+    "TensorNetworkType",
+    "TensorNetworkFileType",
+    "TensorNetworkSerializerType",
+    "TaskBasedCpuContractor",
+    "Tensor",
+    "TensorNetwork",
+    "TensorNetworkFile",
+    "TensorNetworkSerializer",
+]
+
+# Type aliases to avoid enumerating class specializations.
+TaskBasedCpuContractorType = Union[TaskBasedCpuContractorC64, TaskBasedCpuContractorC128]
+TensorType = Union[TensorC64, TensorC128]
+TensorNetworkType = Union[TensorNetworkC64, TensorNetworkC128]
+TensorNetworkFileType = Union[TensorNetworkFileC64, TensorNetworkFileC128]
+TensorNetworkSerializerType = Union[TensorNetworkSerializerC64, TensorNetworkSerializerC128]
+
+
+def TaskBasedCpuContractor(*args, **kwargs) -> TaskBasedCpuContractorType:
+    """Constructs a task-based CPU contractor with the specified data type. If a
+    `dtype` keyword argument is not provided, a TaskBasedCpuContractorC128
+    instance will be returned.
+    """
+    dtype = kwargs.pop("dtype", "complex128")
+    if np.dtype(dtype) == np.complex64:
+        return TaskBasedCpuContractorC64(*args, **kwargs)
+    elif np.dtype(dtype) == np.complex128:
+        return TaskBasedCpuContractorC128(*args, **kwargs)
+    else:
+        raise TypeError(f"Data type '{dtype}' is not supported.")
+
+
+def Tensor(*args, **kwargs) -> TensorType:
+    """Constructs a tensor with the specified data type. If a `dtype` keyword
+    argument is not provided, a TensorC128 instance will be returned.
+    """
+    dtype = kwargs.pop("dtype", "complex128")
+    if np.dtype(dtype) == np.complex64:
+        return TensorC64(*args, **kwargs)
+    elif np.dtype(dtype) == np.complex128:
+        return TensorC128(*args, **kwargs)
+    else:
+        raise TypeError(f"Data type '{dtype}' is not supported.")
+
+
+def TensorNetwork(*args, **kwargs) -> TensorNetworkType:
+    """Constructs a tensor network with the specified data type. If a `dtype`
+    keyword argument is not provided, a TensorNetworkC128 instance will be
+    returned.
+    """
+    dtype = kwargs.pop("dtype", "complex128")
+    if np.dtype(dtype) == np.complex64:
+        return TensorNetworkC64(*args, **kwargs)
+    elif np.dtype(dtype) == np.complex128:
+        return TensorNetworkC128(*args, **kwargs)
+    else:
+        raise TypeError(f"Data type '{dtype}' is not supported.")
+
+
+def TensorNetworkFile(*args, **kwargs) -> TensorNetworkFileType:
+    """Constructs a tensor network file with the specified data type. If a
+    `dtype` keyword argument is not provided, a TensorNetworkFileC128 instance
+    will be returned.
+    """
+    dtype = kwargs.pop("dtype", "complex128")
+    if np.dtype(dtype) == np.complex64:
+        return TensorNetworkFileC64(*args, **kwargs)
+    elif np.dtype(dtype) == np.complex128:
+        return TensorNetworkFileC128(*args, **kwargs)
+    else:
+        raise TypeError(f"Data type '{dtype}' is not supported.")
+
+
+def TensorNetworkSerializer(*args, **kwargs) -> TensorNetworkSerializerType:
+    """Constructs a tensor network serializer with the specified data type. If a
+    `dtype` keyword argument is not provided, a TensorNetworkSerializerC128
+    instance will be returned.
+    """
+    dtype = kwargs.pop("dtype", "complex128")
+    if np.dtype(dtype) == np.complex64:
+        return TensorNetworkSerializerC64(*args, **kwargs)
+    elif np.dtype(dtype) == np.complex128:
+        return TensorNetworkSerializerC128(*args, **kwargs)
+    else:
+        raise TypeError(f"Data type '{dtype}' is not supported.")