CIRCT  19.0.0git
Public Member Functions | List of all members
circt::firrtl::WidthQualifiedTypeTrait< ConcreteType > Class Template Reference

Trait for types which have a width. More...

#include <FIRRTLTypes.h>

Inheritance diagram for circt::firrtl::WidthQualifiedTypeTrait< ConcreteType >:
Inheritance graph
[legend]
Collaboration diagram for circt::firrtl::WidthQualifiedTypeTrait< ConcreteType >:
Collaboration graph
[legend]

Public Member Functions

std::optional< int32_t > getWidth () const
 Return an optional containing the width, if the width is known (or empty if width is unknown). More...
 
bool hasWidth () const
 Return true if this integer type has a known width. More...
 

Detailed Description

template<typename ConcreteType>
class circt::firrtl::WidthQualifiedTypeTrait< ConcreteType >

Trait for types which have a width.

Users must implement:

{c++}
/// Return the width if known, or -1 if unknown.
int32_t getWidthOrSentinel();

Definition at line 268 of file FIRRTLTypes.h.

Member Function Documentation

◆ getWidth()

template<typename ConcreteType >
std::optional<int32_t> circt::firrtl::WidthQualifiedTypeTrait< ConcreteType >::getWidth ( ) const
inline

Return an optional containing the width, if the width is known (or empty if width is unknown).

Definition at line 273 of file FIRRTLTypes.h.

References width.

Referenced by circt::firrtl::getBitWidth(), and knownWidths().

◆ hasWidth()

template<typename ConcreteType >
bool circt::firrtl::WidthQualifiedTypeTrait< ConcreteType >::hasWidth ( ) const
inline

Return true if this integer type has a known width.

Definition at line 281 of file FIRRTLTypes.h.


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