esi::ArrayType Class Reference

Arrays have a compile time specified (static) size and an element type. More...

#include <Types.h>

Inheritance diagram for esi::ArrayType:

Collaboration diagram for esi::ArrayType:

Public Member Functions
	ArrayType (const ID &id, const Type *elementType, uint64_t size, bool reverse=true)
const Type *	getElementType () const
uint64_t	getSize () const
bool	isReverse () const
std::ptrdiff_t	getBitWidth () const override
void	ensureValid (const std::any &obj) const override
	Ensure that a std::any object is valid for this type.
MutableBitVector	serialize (const std::any &obj) const override
	Serialize an object to a MutableBitVector (LSB-first stream).
std::any	deserialize (BitVector &data) const override
	Deserialize from a BitVector stream (LSB-first).
virtual std::any	deserialize (BitVector &data) const
	Deserialize from a BitVector stream (LSB-first).
std::any	deserialize (const MessageData &data) const
Public Member Functions inherited from esi::Type
	Type (const ID &id)
virtual	~Type ()=default
ID	getID () const
std::any	deserialize (const MessageData &data) const
std::optional< std::string >	isValid (const std::any &obj) const

Private Attributes
const Type *	elementType
uint64_t	size
bool	reverse

Additional Inherited Members
Public Types inherited from esi::Type
using	ID = std::string
Protected Attributes inherited from esi::Type
ID	id

Detailed Description

Arrays have a compile time specified (static) size and an element type.

Definition at line 241 of file Types.h.

Constructor & Destructor Documentation

ArrayType()

esi::ArrayType::ArrayType ( const ID &  id, const Type *  elementType, uint64_t  size, bool  reverse = true  )

inline

Definition at line 243 of file Types.h.

Member Function Documentation

deserialize() [1/3]

virtual std::any esi::Type::deserialize ( BitVector &  data ) const

inlinevirtual

Deserialize from a BitVector stream (LSB-first).

Implementations consume bits from 'data' in-place (via logical right shifts) and return the reconstructed value. Remaining bits stay in 'data'.

Reimplemented from esi::Type.

Definition at line 54 of file Types.h.

deserialize() [2/3]

std::any esi::ArrayType::deserialize ( BitVector &  data ) const

overridevirtual

Deserialize from a BitVector stream (LSB-first).

Implementations consume bits from 'data' in-place (via logical right shifts) and return the reconstructed value. Remaining bits stay in 'data'.

Reimplemented from esi::Type.

Definition at line 308 of file Types.cpp.

References esi::Type::deserialize(), elementType, isReverse(), and size.

deserialize() [3/3]

std::any esi::Type::deserialize ( const MessageData &  data ) const

inline

Definition at line 61 of file Types.h.

ensureValid()

void esi::ArrayType::ensureValid ( const std::any &  obj ) const

overridevirtual

Ensure that a std::any object is valid for this type.

Throws std::runtime_error if the object is not valid.

Reimplemented from esi::Type.

Definition at line 267 of file Types.cpp.

References elementType, esi::Type::ensureValid(), and size.

Referenced by serialize().

getBitWidth()

std::ptrdiff_t esi::ArrayType::getBitWidth ( ) const

inlineoverridevirtual

Reimplemented from esi::Type.

Definition at line 251 of file Types.h.

References elementType, esi::Type::getBitWidth(), and size.

getElementType()

const Type * esi::ArrayType::getElementType ( ) const

inline

Definition at line 248 of file Types.h.

References elementType.

getSize()

uint64_t esi::ArrayType::getSize ( ) const

inline

Definition at line 249 of file Types.h.

References size.

isReverse()

bool esi::ArrayType::isReverse ( ) const

inline

Definition at line 250 of file Types.h.

References reverse.

Referenced by deserialize(), and serialize().

serialize()

MutableBitVector esi::ArrayType::serialize ( const std::any &  obj ) const

overridevirtual

Serialize an object to a MutableBitVector (LSB-first stream).

The object should be passed via std::any. Implementations append fields in the order they are iterated (the first serialized field occupies the least-significant bits of the result).

Reimplemented from esi::Type.

Definition at line 289 of file Types.cpp.

References elementType, ensureValid(), isReverse(), esi::Type::serialize(), and esi::BitVector::width().

Member Data Documentation

elementType

const Type* esi::ArrayType::elementType

private

Definition at line 263 of file Types.h.

Referenced by deserialize(), ensureValid(), getBitWidth(), getElementType(), and serialize().

reverse

bool esi::ArrayType::reverse

private

Definition at line 268 of file Types.h.

Referenced by isReverse().

size

uint64_t esi::ArrayType::size

private

Definition at line 264 of file Types.h.

Referenced by esiaccel.types.ArrayType::bit_width(), deserialize(), esiaccel.types.ArrayType::deserialize(), ensureValid(), getBitWidth(), getSize(), and esiaccel.types.ArrayType::is_valid().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Types.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Types.cpp