Conditional operator / pattern matching. More...
#include <gamma.hpp>
Classes | |
| struct | EntryVar |
| A variable routed into all gamma regions. More... | |
| struct | ExitVar |
| A variable routed out of all gamma regions as result. More... | |
| struct | MatchVar |
| The match/discriminator variable of this gamma node. More... | |
Public Member Functions inherited from Static Public Member Functions | |
| static GammaNode * | create (jlm::rvsdg::Output *predicate, size_t nalternatives) |
| static GammaNode & | Create (jlm::rvsdg::Output &predicate, size_t numAlternatives, std::vector< std::shared_ptr< const Type > > matchContentTypes) |
| static GammaNode & | Create (jlm::rvsdg::Output &predicate, std::unique_ptr< GammaOperation > op) |
Private Member Functions | |
| GammaNode (rvsdg::Output &predicate, std::unique_ptr< GammaOperation > op) | |
| GammaNode (rvsdg::Output &predicate, size_t nalternatives, std::vector< std::shared_ptr< const Type > > match_content_types) | |
| EntryVar | GetEntryVar (std::size_t index) const |
| Gets entry variable by index. | |
Private Attributes | |
| std::unique_ptr< GammaOperation > | Operation_ |
Detailed Description
Conditional operator / pattern matching.
Gamma nodes discriminate over a given value and conditionally select one of its subregions. In its simplest form, they correspond to an if/else statement:
More generically, they perform pattern-matching over a finitely- constructed type:
where the "contents" of the match is made available in its corresponding branch. Simple types such as booleans do not have any content and thus produce the content-less UnitType as placeholder for the destructured content – so effectively Gamma then corresponds to:
Constructor & Destructor Documentation
◆ ~GammaNode()
|
overridedefaultnoexcept |
◆ GammaNode() [1/2]
|
private |
◆ GammaNode() [2/2]
|
private |
Member Function Documentation
◆ AddEntryVar()
| GammaNode::EntryVar jlm::rvsdg::GammaNode::AddEntryVar | ( | rvsdg::Output * | origin | ) |
Routes a variable into the gamma branches.
- Parameters
-
origin Value to be routed in.
- Returns
- Description of entry variable.
Routes a variable into a gamma region. To access the variable in each branch use EntryVar::branchArgument.
◆ AddExitVar()
| GammaNode::ExitVar jlm::rvsdg::GammaNode::AddExitVar | ( | const std::vector< rvsdg::Output * > & | values | ) |
◆ copy()
|
overridevirtual |
Copy a node with substitutions.
- Parameters
-
region Target region to create node in smap Operand substitutions
- Returns
- Copied node
Create a new node that is semantically equivalent to an existing node. The newly created node will use the same operands as the existing node unless there is a substitution registered for a particular operand.
The given substitution map is updated so that all outputs of the original node will be substituted by corresponding outputs of the newly created node in subsequent copy operations.
Implements jlm::rvsdg::Node.
◆ Create() [1/2]
◆ Create() [2/2]
|
inlinestatic |
◆ create()
|
inlinestatic |
◆ GetEntryVar()
|
private |
◆ GetEntryVars()
| std::vector< GammaNode::EntryVar > jlm::rvsdg::GammaNode::GetEntryVars | ( | ) | const |
◆ GetExitVars()
| std::vector< GammaNode::ExitVar > jlm::rvsdg::GammaNode::GetExitVars | ( | ) | const |
◆ GetMatchVar()
| GammaNode::MatchVar jlm::rvsdg::GammaNode::GetMatchVar | ( | ) | const |
◆ GetOperation()
|
overridevirtualnoexcept |
Implements jlm::rvsdg::Node.
◆ GetOutputsWhere()
Gets all gamma outputs that match the condition defined by match.
- Template Parameters
-
F A type supporting function call operator: bool operator(const Output&)
- Parameters
-
match Defines the condition of the outputs to return.
- Returns
- The gamma outputs that matched the condition.
◆ MapBranchArgument()
| std::variant< GammaNode::MatchVar, GammaNode::EntryVar > jlm::rvsdg::GammaNode::MapBranchArgument | ( | const rvsdg::Output & | output | ) | const |
Maps branch subregion entry argument to its role (pattern match or entry variable).
- Parameters
-
output The branch argument to be mapped.
- Returns
- The entry variable description corresponding to this input
- Precondition
outputmust be the entry argument to a subregion of this gamma node.
Maps the subregion entry argument to the variable description corresponding to it (the predicate + pattern matches, or an entry variable into this branch). This allows to trace the value to users in other branches as well as its def site preceding the gamma node:
◆ mapBranchArgumentToInput() [1/2]
| const rvsdg::Input & jlm::rvsdg::GammaNode::mapBranchArgumentToInput | ( | const rvsdg::Output & | output | ) | const |
Maps branch subregion entry argument to its corresponding gamma input.
- Parameters
-
output The branch argument to be mapped.
- Returns
- The gamma node input corresponding to the given branch argument.
- Precondition
outputmust be the entry argument to a subregion of this gamma node.
This function is a more direct alternative to calling MapBranchArgument(x).input for situations when the sibling branch arguments are not needed.
◆ mapBranchArgumentToInput() [2/2]
Maps branch subregion entry argument to its corresponding gamma input.
- Parameters
-
output The branch argument to be mapped.
- Returns
- The gamma node input corresponding to the given branch argument.
- Precondition
outputmust be the entry argument to a subregion of this gamma node.
This function is a more direct alternative to calling MapBranchArgument(x).input for situations when the sibling branch arguments are not needed.
◆ MapBranchResultExitVar()
| GammaNode::ExitVar jlm::rvsdg::GammaNode::MapBranchResultExitVar | ( | const rvsdg::Input & | input | ) | const |
Maps gamma region exit result to exit variable description.
- Parameters
-
input The result to be mapped to be mapped.
- Returns
- The exit variable description corresponding to this output.
- Precondition
inputmust be a result of a subregion of this node.
Maps the gamma region result to the exit variable description corresponding to it.
◆ mapBranchResultToOutput() [1/2]
Maps branch subregion exit result to its corresponding gamma output.
- Parameters
-
input The branch result to be mapped.
- Returns
- The gamma node output corresponding to the given branch result.
- Precondition
inputmust be the exit result to a subregion of this gamma node.
◆ mapBranchResultToOutput() [2/2]
Maps branch subregion exit result to its corresponding gamma output.
- Parameters
-
input The branch result to be mapped.
- Returns
- The gamma node output corresponding to the given branch result.
- Precondition
inputmust be the exit result to a subregion of this gamma node.
◆ MapInput()
| std::variant< GammaNode::MatchVar, GammaNode::EntryVar > jlm::rvsdg::GammaNode::MapInput | ( | const rvsdg::Input & | input | ) | const |
Maps gamma input to its role (match variable or entry variable).
- Parameters
-
input Input to be mapped.
- Returns
- The variable description corresponding to this input
- Precondition
inputmust be an input of this node
Maps the gamma input to the variable description corresponding to it. This is either the "match" or "predicate" of the gamma, or an entry variable for values used inside the region. This allows to trace the value through to users in the gamma subregions.
◆ MapOutputExitVar()
| GammaNode::ExitVar jlm::rvsdg::GammaNode::MapOutputExitVar | ( | const rvsdg::Output & | output | ) | const |
Maps gamma output to exit variable description.
- Parameters
-
output Output to be mapped.
- Returns
- The exit variable description corresponding to this output.
- Precondition
outputmust be an output of this node.
Maps the gamma output to the exit variable description corresponding to it. This allows to trace the value through to users in the gamma subregions.
◆ predicate()
|
inlinenoexcept |
◆ PruneExitVars()
|
inline |
Remove all exit variables where the variables' output is dead.
- See also
- Output::IsDead()
◆ RemoveEntryVars()
◆ RemoveExitVars()
Removes the exit variables corresponding to the given gammaOutputs.
- Precondition
- All outputs must belong to a gamma node.
- All outputs must be dead.
- Parameters
-
gammaOutputs The outputs indicating the corresponding exit variables.
- See also
- Output::IsDead()
Member Data Documentation
◆ Operation_
|
private |
The documentation for this class was generated from the following files:
