circt::igraph::InstancePath Class Reference

An instance path composed of a series of instances. More...

#include <InstanceGraph.h>

Collaboration diagram for circt::igraph::InstancePath:

Public Member Functions
	InstancePath ()=default
InstanceOpInterface	top () const
InstanceOpInterface	leaf () const
InstancePath	dropFront () const
InstancePath	dropBack () const
InstanceOpInterface	operator[] (size_t idx) const
ArrayRef< InstanceOpInterface >::iterator	begin () const
ArrayRef< InstanceOpInterface >::iterator	end () const
ArrayRef< InstanceOpInterface >	getPath () const
size_t	size () const
bool	empty () const
bool	operator== (const InstancePath &that) const
void	print (llvm::raw_ostream &into) const
	Print the path to any stream-like object.

Private Member Functions
	InstancePath (ArrayRef< InstanceOpInterface > path)

Private Attributes
ArrayRef< InstanceOpInterface >	path

Friends
struct	InstancePathCache
struct	llvm::DenseMapInfo< InstancePath >

Detailed Description

An instance path composed of a series of instances.

Definition at line 334 of file InstanceGraph.h.

Constructor & Destructor Documentation

InstancePath() [1/2]

circt::igraph::InstancePath::InstancePath ( )

default

Referenced by dropBack(), dropFront(), llvm::DenseMapInfo< InstancePath >, and operator==().

InstancePath() [2/2]

circt::igraph::InstancePath::InstancePath ( ArrayRef< InstanceOpInterface > path )

inlineprivate

Definition at line 368 of file InstanceGraph.h.

References path.

Member Function Documentation

begin()

ArrayRef< InstanceOpInterface >::iterator circt::igraph::InstancePath::begin ( ) const

inline

Definition at line 353 of file InstanceGraph.h.

References path.

dropBack()

InstancePath circt::igraph::InstancePath::dropBack ( ) const

inline

Definition at line 350 of file InstanceGraph.h.

References InstancePath(), and path.

dropFront()

InstancePath circt::igraph::InstancePath::dropFront ( ) const

inline

Definition at line 348 of file InstanceGraph.h.

References InstancePath(), and path.

empty()

bool circt::igraph::InstancePath::empty ( ) const

inline

Definition at line 357 of file InstanceGraph.h.

References path.

Referenced by leaf(), and top().

end()

ArrayRef< InstanceOpInterface >::iterator circt::igraph::InstancePath::end ( ) const

inline

Definition at line 354 of file InstanceGraph.h.

References path.

getPath()

ArrayRef< InstanceOpInterface > circt::igraph::InstancePath::getPath ( ) const

inline

Definition at line 355 of file InstanceGraph.h.

References path.

Referenced by llvm::DenseMapInfo< circt::igraph::InstancePath >::isEqual().

leaf()

InstanceOpInterface circt::igraph::InstancePath::leaf ( ) const

inline

Definition at line 343 of file InstanceGraph.h.

References assert(), empty(), and path.

operator==()

bool circt::igraph::InstancePath::operator== ( const InstancePath & that ) const

inline

Definition at line 359 of file InstanceGraph.h.

References InstancePath(), and path.

operator[]()

InstanceOpInterface circt::igraph::InstancePath::operator[] ( size_t idx ) const

inline

Definition at line 352 of file InstanceGraph.h.

References path.

print()

void InstancePath::print

(

llvm::raw_ostream &

into

)

const

Print the path to any stream-like object.

Definition at line 301 of file InstanceGraph.cpp.

References path.

size()

size_t circt::igraph::InstancePath::size ( ) const

inline

Definition at line 356 of file InstanceGraph.h.

References path.

Referenced by circt::igraph::InstancePathCache::appendInstance(), circt::igraph::InstancePathCache::concatPath(), and circt::igraph::InstancePathCache::prependInstance().

top()

InstanceOpInterface circt::igraph::InstancePath::top ( ) const

inline

Definition at line 338 of file InstanceGraph.h.

References assert(), empty(), and path.

Friends And Related Symbol Documentation

InstancePathCache

friend struct InstancePathCache

friend

Definition at line 366 of file InstanceGraph.h.

Referenced by llvm::DenseMapInfo< InstancePath >.

llvm::DenseMapInfo< InstancePath >

friend struct llvm::DenseMapInfo< InstancePath >

friend

Definition at line 366 of file InstanceGraph.h.

References InstancePath(), and InstancePathCache.

Member Data Documentation

path

ArrayRef<InstanceOpInterface> circt::igraph::InstancePath::path

private

Definition at line 370 of file InstanceGraph.h.

Referenced by begin(), dropBack(), dropFront(), empty(), end(), getPath(), InstancePath(), leaf(), operator==(), operator[](), print(), size(), and top().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Support/InstanceGraph.h
• /home/runner/work/circt-www/circt-www/circt_src/lib/Support/InstanceGraph.cpp