M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc: Add TTuple to compiler section (#2591)

This commit is contained in:
thatschatt 2024-10-14 12:47:02 +02:00 committed by GitHub
parent e06534913c
commit a570e6fd87
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 41 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
doc/manual/compiler.rst
View File

@ -48,35 +48,37 @@ ARTIQ types
Python/NumPy types correspond to ARTIQ types as follows:
+---------------+-------------------------+
| Python | ARTIQ |
+===============+=========================+
| NoneType | TNone |
+---------------+-------------------------+
| bool | TBool |
+---------------+-------------------------+
| int | TInt32 or TInt64 |
+---------------+-------------------------+
| float | TFloat |
+---------------+-------------------------+
| str | TStr |
+---------------+-------------------------+
| bytes | TBytes |
+---------------+-------------------------+
| bytearray | TByteArray |
+---------------+-------------------------+
| list of T | TList(T) |
+---------------+-------------------------+
| NumPy array | TArray(T, num_dims) |
+---------------+-------------------------+
| range | TRange32, TRange64 |
+---------------+-------------------------+
| numpy.int32 | TInt32 |
+---------------+-------------------------+
| numpy.int64 | TInt64 |
+---------------+-------------------------+
| numpy.float64 | TFloat |
+---------------+-------------------------+
+------------------------+-------------------------+
| Python | ARTIQ |
+========================+=========================+
| NoneType | TNone |
+------------------------+-------------------------+
| bool | TBool |
+------------------------+-------------------------+
| int | TInt32 or TInt64 |
+------------------------+-------------------------+
| float | TFloat |
+------------------------+-------------------------+
| str | TStr |
+------------------------+-------------------------+
| bytes | TBytes |
+------------------------+-------------------------+
| bytearray | TByteArray |
+------------------------+-------------------------+
| list of T | TList(T) |
+------------------------+-------------------------+
| NumPy array | TArray(T, num_dims) |
+------------------------+-------------------------+
| tuple of (T1, T2, ...) | TTuple([T1, T2, ...]) |
+------------------------+-------------------------+
| range | TRange32, TRange64 |
+------------------------+-------------------------+
| numpy.int32 | TInt32 |
+------------------------+-------------------------+
| numpy.int64 | TInt64 |
+------------------------+-------------------------+
| numpy.float64 | TFloat |
+------------------------+-------------------------+
Integers are 32-bit by default but may be converted to 64-bit with ``numpy.int64``.
@ -87,6 +89,8 @@ The ARTIQ compiler can be thought of as overriding all built-in Python types, an
Multidimensional arrays are allowed (using NumPy syntax). Element-wise operations (e.g. ``+``, ``/``), matrix multiplication (``@``) and multidimensional indexing are supported; slices and views (currently) are not.
Tuples may contain a mixture of different types. They cannot be iterated over or dynamically indexed, although they may be indexed by constants and multiple assignment is supported.
User-defined classes are supported, provided their attributes are of other supported types (attributes that are not used in the kernel are ignored and thus unrestricted). When several instances of a user-defined class are referenced from the same kernel, every attribute must have the same type in every instance of the class.
.. _basic-artiq-python:
@ -101,6 +105,14 @@ Kernel code can call host functions without any additional ceremony. However, su
def return_four() -> TInt32:
return 4
.. tip::
Multiple variables of different types can be sent in one RPC call by returning a tuple, e.g. ::
def return_many() -> TTuple([TInt32, TFloat, TStr]):
return (4, 12.34, "hello",)
Which can be retrieved from a kernel with ``(a, b, c) = return_many()``
Kernels can freely modify attributes of objects shared with the host. However, by necessity, these modifications are actually applied to local copies of the objects, as the latency of immediate writeback would be unsupportable in a real-time environment. Instead, modifications are written back *when the kernel completes;* notably, this means RPCs called by a kernel itself will only have access to the unmodified host version of the object, as the kernel hasn't finished execution yet. In some cases, accessing data on the host is better handled by calling RPCs specifically to make the desired modifications.
.. warning::