CIRCT 23.0.0git
Loading...
Searching...
No Matches
Public Member Functions | List of all members
esiaccel.types.BitsType Class Reference
Inheritance diagram for esiaccel.types.BitsType:
Inheritance graph
[legend]
Collaboration diagram for esiaccel.types.BitsType:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, str id, int width)
 
Tuple[bool, Optional[str]] is_valid (self, obj)
 
int bit_width (self)
 
bytearray serialize (self, Union[bytearray, bytes, List[int]] obj)
 
Tuple[bytearray, bytearray] deserialize (self, bytearray data)
 
- Public Member Functions inherited from esiaccel.types.ESIType
 wrap_cpp (cls, cpp.Type cpp_type)
 
str id (self)
 
Tuple[bool, Optional[str]] supports_host (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
 
 id
 
- Protected Member Functions inherited from esiaccel.types.ESIType
 _init_from_cpp (self, cpp.Type cpp_type)
 

Detailed Description

Definition at line 217 of file types.py.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ bit_width()

int esiaccel.types.BitsType.bit_width (   self)
Size of this type, in bits. Negative for unbounded types.

Reimplemented from esiaccel.types.ESIType.

Definition at line 233 of file types.py.

References esiaccel.types.ESIType.cpp_type.

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[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 243 of file types.py.

References esiaccel.types.ESIType.max_size(), esiaccel.types.UIntType.max_size, and esiaccel.types.SIntType.max_size.

◆ 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 222 of file types.py.

References esiaccel.types.ESIType.max_size(), esiaccel.types.UIntType.max_size, and esiaccel.types.SIntType.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 236 of file types.py.


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