jlm::rvsdg::RegionResult Class Reference

Represents the result of a region. More...

#include <region.hpp>

Inheritance diagram for jlm::rvsdg::RegionResult:

Collaboration diagram for jlm::rvsdg::RegionResult:

Public Types
typedef util::IntrusiveListAccessor< RegionResult, &RegionResult::structural_output_anchor_ >	structural_output_accessor

Public Member Functions
	~RegionResult () noexcept override
	RegionResult (rvsdg::Region *region, rvsdg::Output *origin, StructuralOutput *output, std::shared_ptr< const rvsdg::Type > type)
	RegionResult (const RegionResult &)=delete
	RegionResult (RegionResult &&)=delete
RegionResult &	operator= (const RegionResult &)=delete
RegionResult &	operator= (RegionResult &&)=delete
std::string	debug_string () const override
StructuralOutput *	output () const noexcept
virtual RegionResult &	Copy (rvsdg::Output &origin, StructuralOutput *output) const
Public Member Functions inherited from jlm::rvsdg::Input
virtual	~Input () noexcept
	Input (const Input &)=delete
	Input (Input &&)=delete
Input &	operator= (const Input &)=delete
Input &	operator= (Input &&)=delete
size_t	index () const noexcept
Output *	origin () const noexcept
void	divert_to (Output *new_origin)
const std::shared_ptr< const rvsdg::Type > &	Type () const noexcept
Region *	region () const noexcept
std::variant< Node *, Region * >	GetOwner () const noexcept

Static Public Member Functions
static RegionResult &	Create (rvsdg::Region &region, rvsdg::Output &origin, StructuralOutput *output, std::shared_ptr< const rvsdg::Type > type)
	Create region exit result.

Private Attributes
util::IntrusiveListAnchor< RegionResult >	structural_output_anchor_ {}
StructuralOutput *	output_

Additional Inherited Members
Protected Member Functions inherited from jlm::rvsdg::Input
	Input (Node &owner, Output &origin, std::shared_ptr< const rvsdg::Type > type)
	Input (Region &owner, Output &origin, std::shared_ptr< const rvsdg::Type > type)

Detailed Description

Represents the result of a region.

Region results represent the final values of the region's acyclic graph. The result values can be mapped back to the region arguments or the corresponding structural outputs throughout the execution, but the concrete semantics of this mapping depends on the structural node the region is part of. A region result is either linked with a StructuralOutput or is a standalone result.

Definition at line 119 of file region.hpp.

Member Typedef Documentation

structural_output_accessor

typedef util::IntrusiveListAccessor<RegionResult, &RegionResult::structural_output_anchor_> jlm::rvsdg::RegionResult::structural_output_accessor

Definition at line 125 of file region.hpp.

Constructor & Destructor Documentation

~RegionResult()

jlm::rvsdg::RegionResult::~RegionResult ( )

overridenoexcept

Definition at line 71 of file region.cpp.

RegionResult() [1/3]

jlm::rvsdg::RegionResult::RegionResult	(	rvsdg::Region *	region,
		rvsdg::Output *	origin,
		StructuralOutput *	output,
		std::shared_ptr< const rvsdg::Type >	type
	)

Definition at line 77 of file region.cpp.

RegionResult() [2/3]

jlm::rvsdg::RegionResult::RegionResult ( const RegionResult &  )

delete

RegionResult() [3/3]

jlm::rvsdg::RegionResult::RegionResult ( RegionResult &&  )

delete

Member Function Documentation

Copy()

RegionResult & jlm::rvsdg::RegionResult::Copy ( rvsdg::Output &  origin, StructuralOutput *  output  ) const

virtual

Creates a copy of the result with origin and structural_output output. The result is created with the same type as origin and in the same region as origin.

Parameters

origin	The origin for the result.
output	The structural_output to the result, if any.

Returns

A reference to the copied result.

Reimplemented in jlm::rvsdg::GraphExport, jlm::hls::BackEdgeResult, and jlm::hls::ExitResult.

Definition at line 106 of file region.cpp.

Create()

RegionResult & jlm::rvsdg::RegionResult::Create ( rvsdg::Region &  region, rvsdg::Output &  origin, StructuralOutput *  output, std::shared_ptr< const rvsdg::Type >  type  )

static

Create region exit result.

Parameters

region	Region to create result for.
origin	Assigned result value.
output	(optional) output of parent node associated with this result (deprecated, will be removed soon).
type	Result type

Returns

Reference to the created result.

Creates a result and registers it with the given region.

Definition at line 112 of file region.cpp.

debug_string()

std::string jlm::rvsdg::RegionResult::debug_string ( ) const

overridevirtual

Reimplemented from jlm::rvsdg::Input.

Definition at line 100 of file region.cpp.

operator=() [1/2]

RegionResult & jlm::rvsdg::RegionResult::operator= ( const RegionResult &  )

delete

operator=() [2/2]

RegionResult & jlm::rvsdg::RegionResult::operator= ( RegionResult &&  )

delete

output()

StructuralOutput * jlm::rvsdg::RegionResult::output ( ) const

inlinenoexcept

Definition at line 149 of file region.hpp.

Member Data Documentation

output_

StructuralOutput* jlm::rvsdg::RegionResult::output_

private

Definition at line 195 of file region.hpp.

structural_output_anchor_

util::IntrusiveListAnchor<RegionResult> jlm::rvsdg::RegionResult::structural_output_anchor_ {}

private

Definition at line 121 of file region.hpp.

---

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

• jlm/rvsdg/region.hpp
• jlm/rvsdg/region.cpp