esiaccel.types.BitsType Class Reference

Inheritance diagram for esiaccel.types.BitsType:

Collaboration diagram for esiaccel.types.BitsType:

Public Member Functions
	__init__ (self, str id, int width)
Tuple[bool, Optional[str]]	is_valid (self, obj)
bytearray	serialize (self, Union[bytearray, bytes, List[int]] obj)
Tuple[bytearray, bytearray]	deserialize (self, bytearray data)
Public Member Functions inherited from esiaccel.types.ESIType
	__init__ (self, str id)
	wrap_cpp (cls, cpp.Type cpp_type)
str	id (self)
Tuple[bool, Optional[str]]	supports_host (self)
int	bit_width (self)
int	max_size (self)
int	__hash__ (self)
bool	__eq__ (self, other)
str	__str__ (self)

Additional Inherited Members
Public Attributes inherited from esiaccel.types.ESIType
	cpp_type = cpp_type
str	id
Protected Member Functions inherited from esiaccel.types.ESIType
	_init_from_cpp (self, cpp.Type cpp_type)

Detailed Description

Definition at line 206 of file types.py.

Constructor & Destructor Documentation

__init__()

esiaccel.types.BitsType.__init__	(		self,
		str	id,
		int	width )

Definition at line 208 of file types.py.

References esiaccel.types.ESIType._init_from_cpp().

Member Function Documentation

deserialize()

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

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

Reimplemented from esiaccel.types.ESIType.

Definition at line 228 of file types.py.

is_valid()

Tuple[bool, Optional[str]] esiaccel.types.BitsType.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 from esiaccel.types.ESIType.

Definition at line 211 of file types.py.

References max_size.

serialize()

bytearray esiaccel.types.BitsType.serialize	(		self,
		Union[bytearray, bytes, List[int]]	obj )

Convert a Python object to a bytearray.

Reimplemented from esiaccel.types.ESIType.

Definition at line 221 of file types.py.

---

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