SwitchFoldable

All Superinterfaces:

ValueNodeInterface

All Known Implementing Classes:

FixedGuardNode, IfNode, IntegerSwitchNode
```
public interface SwitchFoldable
extends ValueNodeInterface
```
Nodes that implement this interface can be collapsed to a single IntegerSwitch when they are seen in a cascade.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SwitchFoldable.Helper`
`static class`	`SwitchFoldable.KeyData`
`static class`	`SwitchFoldable.QuickQueryKeyData`
`static class`	`SwitchFoldable.QuickQueryList<T>` Supports O(1) addition to the list, fast `contains` and `indexOf` queries (usually O(1), worst case O(n)), and O(1) random access.

Field Summary

Fields
Modifier and Type Field and Description

static Comparator<SwitchFoldable.KeyData> SORTER

Fields
Modifier and Type	Field and Description
`static Comparator<SwitchFoldable.KeyData>`	`SORTER`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`cutOffCascadeNode()` Removes the successors of this node, while keeping it linked to the rest of the cascade.
`void`	`cutOffLowestCascadeNode()` Completely removes all successors from this node.
`double`	`defaultProbability()` Returns the probability of going to the default branch.
`AbstractBeginNode`	`getDefault()` Returns the branch that will close this switch folding, assuming this is called on the lowest node of the cascade.
`Node`	`getNextSwitchFoldableBranch()` Returns the direct successor in the branch to check for SwitchFoldability.
`int`	`intKeyAt(int i)` Returns the value of the i-th key of this node.
`default boolean`	`isDefaultSuccessor(AbstractBeginNode successor)` Should be overridden if getDefault() has side effects.
`boolean`	`isInSwitch(ValueNode switchValue)` Determines whether the node should be folded in the current folding attempt.
`default boolean`	`isNonInitializedProfile()` Heuristics that tries to determine whether or not a foldable node was profiled.
`default int`	`keyCount()`
`double`	`keyProbability(int i)` Returns the probability of seeing the i-th key of this node.
`AbstractBeginNode`	`keySuccessor(int i)` Returns the branch to follow when seeing the i-th key of this node.
`static boolean`	`maybeIsInSwitch(LogicNode condition)`
`ProfileData.ProfileSource`	`profileSource()` Returns the source of the information about branch probabilities of this node.
`static boolean`	`sameSwitchValue(LogicNode condition, ValueNode switchValue)`
`default boolean`	`switchTransformationOptimization(SimplifierTool tool)` Collapses a cascade of foldables (IfNode, FixedGuard and IntegerSwitch) into a single switch.
`ValueNode`	`switchValue()` Returns the value that will be used as the switch input.

Methods inherited from interface org.graalvm.compiler.nodes.ValueNodeInterface
asNode

- Field Detail
  - SORTER
```
static final Comparator<SwitchFoldable.KeyData> SORTER
```
- Method Detail
  - getNextSwitchFoldableBranch
```
Node getNextSwitchFoldableBranch()
```
    Returns the direct successor in the branch to check for SwitchFoldability.
  - switchValue
```
ValueNode switchValue()
```
    Returns the value that will be used as the switch input. This value should be an int.
  - getDefault
```
AbstractBeginNode getDefault()
```
    Returns the branch that will close this switch folding, assuming this is called on the lowest node of the cascade.
  - isInSwitch
```
boolean isInSwitch(ValueNode switchValue)
```
    Determines whether the node should be folded in the current folding attempt.
    
    Parameters:
    
    switchValue - the value of the switch that will spawn through this folding attempt.
    
    Returns:
    
    true if this node should be folded in the current folding attempt, false otherwise.
    
    See Also:
    
    SwitchFoldable.maybeIsInSwitch(LogicNode), SwitchFoldable.sameSwitchValue(LogicNode, ValueNode)
  - cutOffCascadeNode
```
void cutOffCascadeNode()
```
    Removes the successors of this node, while keeping it linked to the rest of the cascade.
  - cutOffLowestCascadeNode
```
void cutOffLowestCascadeNode()
```
    Completely removes all successors from this node.
  - intKeyAt
```
int intKeyAt(int i)
```
    Returns the value of the i-th key of this node.
  - keyProbability
```
double keyProbability(int i)
```
    Returns the probability of seeing the i-th key of this node.
  - keySuccessor
```
AbstractBeginNode keySuccessor(int i)
```
    Returns the branch to follow when seeing the i-th key of this node.
  - defaultProbability
```
double defaultProbability()
```
    Returns the probability of going to the default branch.
  - profileSource
```
ProfileData.ProfileSource profileSource()
```
    Returns the source of the information about branch probabilities of this node.
  - keyCount
```
default int keyCount()
```
    Returns:
    
    The number of keys the SwitchFoldable node will try to add.
  - isDefaultSuccessor
```
default boolean isDefaultSuccessor(AbstractBeginNode successor)
```
    Should be overridden if getDefault() has side effects.
  - isNonInitializedProfile
```
default boolean isNonInitializedProfile()
```
    Heuristics that tries to determine whether or not a foldable node was profiled.
  - maybeIsInSwitch
```
static boolean maybeIsInSwitch(LogicNode condition)
```
  - sameSwitchValue
```
static boolean sameSwitchValue(LogicNode condition,
                               ValueNode switchValue)
```
  - switchTransformationOptimization
```
default boolean switchTransformationOptimization(SimplifierTool tool)
```
    Collapses a cascade of foldables (IfNode, FixedGuard and IntegerSwitch) into a single switch.

Interface SwitchFoldable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.graalvm.compiler.nodes.ValueNodeInterface

Field Detail

SORTER

Method Detail

getNextSwitchFoldableBranch

switchValue

getDefault

isInSwitch

cutOffCascadeNode

cutOffLowestCascadeNode

intKeyAt

keyProbability

keySuccessor

defaultProbability

profileSource

keyCount

isDefaultSuccessor

isNonInitializedProfile

maybeIsInSwitch

sameSwitchValue

switchTransformationOptimization