Inheritance diagram for esiaccel.types.ESIType:

[legend]

Public Member Functions
	__init__ (self, cpp.Type cpp_type)

Tuple[bool, Optional[str]]	supports_host (self)

Tuple[bool, Optional[str]]	is_valid (self, obj)

int	bit_width (self)

int	max_size (self)

bytearray	serialize (self, obj)

Tuple[object, bytearray]	deserialize (self, bytearray data)

str	__str__ (self)

Public Attributes
	cpp_type

Detailed Description

Definition at line 42 of file types.py.

Constructor & Destructor Documentation

◆ init()

esiaccel.types.ESIType.__init__	(		self,
		cpp.Type	cpp_type
	)

Reimplemented in esiaccel.types.ArrayType, esiaccel.types.BitsType, esiaccel.types.IntType, and esiaccel.types.StructType.

Definition at line 44 of file types.py.

Member Function Documentation

◆ str()

str esiaccel.types.ESIType.__str__ ( self )

Reimplemented in esiaccel.types.UIntType, and esiaccel.types.SIntType.

Definition at line 83 of file types.py.

References esiaccel.types.ESIType.cpp_type, esiaccel.types.StructType.cpp_type, and esiaccel.types.ArrayType.cpp_type.

◆ bit_width()

int esiaccel.types.ESIType.bit_width ( self )

Size of this type, in bits. Negative for unbounded types.

Reimplemented in esiaccel.types.VoidType, esiaccel.types.BitsType, esiaccel.types.IntType, esiaccel.types.StructType, and esiaccel.types.ArrayType.

Definition at line 62 of file types.py.

Referenced by esiaccel.types.UIntType.is_valid(), esiaccel.types.SIntType.is_valid(), esiaccel.types.ESIType.max_size(), and esiaccel.types.ESIType.supports_host().

◆ deserialize()

Tuple[object, bytearray] esiaccel.types.ESIType.deserialize	(		self,
		bytearray	data
	)

Convert a bytearray to a Python object. Return the object and the
leftover bytes.

Reimplemented in esiaccel.types.VoidType, esiaccel.types.BitsType, esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.StructType, and esiaccel.types.ArrayType.

Definition at line 78 of file types.py.

◆ is_valid()

Tuple[bool, Optional[str]] esiaccel.types.ESIType.is_valid	(	self,
		obj
	)

Is a Python object compatible with HW type?  Returns either '(True,
None)' if it is, or '(False, reason)' if it is not.

Reimplemented in esiaccel.types.VoidType, esiaccel.types.BitsType, esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.StructType, and esiaccel.types.ArrayType.

Definition at line 56 of file types.py.

◆ max_size()

int esiaccel.types.ESIType.max_size ( self )

Maximum size of a value of this type, in bytes.

Definition at line 67 of file types.py.

References esiaccel.types.ESIType.bit_width(), esiaccel.types.VoidType.bit_width(), esiaccel.types.BitsType.bit_width(), esiaccel.types.IntType.bit_width(), esiaccel.types.StructType.bit_width(), and esiaccel.types.ArrayType.bit_width().

Referenced by esiaccel.types.BitsType.deserialize(), esiaccel.types.UIntType.deserialize(), esiaccel.types.SIntType.deserialize(), and esiaccel.types.BitsType.is_valid().

◆ serialize()

bytearray esiaccel.types.ESIType.serialize	(	self,
		obj
	)

Convert a Python object to a bytearray.

Reimplemented in esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.ArrayType, esiaccel.types.VoidType, esiaccel.types.StructType, and esiaccel.types.BitsType.

Definition at line 74 of file types.py.

◆ supports_host()

Tuple[bool, Optional[str]] esiaccel.types.ESIType.supports_host ( self )

Does this type support host communication via Python? Returns either
'(True, None)' if it is, or '(False, reason)' if it is not.

Definition at line 48 of file types.py.

References esiaccel.types.ESIType.bit_width(), esiaccel.types.VoidType.bit_width(), esiaccel.types.BitsType.bit_width(), esiaccel.types.IntType.bit_width(), esiaccel.types.StructType.bit_width(), and esiaccel.types.ArrayType.bit_width().

Member Data Documentation

◆ cpp_type

esiaccel.types.ESIType.cpp_type

Definition at line 45 of file types.py.

Referenced by esiaccel.types.BitsType.__init__(), esiaccel.types.IntType.__init__(), esiaccel.types.ESIType.__str__(), esiaccel.types.BitsType.bit_width(), and esiaccel.types.IntType.bit_width().

The documentation for this class was generated from the following file:

/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/python/esiaccel/types.py

Public Member Functions

Public Attributes