InductionVariable

java.lang.Object
- org.graalvm.compiler.nodes.loop.InductionVariable

Direct Known Subclasses:

BasicInductionVariable, DerivedInductionVariable
```
public abstract class InductionVariable
extends Object
```
This class describes a value node that is an induction variable in a counted loop.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InductionVariable.Direction

Nested Classes
Modifier and Type	Class and Description
`static class`	`InductionVariable.Direction`

Field Summary

Fields
Modifier and Type Field and Description

protected LoopEx loop

Fields
Modifier and Type	Field and Description
`protected LoopEx`	`loop`

Constructor Summary

Constructors
Constructor and Description

InductionVariable(LoopEx loop)

Constructors
Constructor and Description
`InductionVariable(LoopEx loop)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract long`	`constantExtremum()`
`abstract long`	`constantInit()`
`long`	`constantScale(InductionVariable ref)` this = C * ref + n, returns C.
`abstract long`	`constantStride()`
`abstract void`	`deleteUnusedNodes()` Deletes any nodes created within the scope of this object that have no usages.
`abstract InductionVariable.Direction`	`direction()`
`abstract InductionVariable`	`duplicate()` Duplicate this iv including all (non-constant) nodes.
`abstract ValueNode`	`exitValueNode()` Returns the exit value of the induction variable.
`ValueNode`	`extremumNode()` Returns the extremum value of the induction variable.
`abstract ValueNode`	`extremumNode(boolean assumeLoopEntered, Stamp stamp)`
`LoopEx`	`getLoop()`
`abstract StructuredGraph`	`graph()`
`abstract ValueNode`	`initNode()` Returns the node that gives the initial value of this induction variable.
`abstract boolean`	`isConstantExtremum()`
`abstract boolean`	`isConstantInit()`
`boolean`	`isConstantScale(InductionVariable ref)` Is this = C * ref + n, C a constant?
`abstract boolean`	`isConstantStride()`
`boolean`	`offsetIsZero(InductionVariable ref)` Is this = n * ref + 0?
`ValueNode`	`offsetNode(InductionVariable ref)` If this = n * ref + offset, returns offset or null otherwise.
`abstract ValueNode`	`strideNode()` Returns the stride of the induction variable.
`abstract ValueNode`	`valueNode()` Returns the value node that is described by this induction variable.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - loop
```
protected final LoopEx loop
```
- Constructor Detail
  - InductionVariable
```
public InductionVariable(LoopEx loop)
```
- Method Detail
  - graph
```
public abstract StructuredGraph graph()
```
  - getLoop
```
public LoopEx getLoop()
```
  - direction
```
public abstract InductionVariable.Direction direction()
```
  - valueNode
```
public abstract ValueNode valueNode()
```
    Returns the value node that is described by this induction variable.
  - initNode
```
public abstract ValueNode initNode()
```
    Returns the node that gives the initial value of this induction variable.
  - strideNode
```
public abstract ValueNode strideNode()
```
    Returns the stride of the induction variable. The stride is the value that is added to the induction variable at each iteration.
  - isConstantInit
```
public abstract boolean isConstantInit()
```
  - isConstantStride
```
public abstract boolean isConstantStride()
```
  - constantInit
```
public abstract long constantInit()
```
  - constantStride
```
public abstract long constantStride()
```
  - extremumNode
```
public ValueNode extremumNode()
```
    Returns the extremum value of the induction variable. The extremum value is the value of the induction variable in the loop body of the last iteration, only taking into account the main loop limit test. It's possible for the loop to exit before this value if CountedLoopInfo.isExactTripCount() returns false for the containing loop.
  - extremumNode
```
public abstract ValueNode extremumNode(boolean assumeLoopEntered,
                                       Stamp stamp)
```
  - isConstantExtremum
```
public abstract boolean isConstantExtremum()
```
  - constantExtremum
```
public abstract long constantExtremum()
```
  - exitValueNode
```
public abstract ValueNode exitValueNode()
```
    Returns the exit value of the induction variable. The exit value is the value of the induction variable at the loop exit.
  - deleteUnusedNodes
```
public abstract void deleteUnusedNodes()
```
    Deletes any nodes created within the scope of this object that have no usages.
  - isConstantScale
```
public boolean isConstantScale(InductionVariable ref)
```
    Is this = C * ref + n, C a constant?
  - constantScale
```
public long constantScale(InductionVariable ref)
```
    this = C * ref + n, returns C.
  - offsetIsZero
```
public boolean offsetIsZero(InductionVariable ref)
```
    Is this = n * ref + 0?
  - offsetNode
```
public ValueNode offsetNode(InductionVariable ref)
```
    If this = n * ref + offset, returns offset or null otherwise.
  - duplicate
```
public abstract InductionVariable duplicate()
```
    Duplicate this iv including all (non-constant) nodes.

Class InductionVariable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

loop

Constructor Detail

InductionVariable

Method Detail

graph

getLoop

direction

valueNode

initNode

strideNode

isConstantInit

isConstantStride

constantInit

constantStride

extremumNode

extremumNode

isConstantExtremum

constantExtremum

exitValueNode

deleteUnusedNodes

isConstantScale

constantScale

offsetIsZero

offsetNode

duplicate